Messages

List messages

List messages for the WhatsApp account identified by phone_number_id. Filter by conversation_id, direction, status, or a created_after/created_before window.

get/{phone_number_id}/messages

Request

  • Base URL: https://api.kirimdev.com/v1
  • URL: https://api.kirimdev.com/v1/{phone_number_id}/messages
  • 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

conversation_idstring

Return messages from one public inbox conversation. Unknown or cross-account IDs produce an empty list.

Example:cnv_01HXYZABCDEFGHJKMNPQRSTVWX
direction'inbound' | 'outbound'

Filter messages received from contacts (inbound) or sent by your business (outbound).

Example:inbound
status'pending' | 'sent' | 'delivered' | 'read' | 'failed'

Filter by the latest persisted delivery state.

Example:delivered
created_afterstring date-time

Return messages created strictly after this ISO 8601 instant.

Example:2026-09-10T00:00:00.000Z
created_beforestring date-time

Return messages created strictly before this ISO 8601 instant.

Example:2026-09-11T00: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

Message 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": "msg_01HXYZABCDEFGHJKMNPQRSTVWX",
      "unsupported": {
        "type": "edit"
      }
    }
  ],
  "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
}

Changes

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