QueryGet camera role details

Get camera role details

Get full camera role details including users and cameras arrays

curl -X GET "https://api.spkey.co/camera-roles/example_string/details" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "roleId": "example_string",
  "threeDeyeRoleId": "example_string",
  "name": "John Doe",
  "description": "example_string",
  "orgId": "example_string",
  "status": "Active",
  "users": [
    {
      "userId": "example_string",
      "threeDeyeUserId": "example_string"
    }
  ],
  "cameras": [
    {
      "cameraId": "example_string",
      "permissions": [
        "example_string"
      ]
    }
  ],
  "version": 3.14,
  "timestamp": "example_string"
}
GET
/camera-roles/{id}/details
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
path
idstring
Required

Camera Role ID

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

idstring
Required

Camera Role ID

Responses

roleIdstring
Required
threeDeyeRoleIdstring
Required
namestring
Required
descriptionstring
Required
orgIdstring
Required
statusstring
Required
Allowed values:ActiveDeleted
usersarray
Required
camerasarray
Required
versionnumber
Required
timestampstring
Required