Messages

List messages

Lists messages in an inbox. Tracking fields (firstOpenedAt, openCount, firstClickedAt, clickCount, etc.) are returned on every row — no separate detail fetch needed for an engagement-aware view. Each row also carries a ~200-char plain-body snippet for triage without fetching the full message. Filters can be combined.

Every row carries labels, isSpam and, for sent mail, deliveryStatus and deliveredAt. Spam is left out unless includeSpam=true.

get/v1/inboxes/{id}/messages

Request

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

Query parameters

limitinteger
offsetinteger
labelsstring

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

includeSpamboolean

Spam is stored but left out by default. Pass true to include it (include_spam also works).

direction'inbound' | 'outbound'
openedboolean

When true, return only messages with open_count > 0.

clickedboolean

When true, return only messages with click_count > 0. Useful for cadence engines listing engaged leads who haven't yet replied.

engagedSincestring date-time

ISO-8601 timestamp. Returns only messages whose lastOpenedAt OR lastClickedAt is at or after this time. Use for incremental polling — pass the timestamp of your last successful sync.

Response

OK

Example response

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

Changes

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