Conversations

List conversations

List conversations for the WhatsApp account identified by phone_number_id. Default order: newest-active first by last_message_at (NULLS LAST). With updated_since, order switches to updated_at DESC so assignment/status changes are not buried. Supports short-lived server-side caching, and ETag/If-None-Match for unchanged responses.

get/{phone_number_id}/conversations

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/{phone_number_id}/conversations
  • Auth: HTTP bearer

Path parameters

phone_number_idstring required

Meta WhatsApp Business phone_number_id of the connected account that should send / own this resource. Discoverable via GET /v1/accounts (returned as phone_number_id on each row).

Example:106540352242922

Query parameters

status'open' | 'resolved' | 'pending'

Filter by inbox lifecycle state.

Example:open
contact_idstring

Return conversations linked to this public contact ID.

Example:ctc_01HXYZABCDEFGHJKMNPQRSTVWX
updated_sincestring date-time

Return conversations updated strictly after this ISO 8601 instant. Results then order by updated_at newest first.

Example:2026-09-10T00:00:00.000Z
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

Conversation 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": "cnv_01HXYZABCDEFGHJKMNPQRSTVWX",
      "whatsapp_account": {
        "phone_number_id": "106540352242922",
        "customer": {
          "id": "cus_01HXYZABCDEFGHJKMNPQRSTVWX"
        }
      },
      "labels": [
        {
          "id": "lbl_01HXYZABCDEFGHJKMNPQRSTVWX",
          "name": "VIP"
        }
      ]
    }
  ],
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

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