List Contacts

GET

/api/v1/{subdomain}/contacts

Retrieve a paginated list of all contacts in your tenant. You can filter and search
contacts using various query parameters to find specific segments of your audience.

Use Cases:

Browse all contacts in your database

Filter contacts by type (leads vs customers)

Find contacts from specific sources or with certain statuses

Implement pagination for large contact lists

Request

Authorization

Path Params

Query Params

Responses

🟢200

application/json

Body

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://whatsapp.qtap.chat/api/v1//contacts?type=lead&source_id=1&status_id=1&page=1&per_page=15'

Response Example

200 - Example 1

{
    "status": "success",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1,
                "firstname": "John",
                "lastname": "Doe",
                "company": "Demo Company",
                "type": "lead",
                "email": "john@example.com",
                "phone": "+1234567890",
                "source_id": 1,
                "status_id": 1,
                "description": "Interested in premium services",
                "country_id": 101,
                "group_id": [
                    1,
                    2
                ],
                "created_at": "2024-02-08T10:00:00.000000Z",
                "updated_at": "2024-02-08T10:00:00.000000Z"
            }
        ],
        "first_page_url": "https://yourdomain.com/api/v1/tenantx/contacts?page=1",
        "from": 1,
        "last_page": 7,
        "last_page_url": "https://yourdomain.com/api/v1/tenantx/contacts?page=7",
        "links": [
            {
                "url": null,
                "label": "&laquo; Previous",
                "active": false
            },
            {
                "url": "https://yourdomain.com/api/v1/tenantx/contacts?page=1",
                "label": "1",
                "active": true
            }
        ],
        "next_page_url": "https://yourdomain.com/api/v1/tenantx/contacts?page=2",
        "path": "https://yourdomain.com/api/v1/tenantx/contacts",
        "per_page": 15,
        "prev_page_url": null,
        "to": 15,
        "total": 100
    }
}

Create a New Contact

Get Contact Details