Skip to content
ClickFix
Sign inBook a demo
Documentation

List contacts

View as MarkdownOpen in ChatGPTOpen in ClaudeFeedback
GET
/v1/public-api/contacts

Scope: contacts:read. q searches name and email (case-insensitive). external_id matches your own user id exactly. Records carry external_id, verified_at and the company's company_external_id.

Authorization

integrationKey
headerAuthorizationBearer <cf_sk_…>

Organization API key (cf_sk_…), created under Organization → API and automations → API keys and sent as Authorization: Bearer cf_sk_….

Query Parameters

limit?integer
Range0 <= value <= 100
Default20
offset?integer
Range0 <= value
Default0
q?string

Case-insensitive match on the contact name or e-mail.

external_id?string

The customer's own user id, exact match.

Lengthlength <= 200

Response Body

Success

application/json
  1. response
success*boolean
data*unknown
meta?
Example Request
curl -X GET 'https://api.getclickfix.com/v1/public-api/contacts'
Example Response
{  "success": true,  "data": {    "items": [      {        "uuid": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",        "name": "Ayşe Yılmaz",        "email": "ayse@example.com",        "phone": "+905551112233",        "external_id": "1001",        "identity_state": "verified",        "verified_at": "2026-11-10T18:42:11Z",        "job_title": "Operations manager",        "company": {          "uuid": "0f9e8d7c-6b5a-4493-8271-605f4e3d2c1b",          "name": "Acme Ltd.",          "external_id": "F-77"        },        "locale": "tr",        "timezone": "Europe/Istanbul",        "notes": "",        "custom_fields": {          "plan": "pro",          "seats": 12        },        "blocked": false,        "channel_types": [          "widget",          "email"        ],        "conversation_count": 3,        "last_seen_at": "2026-11-11T09:14:50Z",        "created_at": "2026-10-01T07:00:00Z",        "updated_at": "2026-11-11T09:14:50Z"      }    ],    "total": 1,    "limit": 20,    "offset": 0  },  "meta": {    "request_id": "01JCK9ZQ3M8R2W7X5E4T1N0PAB"  }}