Skip to main content
GET
Get custom domain DNS records

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

app_id
string
required

ID of the app the domain belongs to.

domain_id
string
required

ID of the custom domain. Get this from List custom domains.

Query Parameters

is_subdomain
boolean
default:false

Whether the domain is a subdomain such as shop.example.com (true) or a root domain such as example.com (false).

limit
integer
default:50

Items per page. Max 50.

Required range: 1 <= x <= 50
cursor
string | null

Pagination cursor from previous response.

Response

Successful Response

The DNS records that point a domain at the app.

records
DomainDnsRecord · object[]
required

The records to create at the domain's DNS provider, on this page.

pagination
PublicPaginationInfo · object
required

Where this page sits in the full list of records.