List email folders

The custom mail folders the company has made. The three system folders — `archive`, `junk` and `trash` — are not rows here; they are literal values on a message’s `folder`. Anything in this list is referenced by its id instead.

Required scope

The access token must carry this scope. A token missing it gets 403 Forbidden. Grant them to an API client under Settings → Company → API, and to a teammate under Employee → Permissions.

email:messages:read

GETExample request

curl

curl -X GET "https://www.pxb.app/api/public/v1/email-folders" \
  -H "Authorization: Bearer your_access_token"

200Example response

json

{
  "message": "Email folders retrieved successfully!",
  "content": {
    "folders": [
      {
        "id": "efd_11",
        "name": "Suppliers"
      }
    ]
  }
}

In the console

The same thing done by hand, for anyone comparing the API against the screen they already use.

Email → Folders

/email/inbox