API reference · Contacts

List contacts

List your contacts, newest first, 50 at a time. Filter by group or search by name, phone or email.

GET/v1/contacts

Bearer API key
Rate limit 120 / min
Returns 200 OK
Needs the Contacts permission · free

GET /v1/contacts

curl https://api.talks.africa/v1/contacts?group=grp_vip&q=amina \
  -H "Authorization: Bearer $TALKS_KEY"

{
  "data": [
    {
      "id": "ct_19x",
      "first_name": "Amina",
      "last_name": "Odhiambo",
      "phone": "+254722418903"
    }
  ],
  "next_cursor": "ct_18w"
}

Use a tk_test_ key while you build. Nothing is sent and no credits are used.

Parameters

groupstringoptional
Only people in this group.
qstringoptional
Search name, phone or email.
cursorstringoptional
From the previous page, to get the next one.

Response fieldsResponse

data
Contacts on this page
next_cursor
Pass it as cursor to get the next page

Errors

Tap one to see its response above.

All errors use the standard error object. Select one to see its response.

Was this page helpful?