---
title: "List conversations in an inbox"
method: GET
path: "/inboxes/{inbox_id}"
tags: ["Inboxes"]
---

# List conversations in an inbox

`GET /inboxes/{inbox_id}`

## Request

- Base URL: `https://api.thrivedesk.com/v1`
- URL: `https://api.thrivedesk.com/v1/inboxes/{inbox_id}`
- Auth: HTTP bearer

List conversations in an inbox.

## Path parameters

- `inbox_id` string, required

## Query parameters

- `page` integer
- `per-page` integer
- `view` string

## Response `200`

Success.

- ConversationCollection
  - `data` Conversation[], required
    - `id` string
    - `inbox_id` string
    - `ticket_id` integer
    - `has_attachment` boolean
    - `has_inline_attachment` boolean
    - `is_draft` boolean
    - `is_scheduled` boolean
    - `is_snoozed` boolean
    - `active` boolean
    - `subject` string, nullable
    - `updated_subject` string, nullable
    - `status` 'Active' | 'Pending' | 'Closed'
    - `is_spam` boolean
    - `priority` 'High' | 'Medium' | 'Low'
    - `assignable_type` string, nullable: Polymorphic type of the assignee (a user or a team).
    - `assignable_id` string, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `deleted_at` string, date-time, nullable
    - `closed_at` string, date-time, nullable
    - `excerpt` string, nullable
    - `messages_count` integer, nullable
    - `last_message_created_at` string, date-time, nullable
    - `intended_inbox_address_id` string, nullable
    - `agents` string[]: IDs of agents assigned to the conversation.
    - `contact` Contact: A person who sends or receives messages.
      - `id` string
      - `name` string, nullable
      - `email` string, email
      - `avatar` string, uri, nullable
      - `company` string, nullable
      - `website` string, nullable
      - `job_title` string, nullable
      - `address` string, nullable
      - `should_display_image` boolean
      - `notes` string, nullable
      - `conversations_count` integer
    - `last_message` ConversationLastMessage: A compact view of the most recent message on a conversation.
      - `id` string
      - `cc` string[], nullable
      - `bcc` string[], nullable
      - `record_type` string
      - `status` string
      - `direction` string
      - `viewed_at` string, date-time, nullable
      - `created_at` string, date-time
      - `text_body` string, nullable
      - `excerpt` string, nullable
      - `html_body` string, nullable
      - `extra` object: Additional message metadata (free-form).
      - `is_clipped` boolean
      - `intended_inbox_address_id` string, nullable
    - `custom_field_values` object: Custom-field values keyed by field key (free-form).
    - `viewer_id` string, nullable
    - `viewed_at` string, nullable
    - `last_message_by` string, nullable
  - `links` PaginationLinks
    - `first` string, uri, nullable
    - `last` string, uri, nullable
    - `prev` string, uri, nullable
    - `next` string, uri, nullable
  - `meta` PaginationMeta: Standard (counting) paginator meta block.
    - `current_page` integer
    - `from` integer, nullable
    - `last_page` integer
    - `per_page` integer
    - `to` integer, nullable
    - `total` integer
    - `path` string, uri
    - `links` object[]: Rendered paginator links: the numbered pages plus the previous/next controls (whose `url` and `page` are null when unavailable).
      - `url` string, uri, nullable
      - `label` string
      - `page` integer, nullable
      - `active` boolean

## Other responses

- `401`: Missing or invalid bearer token.
- `403`: Token is valid but does not include a required scope, or the user does not have access to the resource.
- `404`: Resource not found.
- `422`: Request body failed validation.
- `429`: Rate limit exceeded. The `Retry-After` header indicates how long to wait before retrying. See [Pagination and rate limits](/get-started/pagination) for the full rate-limit policy.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/thrivedesk/apis/thrivedesk-public-api.md) - [All operations](https://skmtc.dev/thrivedesk/apis/thrivedesk-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/thrivedesk/apis/thrivedesk-public-api/revisions/dce9c632a018?raw)
