cherami.
API referenceInboxes and rules

List inboxes

GET /v1/inboxes

Read as Markdown ↗

GET /v1/inboxes

Requires an API key: Authorization: Bearer YOUR_CREDENTIAL.

Lists every inbox on the account in one response, without pagination. inbox_allowance.remaining is how many more you can create.

curl example

Supply CHERAMI_API_KEY privately.

curl --silent --show-error --include --request GET \
  "https://cherami.to/v1/inboxes" \
  --header "Authorization: Bearer $CHERAMI_API_KEY"

Responses

HTTP 200

Success.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

InboxList

{
  "inboxes": [],
  "inbox_limit": 0,
  "inbox_allowance": {
    "allowance": 0,
    "used": 0,
    "remaining": 0,
    "unit": "inbox_slots"
  }
}

HTTP 401

unauthorized: Send a valid API key as Authorization: Bearer <key>. If the key stopped working, get a new one through recovery.

  • X-Request-ID: Identifies this request; include it when reporting a problem.
  • WWW-Authenticate: "Bearer"

Content type: application/json.

Error

HTTP 404

not_found: The resource does not exist or does not belong to this account. A reply or forward source must also be in the sending inbox.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

HTTP 500

internal_error: The operation failed. Retry a read; after a write the change may have happened, so recover as retry by operation describes.

  • X-Request-ID: Identifies this request; include it when reporting a problem.

Content type: application/json.

Error

Schema: InboxList

FieldRequiredTypeMeaning and constraints
inboxesYesarray of Inbox
inbox_limitYesintegerMost inboxes the account can have; the same as inbox_allowance.allowance. minimum: 0
inbox_allowanceYesInboxAllowance

Schema: Inbox

FieldRequiredTypeMeaning and constraints
idYesstringCherami resource ID.
local_partYesstring
addressYesstring
nameYesstring or null
sender_nameYesstring or null
created_atYesstringUTC timestamp with milliseconds. format: date-time pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z$

Schema: InboxAllowance

FieldRequiredTypeMeaning and constraints
allowanceYesintegerminimum: 0
usedYesintegerminimum: 0
remainingYesintegerminimum: 0
unitYes"inbox_slots"

Schema: Error

FieldRequiredTypeMeaning and constraints
errorYesobject

error fields

FieldRequiredTypeMeaning and constraints
codeYesstringCode to handle. Handle a code you don't recognize by its HTTP status.
messageYesstringExplanation of this case; its wording can change.

Errors, limits and pagination · Download OpenAPI 3.1

On this page