Get inbox

Retrieve a single inbox by its ID, including its address, display name, and creation time.

GET /v1/inboxes/{id}

Get inbox

cURL

curl --request GET \
  --url https://api.openmail.sh/v1/inboxes/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "podId": "<string>",
  "address": "[e-mail]",
  "displayName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Response

200

application/json

Inbox details

id · string

OpenMail inbox ID

podId · string

ID of the pod this inbox belongs to. Inboxes created without an explicit pod land in your account's default pod.

address · string<email>

Full email address

displayName · string | null

Sender display name

createdAt · string<date-time>