List custom domains
Returns the caller's custom domains, newest first, with cursor pagination. 403 byod_disabled when custom domains are not enabled for the account. Listing is not plan-gated: an account on a plan without custom domains simply gets an empty list (a downgraded account keeps read/list/delete on domains it already owns). Creating one needs a Scale or Business plan; see POST /domains.
Request
- Base URL: https://dash.mailsocket.app/api/v1
- URL: https://dash.mailsocket.app/api/v1/domains
- Auth: HTTP bearer
Query parameters
Page size, 1 to 100. Default 25. A value outside that range (or not an integer) returns 422 validation_error with fields.limit.
Opaque, signed, owner- and filter-bound pagination cursor: only the next_cursor returned by the previous page of the SAME endpoint with the same filter parameters is accepted, for 24 hours. An invalid, tampered, expired or foreign cursor (other endpoint, other filter set, other account) returns 422 validation_error with fields.cursor; start again from the first page. Cursors minted with a filter before 2026-10-14 (secfix-p2p3) are refused the same way.
Response
A page of domains.
Changes
No recorded changes to this operation across all 1 revision of this API.