Get Contacts

Objective: To fetch a complete list of contact records for a specific location. This is typically used for synchronization, reporting, or populating a dashboard with user data.

1. Endpoint Configuration

HTTP Method: GET
Base URL: https://api.assistable.ai/v2/get-contacts/
Path Parameter: :id (This corresponds to the location_id)

Full Request URL:

https://api.assistable.ai/v2/get-contacts/{location_id}

Note: This endpoint retrieves all contacts for the specified location. Ensure your application can handle the payload size if the contact list is extensive.

2. Payload Preparation

Request Body: None.
Headers: Standard authentication headers (API Key/Bearer Token) are required.

3. Execution Steps

Identify Location ID: Retrieve the location_id for the target workspace. This replaces the :id in the URL.
Send Request: Execute the GET request using your preferred client.
Validate Response: Ensure the API returns a 200 OK status and a JSON array containing contact objects.

4. Response Verification

A successful request returns an array of contact objects.

Success Response Example:

JSON

[
  {
    "id": "3aaaac27-d1dc-4a53-ab01-dd9b887e426f",
    "workspace_id": "test-workspace",
    "location_id": "test-location",
    "first_name": null,
    "last_name": null,
    "phone_number": "+17702967272",
    "email": "jordsen@assistable.ai",
    "tags": [],
    "meta": {},
    "custom_fields": {},
    "attribution": {},
    "integration": {},
    "dnd": {},
    "created_at": "2025-12-03T19:07:15.01671+00:00",
    "updated_at": "2025-12-03T19:07:15.01671+00:00"
  },
  {
    "id": "3a0b342a-46eb-430a-8ea3-dba2a4d450f7",
    "workspace_id": "test-workspace",
    "location_id": "test-location",
    "first_name": "Jorden",
    "last_name": "Williams",
    "phone_number": "+17702967271",
    "email": "jorden@assistable.ai",
    "tags": [],
    "meta": {},
    "custom_fields": {},
    "attribution": {},
    "integration": {},
    "dnd": {},
    "created_at": "2025-12-03T18:50:51.906176+00:00",
    "updated_at": "2025-12-03T19:07:55.343337+00:00"
  }
]

5. Troubleshooting

404 Not Found: Verify the location_id in the URL is correct and exists in the system.
Empty Array []: The request was successful, but no contacts currently exist for that location_id.
401 Unauthorized: Verify your API Key/Bearer Token is active.