Skip to main content
GET
/
v1
/
bot
/
crm
/
contacts
List CRM Contacts
curl --request GET \
  --url https://api.boostgpt.co/v1/bot/crm/contacts \
  --header 'Authorization: Bearer <token>'
{
  "total": 123,
  "contacts": [
    {
      "uuid": "<string>",
      "name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "company": "<string>",
      "status": "<string>",
      "status_label": "<string>",
      "fields": {},
      "summary": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>"
    }
  ],
  "pagination": {
    "page": 123,
    "per_page": 123,
    "total": 123,
    "total_pages": 123
  }
}

Authorizations

​
Authorization
string
header
required

Enter your API key

Query Parameters

​
project_id
string
required

Project ID

​
bot_id
string
required

Agent ID

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
Required range: 1 <= x <= 100
​
status
string
​
status_id
string
​
status_key
string

Response

Success

​
total
integer
​
contacts
object[]
​
pagination
object