List events

Lists the workspace’s events, newest first — every event, recorded when it happens, whether or not a webhook endpoint subscribes to its type. Each is the envelope a webhook delivers, with the same id, so a handler that deduplicates on it can read from here and from its endpoint alike. Filter by type, repeated for any of several, or by email_id for what happened to one email. To catch up after missed webhooks, walk forward: order=asc with after set to the created_at of the last event you processed. data is the summary every endpoint receives; the data.email a full endpoint is sent is read when a delivery goes out and not kept, so read the email by its email_id. Test events sent to an endpoint are not listed.

GET/events

Authorization

AuthorizationBearer token (API key) · headerrequired

Pass an AI Inbx API key as a Bearer token.

Query parameters

limitinteger

Maximum number of resources to return.

min 1 · max 100 · default: 40

cursorstring

Opaque cursor from the previous page.

min length 1

spacestring

Only resources in this space. Pass `none` for resources that belong to the workspace itself (`space_id: null`), or omit for the workspace and all its spaces.

matches ^(?:none|spc_[0-9a-f]{32})$

afterstring<date-time>

Only what was created after this instant — `created_at` later than it, the instant itself left out. ISO 8601 with an offset.

beforestring<date-time>

Only what was created before this instant — `created_at` earlier than it, the instant itself left out. ISO 8601 with an offset.

orderstring

Which way the list is walked by `created_at`: `desc` is newest first, `asc` oldest first — the order a sync reads in. A cursor is a position, not a direction: send the same `order` with it.

default: "desc"

Allowed:ascdesc

typestring[]

Only events of this type. Repeat the parameter for any of several: `type=email.bounced&type=email.failed`.

email_idstring

Only events about this email: received or sent, delivered, bounced, complained, failed, opened, clicked. `email.unsubscribed` is about the address that left, and is not among them.

matches ^eml_[0-9a-f]{32}$

Responses

200Success.

dataobject[]required

Show properties

Array of object

One of:

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

fromstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

tostring<email>[]required

subjectstringrequired

snippetstringrequired

attachmentsobject[]

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

filenamestringrequired

content_typestringrequired

sizeintegerrequired

min 0 · max 9007199254740991

preparationstringrequired

Allowed:readypartialunsupportedfailed

emailobject | any

Only on an endpoint whose `payload` is `full`: the email, exactly as `GET /emails/{id}?include=attachment_content` returns it. Read when the delivery is sent, so a retry carries freshly signed URLs. Null when it could not be included — the message no longer exists, or the body would pass 4 MB with it; read the email by `email_id` instead.

Show properties

Any of:

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

directionstringrequired

Allowed:inboundoutbound

statusstringrequired

Allowed:scheduledcanceledqueuedsendingsentdeliveredbouncedcomplainedfailedreceived

fromobjectrequired

Show properties

namestring | any

Show properties

Any of:

string

string

any

any

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

tostring<email>[]required

ccstring<email>[]required

bccstring<email>[]required

reply_tostring<email>[]required

subjectstringrequired

snippetstringrequired

htmlstring | anyrequired

Show properties

Any of:

string

string

any

any

textstring | anyrequired

Show properties

Any of:

string

string

any

any

categorystring | anyrequired

Show properties

Any of:

string

string

any

any

verdictsobject | anyrequired

Show properties

Any of:

object

spamstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

spfstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

dkimstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

dmarcstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

message_idstringrequired

The RFC Message-ID, without angle brackets.

in_reply_tostring | anyrequired

The Message-ID of the message this one answers, without angle brackets. Null when it answers none.

Show properties

Any of:

string

string

any

any

idempotency_keystring | anyrequired

Show properties

Any of:

string

string

any

any

created_atstring<date-time>required

scheduled_atstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

sent_atstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

attachmentsobject[]required

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

filenamestringrequired

content_typestringrequired

sizeintegerrequired

min 0 · max 9007199254740991

cidstring | anyrequired

Show properties

Any of:

string

string

any

any

download_urlstring<uri> | anyrequired

Signed URL for the original bytes, good until `expires_at`. Opens without the API key, so treat it as a secret — and do not send the key to it: storage answers a request that carries an `Authorization` header with 400. To keep a reference, store the attachment `id` and call `GET /attachments/{id}`. Null when the bytes are gone.

Show properties

Any of:

string<uri>

string<uri>

any

any

expires_atstring<date-time> | anyrequired

When `download_url` and `preparation.content_url` stop working — an hour after the response. Read the email again, or call the download endpoint with the attachment ID, for fresh ones.

Show properties

Any of:

string<date-time>

string<date-time>

any

any

preparationobject | anyrequired

Show properties

Any of:

object

statusstringrequired

Allowed:readypartialunsupportedfailed

