API Reference/Endpoints

Retrieve an email folder

GET/api/linkedin/gateway/folders/{folder_id}

Fetches a single mailbox folder by id.

Authentication

Send your personal API key as a bearer token. A missing, malformed or revoked key returns 401.

Path parameters

FieldTypeDescription

folder_id *stringThe folder's id.

Query parameters

FieldTypeDescription

account_id *stringThe connected account the folder belongs to.

Response fields

FieldTypeDescription

object"Folder"Always this value.

idstringThe folder's id.

namestringThe folder's display name.

rolestringOne of inbox, sent, archive, drafts, trash, spam, all, important, starred, unknown.

nb_mailsnumberMessage count in the folder.

provider_idstringThe mailbox provider's own id for this folder.

Errors

·401 Unauthorized. The key is missing, malformed or has been rotated.·403 Forbidden. The account_id doesn't belong to this key.·404 Not Found. No folder with that id belongs to this account.

{ "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" }