API Reference/Endpoints

List email folders

GET/api/linkedin/gateway/folders

Lists a connected mailbox's folders, along with each one's role (inbox, sent, trash, and so on) and message count.

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 folders to list.

Response fields

FieldTypeDescription

object"FolderList"Always this value.

itemsarrayEach folder: id, name, account_id, role, nb_mails and provider_id.

Errors

·401 Unauthorized. The key is missing, malformed or has been rotated.·403 Forbidden. The account_id doesn't belong to this key.

{ "object": "FolderList", "items": [ { "object": "Folder", "id": "2a6e9d14-7c3b-4f80-9e21-6b4a1d8f2c05", "name": "INBOX", "account_id": "459993d2-b0e7-4b19-baf9-45252ca324cf", "role": "inbox", "nb_mails": 412, "provider_id": "INBOX" } ] }