formatstring | anyrequired

Show properties

Any of:

string

string

any

any

pagesinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

warningsstring[]required

content_urlstring<uri> | anyrequired

Signed URL for the prepared text, good until the attachment's `expires_at`. Opens without the API key — and only without it: storage answers a request that carries an `Authorization` header with 400. Null when there is no prepared text.

Show properties

Any of:

string<uri>

string<uri>

any

any

textstring | any

Show properties

Any of:

string

string

any

any

any

any

stripped_textstring | anyrequired

What this message says: typed text only, quoted conversation and signature removed. A signature the thread has not seen from this sender stays — it is where the name and role are.

Show properties

Any of:

string

string

any

any

stripped_htmlstring | anyrequired

The HTML part with the same cut as stripped_text: quoted conversation and repeated signature removed, an answer typed into the quote kept under the line it answers. Null when the message has no HTML part or its markup could not be matched to the cut.

Show properties

Any of:

string

string

any

any

segmentsobject[]required

Show properties

Array of object

kindstringrequired

Allowed:writtenquotedsignature

textstringrequired

referencesstring[]required

The Message-IDs of the conversation so far, oldest first, without angle brackets.

headersobject[]required

Show properties

Array of object

namestringrequired

valuestringrequired

eventsobject[]required

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

Allowed:scheduledcanceledqueuedreplayedsentdelivereddeferredbouncedcomplainedfailed

atstring<date-time>required

recipientstring<email> | anyrequired

Show properties

Any of:

string<email>

string<email>

any

any

detailstring | anyrequired

Show properties

Any of:

string

string

any

any

engagementsobject[]required

Show properties

Array of object

kindstringrequired

Allowed:openclick

atstring<date-time>required

urlstring<uri> | anyrequired

Show properties

Any of:

string<uri>

string<uri>

any

any

user_agentstring | anyrequired

Show properties

Any of:

string

string

any

any

botbooleanrequired

True when a proxy, security scanner or script made the hit rather than the recipient.

bot_reasonstring | anyrequired

Why: `privacy_proxy` is Apple Mail Privacy Protection fetching on arrival, `script` an HTTP library, `known_bot` a scanner or link expander that names itself, `stale_browser` a browser build nobody runs any more, `too_fast` within seconds of delivery, sooner than a person could act. Null when `bot` is false. More reasons may be added; treat one you do not know as a bot.

Show properties

Any of:

string

string

any

any

any

any

categorystring | anyrequired

Show properties

Any of:

string

string

any

any

verdictsobject | anyrequired

Show properties

Any of:

object

spamstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

spfstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

dkimstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

dmarcstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

fromstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

tostring<email>[]required

subjectstringrequired

snippetstringrequired

attachmentsobject[]

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

filenamestringrequired

content_typestringrequired

sizeintegerrequired

min 0 · max 9007199254740991

preparationstringrequired

Allowed:readypartialunsupportedfailed

emailobject | any

Show properties

Any of:

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

directionstringrequired

Allowed:inboundoutbound

statusstringrequired

Allowed:scheduledcanceledqueuedsendingsentdeliveredbouncedcomplainedfailedreceived

fromobjectrequired

Show properties

namestring | any

Show properties

Any of:

string

string

any

any

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

tostring<email>[]required

ccstring<email>[]required

bccstring<email>[]required

reply_tostring<email>[]required

subjectstringrequired

snippetstringrequired

htmlstring | anyrequired

Show properties

Any of:

string

string

any

any

textstring | anyrequired

Show properties

Any of:

string

string

any

any

categorystring | anyrequired

Show properties

Any of:

string

string

any

any

verdictsobject | anyrequired

Show properties

Any of:

object

spamstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

spfstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

dkimstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

dmarcstring | anyrequired

`PASS`, `FAIL`, `GRAY` or `PROCESSING_FAILED`. Null when this check was not reported.

Show properties

Any of:

string

string

any

any

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

message_idstringrequired

The RFC Message-ID, without angle brackets.

in_reply_tostring | anyrequired

The Message-ID of the message this one answers, without angle brackets. Null when it answers none.

Show properties

Any of:

string

string

any

any

idempotency_keystring | anyrequired

Show properties

Any of:

string

string

any

any

created_atstring<date-time>required

scheduled_atstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

sent_atstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

attachmentsobject[]required

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

filenamestringrequired

content_typestringrequired

sizeintegerrequired

min 0 · max 9007199254740991

cidstring | anyrequired

Show properties

Any of:

string

string

any

any

download_urlstring<uri> | anyrequired

Show properties

Any of:

string<uri>

string<uri>

any

any

expires_atstring<date-time> | anyrequired

