API referenceList contacts

Contacts

List contacts

Returns a paginated list of all contacts in the project the API key is scoped to. Contacts are the people your workspace communicates with across every Omni v2 channel (WhatsApp, web chat, email, and so on). Each contact in the list includes its numeric id (the contact_id you pass to every other Contacts endpoint), core fields such as name, email, and phone_number, plus structured additional_attributes and free-form custom_attributes. Use the sort query parameter to control ordering and page to walk through large result sets.

GET

https://api.nabrah.ai/api/ext/omni_v2/contact

List contacts

curl --request GET \
  --url 'https://api.nabrah.ai/api/ext/omni_v2/contact' \
  --header 'X-API-Key: <your-api-key>'

{
  "meta": {
    "count": 0,
    "current_page": "string"
  },
  "payload": [
    {
      "id": 0,
      "additional_attributes": {
        "city": "string",
        "country": "string",
        "description": "string",
        "company_name": "string",
        "country_code": "string",
        "social_profiles": {}
      },
      "availability_status": "string",
      "email": "string",
      "name": "string",
      "phone_number": "string",
      "blocked": false,
      "identifier": "string",
      "thumbnail": "string",
      "custom_attributes": {},
      "last_activity_at": 0,
      "created_at": 0
    }
  ]
}

Authentication

All Omni v2 endpoints authenticate with a Web API key.

X-API-Key header

Send your key in the X-API-Key header (e.g. X-API-Key: nb_...). Keys are created in the dashboard under the Developers tab and are prefixed with nb_. Each key is scoped to a single project, so there is no project_id parameter on this endpoint. You can validate a key with GET /api/ext/test.

Pagination

Results are returned one page at a time.

Reading meta

The response meta object reports the total count of contacts and the current_page you are viewing. Use these to decide whether more pages remain.

meta.countmeta.current_page

Paging through results

Pass ?page=1 for the first page and increment page until the returned payload array is empty (or you have retrieved meta.count contacts). When page is omitted the first page is returned.

Each contact's id field is the contact_id used by the get, update, conversations, ticket, and WhatsApp endpoints.

Contact fields

additional_attributes

A structured object of standard profile fields: city, country, description, company_name, country_code, and social_profiles.

citycountrydescriptioncompany_namecountry_codesocial_profiles

custom_attributes

A free-form key/value object holding workspace-defined custom fields for the contact.

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Query parameters

pageinteger

1-based page number to retrieve. Omit to fetch the first page.

Increment until the returned payload array is empty to iterate over all contacts.

sortstring

Attribute used to order the returned contacts.

Accepted values: last_activity_at, name, email, phone_number. Prefix any value with a hyphen (e.g. -last_activity_at, -name, -email, -phone_number) to sort in descending order.

Response

200

Successful Response

application/json

422

Validation Error

application/json

API referenceList contacts

Contacts

List contacts

GET

https://api.nabrah.ai/api/ext/omni_v2/contact

List contacts

curl --request GET \
  --url 'https://api.nabrah.ai/api/ext/omni_v2/contact' \
  --header 'X-API-Key: <your-api-key>'

{
  "meta": {
    "count": 0,
    "current_page": "string"
  },
  "payload": [
    {
      "id": 0,
      "additional_attributes": {
        "city": "string",
        "country": "string",
        "description": "string",
        "company_name": "string",
        "country_code": "string",
        "social_profiles": {}
      },
      "availability_status": "string",
      "email": "string",
      "name": "string",
      "phone_number": "string",
      "blocked": false,
      "identifier": "string",
      "thumbnail": "string",
      "custom_attributes": {},
      "last_activity_at": 0,
      "created_at": 0
    }
  ]
}

Authentication

All Omni v2 endpoints authenticate with a Web API key.

X-API-Key header

Pagination

Results are returned one page at a time.

Reading meta

The response meta object reports the total count of contacts and the current_page you are viewing. Use these to decide whether more pages remain.

meta.countmeta.current_page

Paging through results

Pass ?page=1 for the first page and increment page until the returned payload array is empty (or you have retrieved meta.count contacts). When page is omitted the first page is returned.

Each contact's id field is the contact_id used by the get, update, conversations, ticket, and WhatsApp endpoints.

Contact fields

additional_attributes

A structured object of standard profile fields: city, country, description, company_name, country_code, and social_profiles.

citycountrydescriptioncompany_namecountry_codesocial_profiles

custom_attributes

A free-form key/value object holding workspace-defined custom fields for the contact.

Authorization

X-API-Keystringheaderrequired

Your workspace API key. Create one in the dashboard under API keys.

Query parameters

pageinteger

1-based page number to retrieve. Omit to fetch the first page.

Increment until the returned payload array is empty to iterate over all contacts.

sortstring

Attribute used to order the returned contacts.

Accepted values: last_activity_at, name, email, phone_number. Prefix any value with a hyphen (e.g. -last_activity_at, -name, -email, -phone_number) to sort in descending order.

Response

200

Successful Response

application/json

422

Validation Error

application/json