prawnwire Developers

Domains

List the domains attached to the key's organization.

GET/v1/domains

Authentication

Use a key with domains:read. The endpoint takes no body or pagination parameters and returns { "data": [...] }.

Domain fields

FieldTypeMeaning
domainstringDomain name.
statusstringpending or verified.
verified_atstring or nullVerification timestamp, or null before verification.
created_atstringCreation timestamp.

This endpoint reports ownership verification, not whether the domain is hosted or every mail DNS record is healthy. A verified domain must also be on the Prawnwire mail server to send. Use the console’s Domain setup checks for hosting and DNS.

Errors

Account errors use the error.code and error.message shape. Missing domains:read returns HTTP 403, insufficient_scope. Invalid keys return 401; suspended organizations return 403; rate limits return 429 with Retry-After.

Search documentation

Type to search the documentation.