Fetch Organisation Contacts Api

curl --request GET \
  --url https://services.meetchase.ai/api/v1/contacts \
  --header 'X-API-Key: <api-key>'

[
  {
    "timezone": "<string>",
    "id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "custom_data": {},
    "email": "<string>",
    "tags": [
      "<string>"
    ],
    "dnc": true
  }
]

Contacts

Fetch Contacts

Retrieves a list of all contacts associated with a specified organisation, including their personal and location information.

Path Parameters

organisation_id (int): The ID of the organisation whose contacts are being fetched.

Headers

X-API-Key: API key for user authentication.

Response

Returns a list of Contact objects, each representing a contact associated with the organisation. Each object includes the contact’s ID, email, first name, last name, custom data, and timezone.

Errors

403 Forbidden: If the user does not have the necessary permissions to access the contacts of the organisation.

GET

api

contacts

Fetch Organisation Contacts Api

curl --request GET \
  --url https://services.meetchase.ai/api/v1/contacts \
  --header 'X-API-Key: <api-key>'

[
  {
    "timezone": "<string>",
    "id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "custom_data": {},
    "email": "<string>",
    "tags": [
      "<string>"
    ],
    "dnc": true
  }
]

Authorizations

X-API-Key

string

header

required

Key used to authenticate user API requests.

Response

200 - application/json

Successful Response

timezone

string

required

Required string length: 1 - 45

integer

required

first_name

string | null

required

last_name

string | null

required

custom_data

Custom Data · object

required

string

required