Clients

List Clients

Lists all clients.

GET

/clients

List Clients

curl --request GET \
  --url 'https://api.operating.app/v1/clients?after=%3Cstring%3E&limit=123&createdBefore=%3Cstring%3E&createdSince=%3Cstring%3E&updatedBefore=%3Cstring%3E&updatedSince=%3Cstring%3E&externalId=%3Cstring%3E&isInternal=true' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "archivedAt": "<string>",
      "clientNumber": "<string>",
      "createdAt": "<string>",
      "description": "<string>",
      "externalClients": [
        {
          "createdAt": "<string>",
          "externalId": "<string>",
          "externalSystemName": "<string>",
          "name": "<string>",
          "uniqueIdentifier": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "id": "<string>",
      "invoicingEmail": "<string>",
      "isInternal": true,
      "name": "<string>",
      "ownerPersonId": "<string>",
      "uniqueIdentifier": "<string>",
      "updatedAt": "<string>",
      "vatId": "<string>"
    }
  ],
  "meta": {
    "nextCursor": "<string>"
  }
}

Clients represent the companies that your company works with.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

afterstringquery

For pagination. Return results after this cursor.

limitnumberquery

For pagination. Return at most this number of results.

createdBeforestringquery

Filter records by whether they were created before a certain instant in ISO8601 format in UTC.

createdSincestringquery

Filter records by whether they were created after a certain instant in ISO8601 format in UTC.

updatedBeforestringquery

Filter records by whether they were updated before a certain instant in ISO8601 format in UTC.

updatedSincestringquery

Filter records by whether they were updated after a certain instant in ISO8601 format in UTC.

externalIdstringquery

Filter records by external id.

isInternalenum<string>query

Available options: true, false

Response

Successful response

dataobject[]required

Show child attributes

metaobjectrequired

Show child attributes

Still need help? Ask the team