List emails

Messages in the token’s own mailboxes. The boundary is the employee’s addresses rather than the company’s: this returns mail sent to or from an address that employee owns, and nothing else. Somebody with no address gets an empty list rather than an error. `threadId` groups a back-and-forth, and the first message in a thread carries its own id there.

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

Query Parameters

Name	Type	Required	Description
`limit`	number	Optional	Maximum number of items to return (1-100).Default: `20`
`offset`	number	Optional	Number of items to skip before starting to collect the result set.Default: `0`
`sortBy`	string	Optional	Field to sort by. Allowed values vary by endpoint.Default: `createdAt`
`sortOrder`	string asc desc	Optional	Sort direction.Default: `desc`
`search`	string	Optional	Free-text search across the resource’s primary fields.
`createdAfter`	string	Optional	ISO 8601 timestamp — only return items created after this time.
`createdBefore`	string	Optional	ISO 8601 timestamp — only return items created before this time.
`updatedAfter`	string	Optional	ISO 8601 timestamp — only return items updated after this time.
`direction`	string INBOUND OUTBOUND	Optional	Received or sent.
`folder`	string	Optional	`inbox` for mail in its natural place; `archive`, `junk` or `trash` for the system folders; or a custom folder id.
`threadId`	string	Optional	One conversation, in full.
`unread`	boolean	Optional
`starred`	boolean	Optional	Set `true` for flagged mail.

GETExample request

curl

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

200Example response

json

{
  "message": "Emails retrieved successfully!",
  "content": {
    "emails": [
      {
        "id": "eml_3390",
        "from": "sam@acme.example",
        "to": "ap@northwind.example",
        "subject": "Invoice 1042",
        "text": "Attached is the invoice for phase one.",
        "html": null,
        "direction": "OUTBOUND",
        "threadId": "eml_3390",
        "unread": false,
        "starred": false,
        "folder": null,
        "accountId": "acc_7712",
        "createdAt": "2026-08-22T15:04:00.000Z",
        "updatedAt": "2026-08-22T15:04:00.000Z"
      }
    ],
    "pagination": {
      "total": 42,
      "limit": 20,
      "offset": 0,
      "hasMore": true
    }
  }
}

In the console

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

/email/inbox