Skip to main content
GET
/
chatbots
/
{chatbotId}
/
contacts
List contacts
curl --request GET \
  --url https://api.chatling.ai/v2/chatbots/{chatbotId}/contacts \
  --header 'Authorization: Bearer <token>'
{
    "status": "success",
    "data": {
        "pages": {
            "current_page": 1,
            "last_page": 1,
            "per_page": 25
        },
        "contacts": [
            {
                "id": "qtr89df0-112d-d197-b541-3f8674663246",
                "name": "Mark Zuckerberg",
                "email": "[email protected]",
                "job_title": "CEO",
                "phone": "555-555-5555",
                "website": "https://meta.com",
                "company": "Meta Inc.",
                "created_at": "2024-06-08T13:38:33+00:00"
            }
        ]
    }
}

​
Request parameters

​
Path

​
chatbotId
string
required
The chatbot ID.

​
Query

​
page
integer
default:"1"
The page number for pagination.
​
sort
string
default:"date_desc"
The sort order. Possible values:
  • date_desc: Sort by date in descending order.
  • date_asc: Sort by date in ascending order.

​
Response

​
status
string
The status of the request. Will be success if the request was successful, otherwise error.
​
data
object
{
    "status": "success",
    "data": {
        "pages": {
            "current_page": 1,
            "last_page": 1,
            "per_page": 25
        },
        "contacts": [
            {
                "id": "qtr89df0-112d-d197-b541-3f8674663246",
                "name": "Mark Zuckerberg",
                "email": "[email protected]",
                "job_title": "CEO",
                "phone": "555-555-5555",
                "website": "https://meta.com",
                "company": "Meta Inc.",
                "created_at": "2024-06-08T13:38:33+00:00"
            }
        ]
    }
}