List pods

List all pods for your account. The default pod is always returned first. Supports pagination.

GET /v1/pods

List pods

cURL

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

200

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

Authorizations

Authorization · string · header · required

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

Query Parameters

limit · integer · default: 50

Max results to return

Required range: x <= 100

offset · integer · default: 0

Number of results to skip

Response

200 - application/json

List of pods

data · object[]

Show child attributes

total · integer