Customers

List customers

List end-customers (tenant-of-tenant) attached to the organization. Each customer can own one or more WhatsApp accounts via setup links. NOTE: a customer here is NOT a WhatsApp contact — see the /{phone_number_id}/contacts resource for those.

get/customers

Request

Base URL: https://api.kirimdev.com/v1
URL: https://api.kirimdev.com/v1/customers
Auth: HTTP bearer

Query parameters

status'pending' | 'active' | 'suspended' | 'archived'

Filter customers by lifecycle state.

Example:active

searchstring

Case-insensitive pattern search across customer name and email. % matches any sequence of characters and _ matches one character.

Example:Acme

limitstring

Number of items to return. Defaults to 25; minimum 1 and maximum 100.

Example:25

cursorstring

Opaque continuation token from the previous response's next_cursor. Pass it unchanged and keep all other filters the same.

Example:eyJpZCI6IjAxSFhZWkFCQ0RFRkdISktNTlBRUlNUVldYIiwidHMiOiIyMDI2LTA5LTEwVDA5OjAwOjAwLjAwMFoifQ

Response

Customer list

has_moreboolean required

Whether another page is available.

next_cursorstring nullable required

Pass this value unchanged as cursor to fetch the next page. null marks the final page.

request_idstring required

Unique request identifier to include when contacting support.

Example response

{
  "data": [
    {
      "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
    }
  ],
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

No recorded changes to this operation across all 1 revision of this API.