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"
import requests
import json
url = "https://api.spkey.co/camera-roles/example_string/details"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.spkey.co/camera-roles/example_string/details", {
method: "GET",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.spkey.co/camera-roles/example_string/details", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/camera-roles/example_string/details')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"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"
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
GET
/camera-roles/{id}/detailsGET
Base URLstring
Target server for requests. Edit to use your own host.
Bearer Token (JWT)
Bearer Tokenstring
RequiredJWT 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
RequiredAPI key for B2B organization access. Provided during organization onboarding.
API key for B2B organization access. Provided during organization onboarding.
path
idstring
RequiredCamera Role ID
Request Preview
Response
Response will appear here after sending the request
Authentication
header
Authorizationstring
RequiredBearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
header
X-API-Keystring
RequiredAPI Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
idstring
RequiredCamera Role ID
Responses
roleIdstring
RequiredthreeDeyeRoleIdstring
Requirednamestring
Requireddescriptionstring
RequiredorgIdstring
Requiredstatusstring
RequiredAllowed values:
ActiveDeletedusersarray
RequireduserIdstring
RequiredthreeDeyeUserIdstring
Requiredcamerasarray
RequiredcameraIdstring
Requiredpermissionsstring[]
Requiredversionnumber
Requiredtimestampstring
Requiredsuccessboolean
Requirederrorsarray
Requiredcodenumber
Requiredmessagestring
RequiredWas this page helpful?