Get pod - OpenMail

Get pod

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

{
  "id": "<string>",
  "clientId": "<string>",
  "name": "<string>",
  "isDefault": true,
  "createdAt": "2023-11-07T05:31:56Z"
}

GET

pods

{id}

Get pod

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

{
  "id": "<string>",
  "clientId": "<string>",
  "name": "<string>",
  "isDefault": true,
  "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

Pod ID or your own clientId

Pod details

string

OpenMail pod ID

clientId

string | null

Your own identifier for the pod, if set.

name

string | null

Human-readable label, if set.

isDefault

boolean

Whether this is the account's default pod. Every account has exactly one; it is created automatically and cannot be deleted.

createdAt

string<date-time>