Chatofy API

Developer APIContactsList Contacts

List Contacts

Retrieves a paginated list of contacts. Supports filtering by phone or UUID.

GET/api/v1/contacts

Note

Each contact record includes BSUID fields (user_id, username, parent_user_id, last_bsuid_sync) for Business-Scoped User ID compatibility.

Query Parameters

4 parameters

limitnumberrequired

Max results per page (default: 100, max: 100).

offsetnumberrequired

Number of records to skip (default: 0).

phonestringrequired

Filter by phone number (e.g. +917838343515).

iduuidrequired

Filter by contact UUID.

Response Payload

200 OKapplication/json

successbooleanrequired

Whether request succeeded

messagestringrequired

Human-readable result

data[]array<object>required

Array of contact objects

data[].iduuidrequired

Unique contact identifier

data[].phone_numberstringrequired

Contact phone number with country code

data[].first_namestringoptional

Contact first name

data[].last_namestring|nulloptional

Contact last name

data[].user_idstringoptional

Meta BSUID (if synced)

Example:IN.23156789012345678

data[].created_atdatetimerequired

When contact was created

data[].updated_atdatetimerequired

When contact was last updated

paginationobjectrequired

Pagination metadata

pagination.totalnumberrequired

Total matching records

pagination.limitnumberrequired

Items per page

pagination.offsetnumberrequired

Current offset

Code Snippets & Examples

curl -X GET "https://app.chatofy.in/api/v1/contacts?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Was this endpoint guide helpful?

Enterprise SLA•99.99% Guaranteed

curl -X GET "https://app.chatofy.in/api/v1/contacts?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

200 OKapplication/json

{
  "success": true,
  "data": [
    {
      "id": "b74d8c2f-dea7-4882-90b8-fddb421b19d5",
      "phone_number": "+917838343515",
      "first_name": "Synbus Solutions",
      "last_name": null,
      "attributes": {},
      "user_id": "IN.23156789012345678",
      "username": "john_doe",
      "parent_user_id": null,
      "last_bsuid_sync": "2026-07-19T12:00:00.000Z",
      "created_at": "2026-06-06T06:41:59.786701+00:00",
      "updated_at": "2026-06-06T08:16:05.520468+00:00"
    }
  ],
  "message": "Contacts retrieved successfully",
  "pagination": {
    "total": 1,
    "limit": 10,
    "offset": 0
  }
}

Developer APIContactsList Contacts

List Contacts

Retrieves a paginated list of contacts. Supports filtering by phone or UUID.

GET/api/v1/contacts

Note

Each contact record includes BSUID fields (user_id, username, parent_user_id, last_bsuid_sync) for Business-Scoped User ID compatibility.

Query Parameters

4 parameters

limitnumberrequired

Max results per page (default: 100, max: 100).

offsetnumberrequired

Number of records to skip (default: 0).

phonestringrequired

Filter by phone number (e.g. +917838343515).

iduuidrequired

Filter by contact UUID.

Response Payload

200 OKapplication/json

successbooleanrequired

Whether request succeeded

messagestringrequired

Human-readable result

data[]array<object>required

Array of contact objects

data[].iduuidrequired

Unique contact identifier

data[].phone_numberstringrequired

Contact phone number with country code

data[].first_namestringoptional

Contact first name

data[].last_namestring|nulloptional

Contact last name

data[].user_idstringoptional

Meta BSUID (if synced)

Example:IN.23156789012345678

data[].created_atdatetimerequired

When contact was created

data[].updated_atdatetimerequired

When contact was last updated

paginationobjectrequired

Pagination metadata

pagination.totalnumberrequired

Total matching records

pagination.limitnumberrequired

Items per page

pagination.offsetnumberrequired

Current offset

Code Snippets & Examples

curl -X GET "https://app.chatofy.in/api/v1/contacts?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

Was this endpoint guide helpful?

Enterprise SLA•99.99% Guaranteed

{ "success": true, "data": [ { "id": "b74d8c2f-dea7-4882-90b8-fddb421b19d5", "phone_number": "+917838343515", "first_name": "Synbus Solutions", "last_name": null, "attributes": {}, "user_id": "IN.23156789012345678", "username": "john_doe", "parent_user_id": null, "last_bsuid_sync": "2026-07-19T12:00:00.000Z", "created_at": "2026-06-06T06:41:59.786701+00:00", "updated_at": "2026-06-06T08:16:05.520468+00:00" } ], "message": "Contacts retrieved successfully", "pagination": { "total": 1, "limit": 10, "offset": 0 } }