API Reference/Endpoints
List all emails
GET/api/linkedin/gateway/emails
Pages through a connected account's mailbox, with filters for folder, sender, recipient, thread and a date range, plus free-text search across subject and body.
Authentication
Send your personal API key as a bearer token. A missing, malformed or revoked key returns 401.
Query parameters
FieldTypeDescription
account_id *stringThe connected account whose mailbox to read.
message_idstringRestrict to a single message.
thread_idstringRestrict to a single thread.
meta_onlybooleanSkip the body to get a faster, lighter response.
include_headersbooleanInclude raw headers on each item. Ignored when meta_only is set.
cursorstringPagination cursor from a previous page's response.
beforestringISO 8601 — only emails dated before this instant.
afterstringISO 8601 — only emails dated after this instant.
limitnumberPage size, 1–250.
searchstringFree-text match against subject and body.
any_emailstringComma-separated addresses — matches sender or any recipient.
tostringComma-separated recipient addresses.
fromstringSender address.
exclude_foldersstringComma-separated folder provider ids to leave out.
folderstringA single folder provider id to restrict to.
Response fields
FieldTypeDescription
object"EmailList"Always this value.
itemsarrayMatching emails, newest first. Each carries the fields shown alongside, plus a full HTML/plain body when the mailbox returns a full record rather than a summary.
cursorstring | nullPass to a follow-up call to fetch the next page; null once exhausted.
Some filter combinations aren't supported by every provider — Microsoft rejects search paired with several of the other filters, and IMAP mailboxes only search within a single folder at a time and evaluate date filters at day granularity.
Errors
·401 Unauthorized. The key is missing, malformed or has been rotated.·403 Forbidden. The account_id doesn't belong to this key.
