Kişileri listele

GET

/v1/public-api/contacts

Kapsam: contacts:read. q ile kişi adında veya e-postasında arama yapılabilir (büyük/küçük harf duyarsız). external_id kendi kullanıcı numaranızla tam eşleşir. Kayıtlar external_id, verified_at ve şirketin company_external_id alanını taşır.

Yetkilendirme

integrationKey

headerAuthorizationBearer <cf_sk_…>

Organizasyon API anahtarı (cf_sk_…). Organizasyon → API ve otomasyonlar → API anahtarları sayfasında oluşturulur; Authorization: Bearer cf_sk_… başlığıyla gönderilir.

Sorgu parametreleri

limit?integer

Range0 <= value <= 100

Default20

offset?integer

Range0 <= value

Default0

q?string

Kişi adında veya e-postasında büyük/küçük harf duyarsız arama.

external_id?string

Kendi sisteminizdeki kullanıcı numarası, tam eşleşme.

Lengthlength <= 200

Response Body

Başarılı

application/json

response

success*boolean

data*unknown

meta?

Örnek istek

curl -X GET 'https://api.getclickfix.com/v1/public-api/contacts'

Örnek istek

curl -X GET 'https://api.getclickfix.com/v1/public-api/contacts'

Örnek yanıtSchema

{
  "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"
  }
}

{  "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"  }}

Kişileri listele

YetkilendirmeBağlantıyı kopyala

Sorgu parametreleriBağlantıyı kopyala

Response BodyBağlantıyı kopyala

Yetkilendirme

Sorgu parametreleri

Response Body