Skip to content
Kirim Docs
Messages

List messages

GET
/messages
 
curl --request GET \
  --url 'https://api-kckit.kirim.chat/v1/messages?direction=inbound&status=pending' \
  --header 'Authorization: Bearer <token>'

List messages across the organization. Filter by conversation_id, direction, status, or a created_after/created_before window.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
conversation_id
string
/^cnv_[0-9A-HJKMNP-TV-Z]{26}$/
direction
string
Allowed values: inbound outbound
status
string
Allowed values: pending sent delivered read failed
created_after
string format: date-time
created_before
string format: date-time
limit
string
/^\d+$/
cursor
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Message list

Media type application/json
object
data
required
Array<object>
object
id
required
string
object
required
string
Allowed values: message
conversation_id
required
string
to
required
string | null
direction
required
string
Allowed values: inbound outbound
type
required
string
content
required
string | null
media_url
required
string | null
status
required
string
Allowed values: pending sent delivered read failed
created_at
required
string format: date-time
error
object
code
required
string
message
required
string
provider_code
required
number | null
has_more
required
boolean
next_cursor
required
string | null
request_id
required
string
Example 
{
  "data": [
    {
      "id": "msg_01HXYZABCDEFGHJKMNPQRSTVWX",
      "object": "message",
      "direction": "inbound",
      "status": "pending"
    }
  ]
}

400

Section titled “400 ”

Validation failure

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

401

Section titled “401 ”

Authentication failure

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

429

Section titled “429 ”

Rate limit exceeded

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}

500

Section titled “500 ”

Internal server error

Media type application/json
object
error
required
object
type
required
string
code
required
string
message
required
string
param
string
request_id
required
string
Example 
{
  "error": {
    "type": "invalid_request_error",
    "code": "invalid_phone_number",
    "request_id": "req_01HXYZABCDEFGHJKMNPQRSTVWX"
  }
}