Clients

Returns a paginated list of clients, including each client's courses, learning paths, licenses, appearance settings, and feature flags

Returns a paginated list of clients, including each client's courses, learning paths, licenses, appearance settings, and feature flags.

GEThttps://example.thoughtindustries.com/incoming/v2/clients

Example request

curl "https://example.thoughtindustries.com/incoming/v2/clients" \
  -H 'Authorization: Bearer YOUR_API_KEY'

Parameters

Name	Type	Required	Location	Description
`query`	`string`	No	query	Filters clients by a search string matched against client name or other indexed fields.
`sort`	`string`	No	query	Field by which to sort the results, such as `name` or `createdAt`.
`cursor`	`string`	No	query	Opaque cursor for the next page of results. Omit to fetch the first page.

Example response

{
  "pageInfo": {
    "total": 0,
    "hasMore": true,
    "cursor": "string"
  },
  "clients": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "slug": "string",
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "tags": [
        {
          "id": "00000000-0000-0000-0000-000000000000",
          "label": "string"
        }
      ],
      "sku": "string",
      "disabled": true
    }
  ]
}

Response fields

Field	Type	Description
`pageInfo`	`object`	Cursor-based pagination metadata for the result set.
`pageInfo.total`	`integer`	Total number of records matching the query.
`pageInfo.hasMore`	`boolean`	Whether additional pages of results are available.
`pageInfo.cursor`	`string`	Opaque cursor to pass on the next request. Present when `hasMore` is `true`.
`clients`	`object[]`	Array of client objects for the current page.
`clients.id`	`uuid`	Identifier of the client.
`clients.name`	`string`	Name of the client.
`clients.slug`	`string`	URL slug of the client.
`clients.createdAt`	`ISO 8601 timestamp`	Timestamp when the client was created.
`clients.updatedAt`	`ISO 8601 timestamp`	Timestamp when the client was last updated.
`clients.tags`	`object[]`	Tags applied to the client.
`clients.tags.id`	`uuid`	Identifier of the tag.
`clients.tags.label`	`string`	Display label of the tag.
`clients.sku`	`string`	SKU of the client.
`clients.disabled`	`boolean`	Whether the client is disabled.