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

cursorstring

Opaque cursor from a previous response to fetch the next page

limitinteger

Maximum number of items to return per page (1–100, default 20)

querystring

Free-text search query to filter inboxes by email or display name

agentIdstring

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

OK

Changes

No recorded changes to this operation across all 1 revision of this API.