Sign in
Mailboxes

Get a mailbox

Changed on

Returns a single mailbox, tenant-scoped to the caller's team. Responses carry a weak ETag header — send it back as If-None-Match on the next request and the server will return 304 Not Modified (no body) when the resource has not changed. The same ETag is the value to use in If-Match on PATCH for optimistic concurrency.

get/mailboxes/{public_id}

Request

  • Base URL: https://app.sendmux.ai/api/v1
  • URL: https://app.sendmux.ai/api/v1/mailboxes/{public_id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.sendmux.ai/oauth/authorize, token URL https://app.sendmux.ai/oauth/token, scopes: mailbox.admin.read)

Path parameters

public_idstring required

Mailbox public ID

Headers

If-None-Matchstring

Weak ETag from a previous response. Returns 304 when unchanged.

Response

Mailbox

oktrue required

Example response

{
  "meta": {
    "request_id": "req_clxxxxxxxxxxxxxxxxxxxxxxxxx"
  },
  "data": {
    "email": "agent@acme.com",
    "id": "mbx_clxxxxxxxxxxxxxxxxxxxxxxxxx",
    "status": "active"
  }
}

Changes