Get inbox

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

{
  "id": "<string>",
  "address": "jsmith@example.com",
  "displayName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

GET

inboxes

{id}

Get inbox

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

{
  "id": "<string>",
  "address": "jsmith@example.com",
  "displayName": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Authorization

string

header

required

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

string

required

Inbox details

string

OpenMail inbox ID

address

string<email>

Full email address

displayName

string | null

Sender display name

createdAt

string<date-time>

Documentation Index