Get Client

GET /clients/{client_id}

Returns the client organization details, including partner info and the active enrollment token. This is the root resource that all other v2 endpoints are scoped under.

When to use this endpoint

Scenario	Why this endpoint
Load client settings or overview page	Get name, status, partner, and enrollment token in one call
Display the enrollment token for agent deployment	The active token value is embedded in the response
Show which partner manages this client	Partner name is embedded in the response

Path Parameters

Parameter	Type	Description
client_id	string (uuid)	Unique identifier for the client organization

Response

Returns a single Client object.

Field	Type	Nullable	Description
id	string (uuid)	No	Stable unique identifier for the client organization
name	string	No	Client organization display name
status	string	No	Client status: active
partner	Partner	No	The partner that manages this client
enrollment_token	EnrollmentToken	Yes	The active enrollment token. null if no token has been generated.
created_at	string (ISO 8601)	No	When this client record was first created
updated_at	string (ISO 8601)	No	When this client record was last modified

Example Request

curl -X GET "https://api.example.com/v2/clients/aa7cf840-9ca9-46a3-9778-9015d6580d50" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Example Response

{
  "id": "aa7cf840-9ca9-46a3-9778-9015d6580d50",
  "name": "Acme Corporation",
  "status": "active",
  "partner": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "TechPartner Inc."
  },
  "enrollment_token": {
    "id": "e1f2a3b4-c5d6-7890-abcd-ef1234567890",
    "value": "enroll_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
    "description": "Default enrollment token",
    "site_id": null,
    "status": "active",
    "max_uses": null,
    "remaining_uses": null,
    "expires_at": null,
    "created_at": "2026-01-15T10:00:00.000Z"
  },
  "created_at": "2025-06-01T00:00:00.000Z",
  "updated_at": "2026-02-20T12:00:00.000Z"
}

Client with no enrollment token

{
  "id": "aa7cf840-9ca9-46a3-9778-9015d6580d50",
  "name": "Acme Corporation",
  "status": "active",
  "partner": {
    "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "name": "TechPartner Inc."
  },
  "enrollment_token": null,
  "created_at": "2025-06-01T00:00:00.000Z",
  "updated_at": "2026-02-20T12:00:00.000Z"
}

Error Responses

Status	Description
401	Authentication required
403	Insufficient permissions for this client
404	Client not found
500	Server error

Related Endpoints

• List Users - Users in this client organization
• List Devices - Devices in this client organization
• List Departments - Departments in this client organization