Skip to content

Counters

Returns list of visitor counters in the system. Returned data can be limited with counter_id query parameters.

Operations

Download counters as JSON

Request

GET https://api.zoined.com/v2/download/counters.json?limit=1000&offset=0&counter_id=5

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
counter_idstring

Returns data of counter based on the given id

Example:counter_id=5
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/counters.json?limit=1000&offset=0&counter_id=5' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
counter_idstringrequired

Counter ID

Example:"5"
counter_namestringrequired

Counter name

Example:"Front door 1"
folder_id: front_door_1string

Name of identification folder

Example:""
serialstring

Camera serial number

Example:"ABCDE12345"
registration_codestring

Camera registration code

Example:"A1B2C3D4E5"
disabledbooleanrequired

True if the counter is disabled (i.e. is set to not send data)

Example:false
is_queueboolean

True if the counter is a queue counter

Example:false
on_store_perimeterboolean

True, if this a store perimeter camera

Example:true
organisation_id: my_organisation_idstring

Id of the store/organisation where the camera is located

department_id: my_department_idstring

Id of the department where the camera is located

department_reversed_idstring

Secondary department id where in and out counts are reversed.

Example:"reverse_id"
Response
{
  "counter_id": "5",
  "counter_name": "Front door 1",
  "folder_id: front_door_1": "",
  "serial": "ABCDE12345",
  "registration_code": "A1B2C3D4E5",
  "disabled": false,
  "is_queue": false,
  "on_store_perimeter": true,
  "department_reversed_id": "reverse_id"
}