List threads

List threads for an inbox. Use is_read to filter by read status — for example, ?is_read=false returns only unread threads.

GET /v1/inboxes/{id}/threads

List threads

cURL

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

200

{
  "data": [
    {
      "id": "<string>",
      "subject": "<string>",
      "isRead": true,
      "lastMessageAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "messageCount": 123
    }
  ],
  "total": 123
}

Authorizations

Authorization · string · header · required

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

Path Parameters

id · string · required

Query Parameters

limit · integer · default: 50

Required range: x <= 100

offset · integer · default: 0

is_read · boolean

Filter by read status. true = read threads only, false = unread threads only. Omit to return all.

Response

200 - application/json

List of threads

data · object[]

Show child attributes

total · integer