---
title: "List Messages"
method: GET
path: "/api/v1/imessage/messages"
tags: ["iMessage"]
---

# List Messages

`GET /api/v1/imessage/messages`

## Query parameters

- `agent_identity_id` string, uuid, nullable
- `conversation_id` string, uuid, nullable
- `include_groups` boolean
- `limit` integer
- `offset` integer
- `is_read` boolean, nullable
- `is_blocked` boolean, nullable
- `start_datetime` string, nullable — Filter created_at >= this date/datetime. Bare date => whole day in tz.
- `end_datetime` string, nullable — Filter created_at <= this date/datetime. Bare date => whole day inclusive.
- `tz` string, nullable — IANA zone (e.g. America/New_York) for zone-less values; default UTC.

## Response `200`

Successful Response

- IMessageMessageResponse[]
  - `provider_message_handle` string, nullable
  - `id` string, uuid, required
  - `conversation_id` string, uuid, required
  - `assignment_id` string, uuid, nullable, required
  - `direction` 'inbound' | 'outbound', required
  - `remote_number` string, nullable, required
  - `sender_number` string, nullable
  - `participants` string[], nullable
  - `is_group` boolean
  - `content` string, nullable
  - `message_type` 'message' | 'carousel', required
  - `service` 'imessage' | 'sms' | 'rcs', required
  - `send_style` 'celebration' | 'shooting_star' | 'fireworks' | 'lasers' | 'love' | 'confetti' | 'balloons' | 'spotlight' | 'echo' | 'invisible' | 'gentle' | 'loud' | 'slam'
  - `media` IMessageMediaItem[], nullable
    - `content_type` string, nullable
    - `size` integer, nullable
    - `url` string, required
  - `was_downgraded` boolean, nullable
  - `status` 'registered' | 'pending' | 'queued' | 'accepted' | 'sent' | 'delivered' | 'declined' | 'error' | 'received'
  - `error_code` string, nullable
  - `error_message` string, nullable
  - `error_reason` string, nullable
  - `error_detail` string, nullable
  - `is_read` boolean, required
  - `is_blocked` boolean
  - `recipients` IMessageRecipientResponse[], nullable
    - `remote_number` string, required
    - `delivery_status` 'registered' | 'pending' | 'queued' | 'accepted' | 'sent' | 'delivered' | 'declined' | 'error' | 'received'
    - `service` 'imessage' | 'sms' | 'rcs'
    - `error_code` string, nullable
    - `error_message` string, nullable
    - `error_reason` string, nullable
    - `error_detail` string, nullable
    - `sent_at` string, date-time, nullable
    - `delivered_at` string, date-time, nullable
    - `failed_at` string, date-time, nullable
  - `reactions` IMessageMessageReaction[], nullable
    - `id` string, uuid, required
    - `direction` 'inbound' | 'outbound', required
    - `reaction` 'love' | 'like' | 'dislike' | 'laugh' | 'emphasize' | 'question' | 'eyes' | 'custom', required
    - `custom_emoji` string, nullable
    - `remote_number` string, required
    - `part_index` integer
    - `created_at` string, date-time, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422` — Validation Error
- `4XX` — Client error with Support Agent information.
- `5XX` — Server error with Support Agent information.

---

[API](https://skmtc.dev/inkbox/apis/inkbox-api.md) · [All operations](https://skmtc.dev/inkbox/apis/inkbox-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/inkbox/inkbox-api/revisions/31f357e7e6f8/schema)
