Skip to main content
GET
/
api
/
v1
/
clients
List clients
curl --request GET \
  --url https://api.contracting.kukkingu.software/api/v1/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'tenant-id: <tenant-id>'
{
  "data": [
    {
      "id": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
      "name": "Acme Corporation",
      "createdAt": "2023-10-05T14:48:00.000Z",
      "updatedAt": "2023-10-05T14:48:00.000Z",
      "description": "A leading provider of road runner deterrents.",
      "order": 13
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Headers

tenant-id
string
required

Specifies the tenant context for the request. All endpoints operate within this tenant scope.

Example:

"tnt_pfh0haxfpzowht3oi213cqos"

Response

Default Response

Standard success response payload wrapped in a data property.

data
object[]
required

List of clients returned by the API.