Skip to Content
SendlySendly
API ReferenceDomains

Retrieve a sending domain

GET
/api/v1/domains/{id}

Fetch one sending domain by id.

Requires the domains:read scope — View your sending domains and their verification status.

headerAuthorizationBearer <API Key>

API key authentication. Use a sk_* (FULL) or pk_* (SENDING_ONLY) key as the bearer token. Public keys (pk_*) are restricted to the email-send endpoints and the self-serve list subscribe/unsubscribe pair; every other endpoint — event tracking included — answers 403 for them. In scope terms (used by /api/v1/* operations): FULL keys hold every scope; SENDING_ONLY keys hold only emails:send.

id*string

Resource id.

Formatuuid

Response Body

The sending domain

application/json
  1. response

A sending domain as exposed on the v1 API.

id*string
Formatuuid
domain*string
verified*boolean
region*string|null
stream*string

Which traffic a sending identity carries. An identity with no stream serves both, which is how every domain added before per-stream identities behaves.

Value in"TRANSACTIONAL""MARKETING"
stream_default*boolean
default_from_address*string|null
default_from_name*|

The display name recipients see beside any address on this domain when a send names none. null falls back to the project name.

mail_from_domain*string|null
mail_from_domain_status*|

SES's CustomMailFromStatus for mail_from_domain — the subdomain that carries the bounce path, NOT the status of any From address.

dkim_verified*boolean
created_at*string
Formatdate-time
updated_at*string
Formatdate-time
Example Request
curl -X GET 'https://api.sendly.now/api/v1/domains/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "domain": "string",  "verified": true,  "region": "string",  "stream": "string",  "stream_default": true,  "default_from_address": "string",  "default_from_name": "string",  "mail_from_domain": "string",  "mail_from_domain_status": "string",  "dkim_verified": true,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}