List clients

GET /v0/labs/clients

Return every client of your lab, most recently added first.

Use start and limit to page through the results — a maximum of 100 clients are returned at a time. When more clients are available beyond the current page, more_results is true.

Query parameters

start integer optional

Zero-based index of the first client to return.

Default: 0

limit integer optional

Maximum number of clients to return. Capped at 100.

Default: 100

modified_since_time string optional

Only return clients modified after this time, e.g. 2025-03-14T09:12:44.

archived boolean optional

Only return archived clients when true, or only active clients when false. Omit to return both.

Try it

Log in to send test requests to this endpoint straight from the docs.

Responses

200 Success
clients array of objects
Show 6 child attributes Hide 6 child attributes
id integer

Client ID

name string

Organization Name

training boolean

Whether this is a training client

last_modified timestamp

Time this client was last modified

licenses array of objects
Show 3 child attributes Hide 3 child attributes
id integer

License ID

license_number string

License Number

license_code string

License Code (some states only)

archived boolean

True if this client has been archived

more_results boolean

True when more clients are available beyond this page.

400 Bad request

The request was malformed or failed validation. Validation failures include per-field messages in error_details.

Possible error_code values: invalid_request, request_too_old.

401 Unauthorized

Authentication failed.

Possible error_code values: missing_api_key, invalid_api_key, invalid_credentials_type, api_access_restricted, api_access_denied, missing_signature, missing_timestamp, invalid_timestamp, invalid_signature.

403 Permission denied

The API key is valid but does not have permission for this endpoint (for example, a client key calling a labs endpoint).

Possible error_code values: permission_denied.

How to sign requests
# X-ConfidentLims-Signature: see the Request Signing guide - https://api.confidentcannabis.com/v0/docs/request-signing.md
curl -X GET 'https://api.confidentcannabis.com/v0/labs/clients' \
  -H 'X-ConfidentLims-APIKey: YOUR_API_KEY' \
  -H 'X-ConfidentLims-Timestamp: UNIX_TIMESTAMP' \
  -H 'X-ConfidentLims-Signature: REQUEST_SIGNATURE'
Response · 200
{
  "success": true,
  "clients": [
    {
      "id": 318,
      "name": "Sunrise Cultivation",
      "training": false,
      "last_modified": "2025-02-27T18:04:03",
      "licenses": [
        {
          "id": 4410,
          "license_number": "CDPH-10003456",
          "license_code": null
        }
      ],
      "archived": false
    },
    {
      "id": 244,
      "name": "Harbor Extracts",
      "training": false,
      "last_modified": "2025-01-19T10:47:56",
      "licenses": [
        {
          "id": 3902,
          "license_number": "CDPH-10002211",
          "license_code": null
        }
      ],
      "archived": true
    }
  ],
  "more_results": false
}