Skip to main content
GET
/
v1
/
inboxes
List inboxes
curl --request GET \
  --url https://api.openmail.sh/v1/inboxes \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "<string>",
      "address": "jsmith@example.com",
      "displayName": "<string>",
      "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 inboxes

​
data
object[]
​
total
integer