Skip to main content
GET
/
api
/
v1
/
addresses
List addresses
curl --request GET \
  --url https://api.contracting.kukkingu.software/api/v1/addresses \
  --header 'Authorization: Bearer <token>' \
  --header 'tenant-id: <tenant-id>'
{
  "data": [
    {
      "id": "adr_ekq4ymw1nyyd4b6k6f5tg3t6",
      "contact": "con_xlbg6ubfio7tzvsijyp5794c",
      "address1": "123 Main St",
      "address2": "Suite 400",
      "region": "California",
      "country": "United States",
      "city": "San Francisco",
      "zip": "94103",
      "createdAt": "2023-10-05T14:48:00.000Z",
      "updatedAt": "2023-10-05T14:48:00.000Z",
      "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: contact, contact.client.

Example:

"contact,contact.client"

contactId
string

The ID of the contact.

Example:

"con_xlbg6ubfio7tzvsijyp5794c"

Response

Default Response

Standard success response payload wrapped in a data property.

data
object[]
required

List of addresses returned by the API.