ContactsManage Contacts
List Contacts
Get a paginated list of contacts with optional filtering.
Returns contacts with optional filtering by search, type, tags, date range, and more.
Required: Contacts > Read
Authorization
bearerToken
AuthorizationBearer <token>
API token for YourGPT Public APIs. Create tokens in Settings > API Tokens in your YourGPT dashboard.
In: header
Request Body
application/json
project_uid*string
Your project's unique identifier.
search?string
Search by name, email, or phone.
type?string
Filter by contact type.
Value in
"ALL" | "USERS" | "LEADS" | "SPAM"limit?integer
Records per page.
Default
10page?integer
Page number.
Default
1orderBy?string
Sort order.
Value in
"ASC" | "DESC"tags?string
Comma-separated tag names to filter by.
list_id?integer
Filter by contact list.
exclude_spam?boolean
Exclude spam contacts from results.
from?string
Start date filter, YYYY-MM-DD.
to?string
End date filter, YYYY-MM-DD.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.yourgpt.ai/chatbot/v1/getAllContacts" \ -H "Content-Type: application/json" \ -d '{ "project_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }'{
"type": "RXSUCCESS",
"total": 150,
"data": [
{
"id": 5001,
"project_id": 12345,
"name": "John Doe",
"email": "john@example.com",
"phone": "+12345678901",
"type": "lead",
"tags": null,
"company_id": null,
"createdAt": "2025-01-15T10:30:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}
]
}{
"type": "RXERROR",
"message": "Invalid params"
}{
"type": "RXERROR",
"message": "Invalid or revoked API token"
}{
"type": "RXERROR",
"message": "You do not have permission to perform this action"
}