Search the docs

Find a page, a section, or an endpoint.

Sign inGet started

mailboxes

Every mailboxes endpoint, generated from the API's own schemas.

List the folders of one mailbox

get/api/v1/mailboxes

The shape of a sidebar. `identity_id` is required — there is no cross-mailbox view, because merging the folders of several addresses would invent a mailbox nobody has.

Parameters

  • identity_idstringrequired

Responses

  • 200The folders.
  • 401No API key, or one that is not valid.
  • 404No such resource, **or** one belonging to another account. The two are deliberately indistinguishable: a different answer would enumerate what exists.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
bash
curl https://pidgeon.ai/api/v1/mailboxes \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json

List one folder

get/api/v1/mailboxes/{folder}

A row is a conversation — the newest message in each thread — not a message. Paged by an opaque `cursor`, which is the `next_cursor` of the page before it: it carries a sort key and an id together, because several messages can share a millisecond. Do not construct one.

Parameters

  • folderstringrequired
  • identity_iduuidrequired
  • limitnumber
  • cursorstring

Responses

  • 200A page of conversations.
  • 401No API key, or one that is not valid.
  • 404No such resource, **or** one belonging to another account. The two are deliberately indistinguishable: a different answer would enumerate what exists.
  • 429Rate limited. `X-RateLimit-Reset` says when to retry.
bash
curl https://pidgeon.ai/api/v1/mailboxes/{folder} \
  -H "Authorization: Bearer $PIDGEON_API_KEY"

Generated · public/openapi.json