When `download_url` and `preparation.content_url` stop working — an hour after the response. Read the email again, or call the download endpoint with the attachment ID, for fresh ones.

Show properties

Any of:

string<date-time>

string<date-time>

any

any

preparationobject | anyrequired

Show properties

Any of:

object

statusstringrequired

Allowed:readypartialunsupportedfailed

formatstring | anyrequired

Show properties

Any of:

string

string

any

any

pagesinteger | anyrequired

Show properties

Any of:

integer

integer

any

any

warningsstring[]required

content_urlstring<uri> | anyrequired

Show properties

Any of:

string<uri>

string<uri>

any

any

textstring | any

Show properties

Any of:

string

string

any

any

any

any

stripped_textstring | anyrequired

What this message says: typed text only, quoted conversation and signature removed. A signature the thread has not seen from this sender stays — it is where the name and role are.

Show properties

Any of:

string

string

any

any

stripped_htmlstring | anyrequired

Show properties

Any of:

string

string

any

any

segmentsobject[]required

Show properties

Array of object

kindstringrequired

Allowed:writtenquotedsignature

textstringrequired

referencesstring[]required

The Message-IDs of the conversation so far, oldest first, without angle brackets.

headersobject[]required

Show properties

Array of object

namestringrequired

valuestringrequired

eventsobject[]required

Show properties

Array of object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

Allowed:scheduledcanceledqueuedreplayedsentdelivereddeferredbouncedcomplainedfailed

atstring<date-time>required

recipientstring<email> | anyrequired

Show properties

Any of:

string<email>

string<email>

any

any

detailstring | anyrequired

Show properties

Any of:

string

string

any

any

engagementsobject[]required

Show properties

Array of object

kindstringrequired

Allowed:openclick

atstring<date-time>required

urlstring<uri> | anyrequired

Show properties

Any of:

string<uri>

string<uri>

any

any

user_agentstring | anyrequired

Show properties

Any of:

string

string

any

any

botbooleanrequired

True when a proxy, security scanner or script made the hit rather than the recipient.

bot_reasonstring | anyrequired

Show properties

Any of:

string

string

any

any

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

recipientsstring<email>[]required

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

recipientsstring<email>[]required

permanentbooleanrequired

reasonstringrequired

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

recipientsstring<email>[]required

reasonstring | anyrequired

Show properties

Any of:

string

string

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

reasonstringrequired

What the provider said: why the message never went out.

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

message_idstring | anyrequired

Show properties

Any of:

string

string

any

any

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

keystringrequired

scopestringrequired

Allowed:alloptional

sourcestringrequired

Allowed:linkone_clickreply

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

user_agentstring | anyrequired

Show properties

Any of:

string

string

any

any

botbooleanrequired

True when a proxy, security scanner or script made the hit rather than the recipient.

bot_reasonstring | anyrequired

Show properties

Any of:

string

string

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

email_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

message_idstringrequired

The RFC Message-ID, without angle brackets.

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

domain_idstring | anyrequired

Show properties

Any of:

string

string

any

any

mailbox_idstring | anyrequired

Show properties

Any of:

string

string

any

any

suppression_keystring | anyrequired

Show properties

Any of:

string

string

any

any

urlstring<uri>required

user_agentstring | anyrequired

Show properties

Any of:

string

string

any

any

botbooleanrequired

True when a proxy, security scanner or script made the hit rather than the recipient.

bot_reasonstring | anyrequired

Show properties

Any of:

string

string

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

thread_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

subjectstringrequired

mailboxstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

forward_ofstring | anyrequired

Set when a forward opened the thread: the conversation it carries.

Show properties

Any of:

string

string

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

domain_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

namestringrequired

regionstringrequired

Allowed:eu-central-1us-east-1

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

domain_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

namestringrequired

regionstringrequired

Allowed:eu-central-1us-east-1

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

mailbox_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

providerstringrequired

Allowed:googlemicrosoft

refstring | anyrequired

Show properties

Any of:

string

string

any

any

metadataobjectrequired

Your own key-value pairs, stored and given back as they are. Up to 50 keys; a key is 1–40 characters, a value up to 500. Written whole: what you send replaces what was there.

app_idstring | anyrequired

Show properties

Any of:

string

string

any

any

reconnectedbooleanrequired

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

mailbox_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

providerstringrequired

Allowed:googlemicrosoft

refstring | anyrequired

Show properties

Any of:

string

string

any

any

metadataobjectrequired

Your own key-value pairs, stored and given back as they are. Up to 50 keys; a key is 1–40 characters, a value up to 500. Written whole: what you send replaces what was there.

reasonstring | anyrequired

Show properties

Any of:

string

string

any

any

object

idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

typestringrequired

created_atstring<date-time>required

space_idstring | anyrequired

