Skip to main content
GET
/
api
/
v1
/
contacts
List contacts
curl --request GET \
  --url https://api.contracting.kukkingu.software/api/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'tenant-id: <tenant-id>'
{
  "data": [
    {
      "id": "con_xlbg6ubfio7tzvsijyp5794c",
      "client": "clnt_z2b3mo8qa5kzptgsu26q2wmh",
      "emails": [
        "eml_vfj7s2ym02jvykrnbl9xufrt"
      ],
      "addresses": [
        "adr_ekq4ymw1nyyd4b6k6f5tg3t6"
      ],
      "name": "Jane Doe",
      "isDefault": true,
      "createdAt": "2023-10-05T14:48:00.000Z",
      "updatedAt": "2023-10-05T14:48:00.000Z",
      "salutation": "Ms.",
      "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"

Query Parameters

​
expand
string

Comma-separated list of relations to expand. Allowed values: client, emails, addresses.

Example:

"client,emails,addresses"

​
clientId
string

Unique identifier of the client.

Example:

"clnt_z2b3mo8qa5kzptgsu26q2wmh"

Response

Default Response

Standard success response payload wrapped in a data property.

​
data
object[]
required

List of contacts returned by the API.