Get client devices

Retrieve a list of devices for a specific client.

POST /api/partner/getClientDevices

Get client devices

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/partner/getClientDevices \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}
'

200

{
  "devices": [
    {
      "device": {
        "createdAtMillis": 123,
        "customData": "<string>",
        "deleted": true,
        "description": "<string>",
        "facetNameMap": {},
        "hardwareId": "<string>",
        "mummified": true,
        "name": "<string>",
        "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "pending": true,
        "policyUuid": "AAAAAAAAAAAAAAAAAAAAAA",
        "serialNumber": "<string>",
        "unregisteredEmailSent": true,
        "uuid": "AAAAAAAAAAAAAAAAAAAAAA"
      },
      "partnerControlledHardware": true,
      "reassignable": true
    }
  ]
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: partner-api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for getting devices for a specific client organization.

orgUuid · string<RUUID> | null

base 64 (url-safe) uuid string

Example:

"AAAAAAAAAAAAAAAAAAAAAA"

Response

200 - application/json

OK

Response object containing devices for a specific client organization.

devices · object[] | null

List of devices with partner-specific details

Show child attributes