Skip to main content

Staff API 1.5.0

Staff records, search, identifiers and staff 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/staff
GET/staff/banned
GET/staff/count
GET/staff/search
GET/staff/{uuid}
GET/staff/{uuid}/last_access
GET/staff_properties
GET/staff_properties/{name}
POST/staff
POST/staff_properties
PUT/staff/ban/{uuid}
PUT/staff/unban/{uuid}
PUT/staff/{uuid}
PUT/staff_properties/{name}
DELETE/staff/{uuid}
DELETE/staff_properties/{name}

GET /staff​

Section: Staff.

Returns data for the staff endpoint /staff.

Request example​

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

Response command example​

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

Response example​

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

GET /staff/banned​

Section: Staff.

Returns data for the staff endpoint /staff/banned.

Request example​

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

Response command example​

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

Response example​

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

GET /staff/count​

Section: Staff.

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

Request example​

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

Response command example​

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

Response example​

{
  "count": 12
}

Section: Staff.

Returns data for the staff endpoint /staff/search.

Request example​

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

Response command example​

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

Response example​

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

GET /staff/{uuid}​

Section: Staff.

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

Request example​

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

Response command example​

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

Response example​

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

GET /staff/{uuid}/last_access​

Section: Staff.

Returns data for the staff endpoint /staff/{uuid}/last_access.

Request example​

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

Response command example​

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

Response example​

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

GET /staff_properties​

Section: Staff.

Returns data for the staff endpoint /staff_properties.

Request example​

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

Response command example​

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

Response example​

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

GET /staff_properties/{name}​

Section: Staff.

Returns data for the staff endpoint /staff_properties/{name}.

Request example​

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

Response command example​

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

Response example​

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

POST /staff​

Section: Staff.

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

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/staff" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Smith",
  "first_name": "John",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}'

Request body example​

{
  "last_name": "Smith",
  "first_name": "John",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}

Response command example​

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

Response example​

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

POST /staff_properties​

Section: Staff.

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

Request example​

curl -k -X POST "https://{controller_ip}/api/v1/staff_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/staff_properties" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

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

PUT /staff/ban/{uuid}​

Section: Staff.

Updates data for the staff endpoint /staff/ban/{uuid}.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/staff/ban/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Smith",
  "first_name": "John",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}'

Request body example​

{
  "last_name": "Smith",
  "first_name": "John",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}

Response command example​

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

Response example​

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

PUT /staff/unban/{uuid}​

Section: Staff.

Updates data for the staff endpoint /staff/unban/{uuid}.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/staff/unban/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Smith",
  "first_name": "John",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}'

Request body example​

{
  "last_name": "Smith",
  "first_name": "John",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}

Response command example​

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

Response example​

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

PUT /staff/{uuid}​

Section: Staff.

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

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/staff/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Smith",
  "first_name": "John",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}'

Request body example​

{
  "last_name": "Smith",
  "first_name": "John",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}

Response command example​

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

Response example​

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

PUT /staff_properties/{name}​

Section: Staff.

Updates data for the staff endpoint /staff_properties/{name}.

Request example​

curl -k -X PUT "https://{controller_ip}/api/v1/staff_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/staff_properties/{name}" \
  -H "Authorization: Bearer <token>" | jq .

Response example​

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

DELETE /staff/{uuid}​

Section: Staff.

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

Request example​

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

Response command example​

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

Response example​

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

DELETE /staff_properties/{name}​

Section: Staff.

Deletes data for the staff endpoint /staff_properties/{name}.

Request example​

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

Response command example​

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

Response example​

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