Messages

List messages across inboxes

One list across every inbox the key can see (tenant, workspace, inbox or teammate scope). ?labels=a,b returns messages carrying every label; with group=thread it matches whole threads (a thread matches when any of its messages carries the labels) and each row carries the thread's labels.

get/v1/messages

Request

  • Base URL: https://anjal.app
  • URL: https://anjal.app/v1/messages
  • Auth: API key in header X-API-Key

Query parameters

folder'inbox' | 'sent' | 'starred' | 'archived' | 'spam' | 'trash'
group'thread'

thread returns one row per thread (its latest message).

inboxIdstring uuid
labelsstring

Comma-separated labels, e.g. needs-review,billing. Only results carrying every one are returned.

limitinteger
offsetinteger

Response

OK

Example response

{
  "messages": [
    {
      "attachments": [
        {
          "contentType": "application/pdf"
        }
      ]
    }
  ]
}

Changes

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