Skip to content
Kirim Docs
Contacts

List contacts

GET
/contacts
 
curl --request GET \
  --url https://api-kckit.kirim.chat/v1/contacts \
  --header 'Authorization: Bearer <token>'

List contacts in the organization. Filter by exact phone (E.164) or partial search (matches name and email).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
phone
string
/^\+[1-9]\d{6,14}$/
search
string
>= 1 characters <= 200 characters
limit
string
/^\d+$/
cursor
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Contact list

Media type application/json
object
data
required
Array<object>
object
id
required
string
object
required
string
Allowed values: contact
phone_number
required
string | null
name
required
string | null
email
required
string | null
metadata
required
object | null
whatsapp_account
required
object
phone_number
required
string | null
created_at
required
string format: date-time
updated_at
required
string format: date-time
has_more
required
boolean
next_cursor
required
string | null
request_id
required
string
Example 
{
  "data": [
    {
      "id": "ctc_01HXYZABCDEFGHJKMNPQRSTVWX",
      "object": "contact"
    }
  ]
}

400

Section titled “400 ”

Validation failure

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

401

Section titled “401 ”

Authentication failure

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

429

Section titled “429 ”

Rate limit exceeded

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

500

Section titled “500 ”

Internal server error

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}