Docs

Clients

List client companies

GET/v1/integration/platform/clients/page

The client companies your platform created, newest first. Requires an API key with the `clients:write` scope.

Requires an Alfa API key as a bearer token. How API keys work

Query parameters

  • limitstring

    How many results to return, from 1 to 100. Defaults to 25.

  • cursorstring

    The `nextCursor` of the previous page. Leave it out for the first page.

    at least 1 characters · at most 2048 characters

Response body

  • dataobject[]required

    The results on this page.

    Show fields
    • companyIdstringrequired

      The Company ID to send in `Alfa-Company-Id` for this client.

    • externalClientIdstringrequired

      Your id for the client.

    • namestringrequired

      The client company name.

    • countrystring | nullrequired

      Where the client is based.

    • createdAtstring | nullrequired

      When the client was created.

  • nextCursorstring | nullrequired

    Pass as `cursor` to read the next page; null on the last page.

Responses

  • 200Success.
  • 400The request is malformed: invalid JSON, an unexpected body or an unknown query parameter. Problem details
  • 401The bearer token is missing, expired or invalid. Problem details
  • 403The caller may not perform this operation, or has no active organisation. Problem details
  • 404The resource does not exist or is not visible to the caller. Problem details
  • 422The request failed validation; `errors` lists each invalid field. Problem details
  • 429Too many requests, or the AI service is busy. Retry after a short wait. Problem details
  • 500An unexpected error. Quote the `correlationId` to support. Problem details