Skip to main content

Visitors API 1.5.0

Visitors, search, planned visits and visitor custom properties.

Base path: https://{controller_ip}/api/v1. API description version: 1.5.0.

Examples use placeholder values for passwords, tokens, UUIDs, addresses and secrets. Replace them with values from your controller before sending requests.

Section methods​

MethodPath
GET/visitors
GET/visitors/count
GET/visitors/count_planned
GET/visitors/multisearch
GET/visitors/sort
GET/visitors/{uuid}/
GET/visitors_properties
GET/visitors_properties/{name}/
POST/visitors
POST/visitors_properties
PUT/visitors/{uuid}/
PUT/visitors_properties/{name}/
DELETE/visitors/{uuid}/
DELETE/visitors_properties/{name}/

GET /visitors​

Section: Visitors.

Returns data for the visitors endpoint /visitors.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/visitors" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/visitors" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/visitors"
  }
}

GET /visitors/count​

Section: Visitors.

Returns a count for the visitors endpoint /visitors/count.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/visitors/count" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/visitors/count" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "count": 12
}

GET /visitors/count_planned​

Section: Visitors.

Returns a count for the visitors endpoint /visitors/count_planned.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/visitors/count_planned" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/visitors/count_planned" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "count": 12
}

GET /visitors/multisearch​

Section: Visitors.

Returns data for the visitors endpoint /visitors/multisearch.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/visitors/multisearch" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/visitors/multisearch" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/visitors/multisearch"
  }
}

GET /visitors/sort​

Section: Visitors.

Returns sorting metadata for the visitors endpoint /visitors/sort.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/visitors/sort" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/visitors/sort" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/visitors/sort"
  }
}

GET /visitors/{uuid}/​

Section: Visitors.

Returns data for the visitors endpoint /visitors/{uuid}/.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/visitors/{uuid}/" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/visitors/{uuid}/" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/visitors/{uuid}/"
  }
}

GET /visitors_properties​

Section: Visitors.

Returns data for the visitors endpoint /visitors_properties.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/visitors_properties" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/visitors_properties" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/visitors_properties"
  }
}

GET /visitors_properties/{name}/​

Section: Visitors.

Returns data for the visitors endpoint /visitors_properties/{name}/.

Request example​

curl -k -X GET "https://{controller_ip}/api/v1/visitors_properties/{name}/" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X GET "https://{controller_ip}/api/v1/visitors_properties/{name}/" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/visitors_properties/{name}/"
  }
}

POST /visitors​

Section: Visitors.

Creates a record or starts an operation for the visitors endpoint /visitors.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/visitors" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Johnson",
  "first_name": "Peter",
  "planned_at": "2026-06-16T09:00:00+03:00"
}'

Request body example​

{
  "last_name": "Johnson",
  "first_name": "Peter",
  "planned_at": "2026-06-16T09:00:00+03:00"
}

Response command example​

curl -k -sS -X POST "https://{controller_ip}/api/v1/visitors" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

POST /visitors_properties​

Section: Visitors.

Creates a record or starts an operation for the visitors endpoint /visitors_properties.

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/visitors_properties" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "department",
  "type": "string",
  "required": false
}'

Request body example​

{
  "name": "department",
  "type": "string",
  "required": false
}

Response command example​

curl -k -sS -X POST "https://{controller_ip}/api/v1/visitors_properties" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /visitors/{uuid}/​

Section: Visitors.

Updates data for the visitors endpoint /visitors/{uuid}/.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/visitors/{uuid}/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Johnson",
  "first_name": "Peter",
  "planned_at": "2026-06-16T09:00:00+03:00"
}'

Request body example​

{
  "last_name": "Johnson",
  "first_name": "Peter",
  "planned_at": "2026-06-16T09:00:00+03:00"
}

Response command example​

curl -k -sS -X PUT "https://{controller_ip}/api/v1/visitors/{uuid}/" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /visitors_properties/{name}/​

Section: Visitors.

Updates data for the visitors endpoint /visitors_properties/{name}/.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/visitors_properties/{name}/" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "department",
  "type": "string",
  "required": false
}'

Request body example​

{
  "name": "department",
  "type": "string",
  "required": false
}

Response command example​

curl -k -sS -X PUT "https://{controller_ip}/api/v1/visitors_properties/{name}/" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

DELETE /visitors/{uuid}/​

Section: Visitors.

Deletes data for the visitors endpoint /visitors/{uuid}/.

Request example​

curl -k -X DELETE "https://{controller_ip}/api/v1/visitors/{uuid}/" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X DELETE "https://{controller_ip}/api/v1/visitors/{uuid}/" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "deleted": true
}

DELETE /visitors_properties/{name}/​

Section: Visitors.

Deletes data for the visitors endpoint /visitors_properties/{name}/.

Request example​

curl -k -X DELETE "https://{controller_ip}/api/v1/visitors_properties/{name}/" \
  -H "Authorization: Bearer <token>"

Response command example​

curl -k -sS -X DELETE "https://{controller_ip}/api/v1/visitors_properties/{name}/" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

{
  "status": "success",
  "deleted": true
}