---
title: "List Inbox"
method: GET
path: "/inbox"
tags: ["Inbox"]
---

# List Inbox

`GET /inbox`

## Request

- Base URL: `https://be.graph8.com/api/v1`
- URL: `https://be.graph8.com/api/v1/inbox`
- Auth: HTTP bearer

List inbox threads across email, SMS, and LinkedIn channels.

``status`` accepts ``SENT``, ``AI_RESPONDED`` or ``DRAFT`` (case-insensitive)
and is forwarded to the channel handler; an unknown value returns 422.

CAVEAT — ``assignee``: this cannot filter by an arbitrary email in this
layer. ``ChannelsService.get_channels`` only exposes ``assigned_to_me`` (a
boolean bound to the *caller's* identity), so the value is used purely as a
trigger to return the caller's own assigned threads — NOT threads assigned
to the requested email. For an org (machine) API key the caller identity is
the synthetic ``api-key@graph8.com``, which owns no threads, so the result
is effectively empty. A true per-assignee filter needs an ``assignee_email``
field on the shared ``ChannelRequest`` (out of scope for the dev-API layer).

## Query parameters

- `channel` 'email' | 'sms' | 'linkedin'
- `sequence_id` string, nullable: Filter by sequence (campaign) ID
- `status` string, nullable: Filter by status
- `assignee` string, nullable: Filter by assignee email
- `tag` string, nullable: Filter by tag ID
- `page` integer: Page number
- `page_size` integer: Items per page

## Headers

- `Authorization` string, nullable
- `X-Target-Org-Id` string, nullable

## Response `200`

Successful Response

- ApiResponseListInboxThreadResponse
  - `data` InboxThreadResponse[], required
    - `id` string, required
    - `channel` string, required
    - `subject` string, nullable
    - `contact` object, nullable: Contact snapshot: name, email, company
    - `messages` InboxMessageItem[]
      - `message_id` string, nullable
      - `from_address` string, nullable
      - `to_addresses` string[]
      - `content` string, nullable
      - `responder` string, nullable: USER, AI, or OTHER
      - `date` string, nullable
      - `is_draft` boolean
    - `status` string, nullable
    - `tags` object[]
    - `assignees` object[]
    - `created_at` string, nullable
    - `updated_at` string, nullable
    - `mailbox` string, nullable: Email: the connected mailbox this thread belongs to. A reply goes out from it by default, so pass it as `from_address` (or omit `from_address`) on POST /inbox/{id}/send.
    - `from_number` string, nullable: SMS: your number the thread runs on; the default `from_address` for an SMS reply.
    - `to_number` string, nullable: SMS: the contact's number; the default `to` for an SMS reply.
    - `linkedin_account_id` integer, nullable: LinkedIn: the sending account; the default `from_address` for a LinkedIn reply.
  - `pagination` PaginationMeta
    - `page` integer, required: Current page number (1-indexed)
    - `limit` integer, required: Items per page
    - `total` integer, required: Total number of items
    - `has_next` boolean, required: Whether there are more pages
    - `next_cursor` string, nullable: Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers.
    - `total_available` integer, nullable: Search endpoints only: how many records really match, when known. Can be larger than `total`, which is capped at the 10,000 results that can be paged. For company search this is a distinct-company estimate. Null when unknown; absent outside search.
    - `total_is_lower_bound` boolean, nullable: Search endpoints only: true when more records match than `total` shows (the result set is larger than the 10,000 results that can be paged). Absent outside search.
    - `notes` string[], nullable: Search endpoints only: plain-language notes about the result, e.g. that more records match than can be paged, or that a reversed `between` range was put in order.

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/graph8/apis/graph8-developer-api.md) · [All operations](https://skmtc.dev/graph8/apis/graph8-developer-api/llms.txt) · [OpenAPI document](https://skmtc.dev/graph8/apis/graph8-developer-api/revisions/2e7cfa0ca921?raw)
