Skip to main content
GET
curl

Authorizations

X-Api-Key
string
header
required

Your API key. In the dashboard, go to Integrations and open Deliveryman API Keys to create one.

Query Parameters

domain
string
required

The connected domain to list email accounts for (for example draftss.com).

limit
integer
default:20

Maximum number of records to return. Must be between 1 and 100. Defaults to 20.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of records to skip before returning results. For example, an offset of 0 starts at the most recent record, while an offset of 50 starts at the 51st. Defaults to 0.

Required range: x >= 0
workspace_id
integer | null

Only look for the domain in this workspace. Looks in all your workspaces when not set.

Response

Success

A page of email accounts on a domain.

data
object[]
required

Email accounts on the domain, newest first.

total
integer
required

Total number of email accounts on the domain.

Required range: x >= 0