---
title: "GET /inboxes"
method: GET
path: "/inboxes"
---

# GET /inboxes

`GET /inboxes`

## Request

- Base URL: `https://api.useanima.sh/v1`
- URL: `https://api.useanima.sh/v1/inboxes`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

## Query parameters

- `cursor` string: Opaque cursor from a previous response to fetch the next page
- `limit` integer: Maximum number of items to return per page (1–100, default 20)
- `query` string: Free-text search query to filter inboxes by email or display name
- `agentId` string: Filter to the inboxes belonging to one agent. Omit for every inbox in the org, including unassigned ones — an inbox's agent is nullable, and deleting an agent leaves its inboxes behind rather than removing them.

## Response `200`

OK

- object: Paginated list of inboxes
  - `items` object[], required: Array of inbox resources matching the query
    - `id` string, required: Unique identifier of the inbox
    - `email` string, email, required: Full email address of the inbox
    - `domain` string, required: Domain portion of the inbox email address
    - `localPart` string, required: Local part (before the @) of the inbox email address
    - `displayName` string, nullable, required: Human-readable display name, or null if not set
    - `agentId` string, required: ID of the agent this inbox belongs to
    - `createdAt` string, date-time, required: Timestamp when the inbox was created
    - `agentName` string, required: Name of the agent that owns this inbox
    - `unreadCount` integer, required: Unread messages in this inbox — inbound mail carrying the `unread` label, excluding spam, archived and trashed. The number a mailbox list has to show to be worth reading at all.
    - `lastMessageAt` string, date-time, nullable, required: When this inbox last sent or received anything, or null if it never has
  - `pagination` object, required: Pagination metadata for retrieving additional pages
    - `nextCursor` string, nullable, required: Cursor to pass as the `cursor` parameter to retrieve the next page, or null if no more results
    - `hasMore` boolean, required: Whether additional pages of results are available

---

[API](https://skmtc.dev/useanima/apis/anima-api.md) · [All operations](https://skmtc.dev/useanima/apis/anima-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useanima/apis/anima-api/revisions/aaa148188980?raw)