Skip to main content

List Clients

Purpose: Retrieves a list of all integrated clients and their IDs associated with the calling integrator (as identified by the authentication header).

Endpoint Details​

  • HTTP Verb: GET
  • URL Segment: /v3/clients
  • OpenAPI Spec: View in Swagger UI
  • Notes: The list of clients is scoped to the integrator whose ID is determined from the OAuth credentials in the request header.

Path Parameters​

No Path Parameters Required.

Query Parameters​

No Query Parameters Required.

Request Body​

No Request Body Required.

Successful Response (200 OK)​

The API returns a JSON array. This array contains one or more objects, each representing a single Client entity upon successful retrieval.

Field NameDescriptionTypeAdditional Information
idThe unique ID of the client.string ($uuid)
orgNumberThe organization number of the client.string

Example Successful Response (200 OK)​

The response is an array of client objects.

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "orgNumber": "5560123456"
  },
  {
    "id": "a1b1c1d1-e2f2-3g4h-5i6j-7k8l9m0n1o2p",
    "orgNumber": "9101123456"
  }
]

Error Responses​

The following HTTP status codes are explicitly documented for this method:

Status CodeDescription
400 Bad RequestThe request was invalid (e.g., issues with client ID lookup based on credentials).
500 Internal Server ErrorAn unexpected error occurred on the server.