Which space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.

Show properties

Any of:

string

string

any

any

dataobjectrequired

Show properties

mailbox_idstringrequired

matches ^[a-z]+_[0-9a-f]{32}$

addressstring<email>required

matches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

providerstringrequired

Allowed:googlemicrosoft

refstring | anyrequired

Show properties

Any of:

string

string

any

any

metadataobjectrequired

Your own key-value pairs, stored and given back as they are. Up to 50 keys; a key is 1–40 characters, a value up to 500. Written whole: what you send replaces what was there.

reasonstring | anyrequired

Show properties

Any of:

string

string

any

any

next_cursorstring | anyrequired

Show properties

Any of:

string

string

any

any

400The request is invalid.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

401The API key is missing or invalid.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

403The API key does not have the required scope.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

404The requested resource does not exist.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

409The request conflicts with the resource's current state.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

413The request body or attachments are too large.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

415The request body is not JSON.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

422The request body failed validation.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

429The organisation's request budget is spent (`too_many_requests`), or an upstream mail provider is throttling (`rate_limited`).

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

500An internal error occurred.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

502An upstream mail provider failed.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

503The service is temporarily unavailable.

typestringrequired

titlestringrequired

statusintegerrequired

min -9007199254740991 · max 9007199254740991

detailstringrequired

codestringrequired

request_idstringrequired

issuesobject[]

Show properties

Array of object

pathstringrequired

messagestringrequired

Request

curl -X GET "https://api.aiinbx.com/api/v2/events" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.aiinbx.com/api/v2/events", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "https://api.aiinbx.com/api/v2/events",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "data": [
    {
      "id": "string",
      "type": "email.received",
      "created_at": "2019-08-24T14:15:22Z",
      "space_id": "string",
      "data": {
        "email_id": "string",
        "message_id": "string",
        "thread_id": "string",
        "domain_id": "string",
        "mailbox_id": "string",
        "from": "user@example.com",
        "to": [
          "user@example.com"
        ],
        "subject": "string",
        "snippet": "string",
        "attachments": [
          {
            "id": "string",
            "filename": "string",
            "content_type": "string",
            "size": 9007199254740991,
            "preparation": "ready"
          }
        ],
        "email": {
          "id": "string",
          "thread_id": "string",
          "space_id": "string",
          "direction": "inbound",
          "status": "scheduled",
          "from": {
            "name": "string",
            "address": "user@example.com"
          },
          "to": [
            "user@example.com"
          ],
          "cc": [
            "user@example.com"
          ],
          "bcc": [
            "user@example.com"
          ],
          "reply_to": [
            "user@example.com"
          ],
          "subject": "string",
          "snippet": "string",
          "html": "string",
          "text": "string",
          "category": "human",
          "verdicts": {
            "spam": "string",
            "spf": "string",
            "dkim": "string",
            "dmarc": "string"
          },
          "suppression_key": "string",
          "message_id": "string",
          "in_reply_to": "string",
          "idempotency_key": "string",
          "created_at": "2019-08-24T14:15:22Z",
          "scheduled_at": "2019-08-24T14:15:22Z",
          "sent_at": "2019-08-24T14:15:22Z",
          "attachments": [
            {
              "id": "string",
              "filename": "string",
              "content_type": "string",
              "size": 9007199254740991,
              "cid": "string",
              "download_url": "http://example.com",
              "expires_at": "2019-08-24T14:15:22Z",
              "preparation": {
                "status": "ready",
                "format": "markdown",
                "pages": -9007199254740991,
                "warnings": [
                  "string"
                ],
                "content_url": "http://example.com",
                "text": "string"
              }
            }
          ],
          "stripped_text": "string",
          "stripped_html": "string",
          "segments": [
            {
              "kind": "written",
              "text": "string"
            }
          ],
          "references": [
            "string"
          ],
          "headers": [
            {
              "name": "string",
              "value": "string"
            }
          ],
          "events": [
            {
              "id": "string",
              "type": "scheduled",
              "at": "2019-08-24T14:15:22Z",
              "recipient": "user@example.com",
              "detail": "string"
            }
          ],
          "engagements": [
            {
              "kind": "open",
              "at": "2019-08-24T14:15:22Z",
              "url": "http://example.com",
              "user_agent": "string",
              "bot": true,
              "bot_reason": "privacy_proxy"
            }
          ]
        },
        "category": "human",
        "verdicts": {
          "spam": "string",
          "spf": "string",
          "dkim": "string",
          "dmarc": "string"
        }
      }
    }
  ],
  "next_cursor": "string"
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

{
  "type": "string",
  "title": "string",
  "status": -9007199254740991,
  "detail": "string",
  "code": "string",
  "request_id": "string",
  "issues": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}