List emails
Lists emails in the workspace, newest first. Filter by direction, delivery status, a single thread_id, or a literal query over subjects and addresses. The query is a literal filter; the API does not provide semantic email search.
GET
/emailsAuthorization
AuthorizationBearer token (API key) · headerrequiredPass an AI Inbx API key as a Bearer token.
Query parameters
limitintegerMaximum number of resources to return.
min 1 · max 100 · default: 40
cursorstringOpaque cursor from the previous page.
min length 1
spacestringOnly 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})$
directionstringFilter by message direction.
Allowed:
inboundoutboundstatusstringFilter by delivery status.
Allowed:
scheduledcanceledqueuedsendingsentdeliveredbouncedcomplainedfailedreceivedthread_idstringFilter to one thread.
matches ^thr_[0-9a-f]{32}$
querystringSearch subjects and addresses.
max length 320
Responses
200Success.
dataobject[]requiredShow propertiesHide properties
Array of
objectidstringrequiredmatches ^[a-z]+_[0-9a-f]{32}$
thread_idstringrequiredmatches ^[a-z]+_[0-9a-f]{32}$
space_idstring | anyrequiredWhich space a resource is in. Null is the workspace itself — what every resource of a workspace that has no spaces says.
Show propertiesHide properties
Any of:
string
stringany
anydirectionstringrequiredAllowed:
inboundoutboundstatusstringrequiredAllowed:
scheduledcanceledqueuedsendingsentdeliveredbouncedcomplainedfailedreceivedfromobjectrequiredShow propertiesHide properties
namestring | anyShow propertiesHide properties
Any of:
string
stringany
anyaddressstring<email>requiredmatches ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
tostring<email>[]requiredccstring<email>[]bccstring<email>[]reply_tostring<email>[]subjectstringrequiredsnippetstringrequiredhtmlstring | anyShow propertiesHide properties
Any of:
string
stringany
anytextstring | anyShow propertiesHide properties
Any of:
string
stringany
anycategorystring | anyrequiredShow propertiesHide properties
Any of:
string
stringany
anysuppression_keystring | anyrequiredShow propertiesHide properties
Any of:
string
stringany
anymessage_idstringrequiredin_reply_tostring | anyrequiredShow propertiesHide properties
Any of:
string
stringany
anyidempotency_keystring | anyrequiredShow propertiesHide properties
Any of:
string
stringany
anycreated_atstring<date-time>requiredmatches ^(?:(?:\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))$
scheduled_atstring<date-time> | anyrequiredShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anysent_atstring<date-time> | anyrequiredShow propertiesHide properties
Any of:
string<date-time>
string<date-time>any
anyattachmentsobject[]Show propertiesHide properties
Array of
objectidstringrequiredmatches ^[a-z]+_[0-9a-f]{32}$
filenamestringrequiredcontent_typestringrequiredsizeintegerrequiredmin 0 · max 9007199254740991
cidstring | anyrequiredShow propertiesHide properties
Any of:
string
stringany
anydownload_urlstring<uri>requiredpreparationobject | anyrequiredShow propertiesHide properties
Any of:
object
statusstringrequiredAllowed:
readypartialunsupportedfailedformatstring | anyrequiredShow propertiesHide properties
Any of:
string
stringany
anypagesinteger | anyrequiredShow propertiesHide properties
Any of:
integer
integerany
anywarningsstring[]requiredcontent_urlstring<uri> | anyrequiredShow propertiesHide properties
Any of:
string<uri>
string<uri>any
anytextstring | anyShow propertiesHide properties
Any of:
string
stringany
anyany
anynext_cursorstring | anyrequiredShow propertiesHide properties
Any of:
string
stringany
any400The request is invalid.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired401The API key is missing or invalid.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired403The API key does not have the required scope.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired404The requested resource does not exist.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired409The request conflicts with the resource's current state.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired413The request body or attachments are too large.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired415The request body is not JSON.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired422The request body failed validation.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired429The organisation's request budget is spent (`too_many_requests`), or an upstream mail provider is throttling (`rate_limited`).
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired500An internal error occurred.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired502An upstream mail provider failed.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired503The service is temporarily unavailable.
typestringrequiredtitlestringrequiredstatusintegerrequiredmin -9007199254740991 · max 9007199254740991
detailstringrequiredcodestringrequiredrequest_idstringrequiredissuesobject[]Show propertiesHide properties
Array of
objectpathstringrequiredmessagestringrequired