List Contacts

Retrieve a paginated list of contacts with advanced filtering, sorting, searching, field selection, and relationship inclusion

Required Scope

contacts:read

Filtering

Apply filters using the format filter[field]=value or filter[field][operator]=value

Filter [field]

type Contact type

status_id Status ID

source_id Source ID

assigned_id Assigned user ID

created_at Creation date

group_id Group ID

Filter [operator]

gte Greater than or equal
lte Less than or equal
gt Greater than
lt Less than
ne Not equal
like Partial match (wraps with %)
in Match any value in list
not_in Exclude values in list
between Between two values
null Check if field is null (true/false)

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "data": [
        {
            "id": 0,
            "firstname": "string",
            "lastname": "string",
            "company": "string",
            "type": "string",
            "email": "string",
            "phone": "string",
            "status_id": 0,
            "source_id": 0,
            "description": null,
            "city": null,
            "state": null,
            "zip": null,
            "address": null,
            "country_id": null,
            "assigned_id": 0,
            "group_id": [
                "string"
            ],
            "is_opted_out": true,
            "created_at": "string",
            "updated_at": "string"
        }
    ],
    "meta": {
        "request_id": "string",
        "timestamp": "string",
        "pagination": {
            "total": 0,
            "count": 0,
            "per_page": 0,
            "current_page": 0,
            "total_pages": 0,
            "has_more": true
        }
    }
}

🟠401UNAUTHORIZED

🟠403INSUFFICIENT_SCOPE

🟠403FEATURE_LIMIT_EXCEEDED

🟠404NOT_FOUND

🟠422VALIDATION_ERROR

🟠422WHATSAPP_NOT_CONFIGURED

🟠429RATE_LIMIT_EXCEEDED

🔴500INTERNAL_ERROR

List Contacts

Retrieve a paginated list of contacts with advanced filtering, sorting, searching, field selection, and relationship inclusion#

Required Scope#

Filtering#

Filter [field]#

Filter [operator]#