get/email

Request

  • Base URL: https://api.useanima.sh/v1
  • URL: https://api.useanima.sh/v1/email
  • 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)

agentIdstring

Filter emails by agent ID

direction'INBOUND' | 'OUTBOUND'

Only return received (INBOUND) or sent (OUTBOUND) email

threadIdstring

Only return email in this thread (see GET /threads)

fromstring

Only return email whose sender address matches this value (case-insensitive, exact address match)

tostring

Only return email addressed to this recipient (case-insensitive). Matches if the address appears anywhere in the message's recipient list, not only as the first recipient.

afterstring date-time

Only return email created strictly after this ISO-8601 timestamp

beforestring date-time

Only return email created strictly before this ISO-8601 timestamp

labelsstring[]

Filter to messages carrying ALL of these labels (e.g. urgent + unread means urgent AND still unread). Case-insensitive. System labels: unread, read, archived, spam.

includeSpamboolean

Include messages classified as spam on arrival. They are excluded by default. Naming spam in labels also counts as asking for it, so a deliberate spam query is never silently emptied by this default.

includeArchivedboolean

Include messages carrying the archived label. They are excluded by default, so archiving actually removes mail from a listing rather than only tagging it. Naming archived in labels also counts as asking for it (and returns ONLY archived mail); use this flag instead to see archived mail mixed in with the rest.

Response

OK

Changes

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