Skip to content
Developers
No results found.

List Custom Domains

Scopes
read:custom-domain

Query Parameters

fields
string | array<string>

Include only defined fields. You can pass this parameter multiple times or you can include all values separated by commas.

Examples: "id,created_at" 

limit
integer
min-1
max
500

Limit the number of results returned

Examples: 5 

offset
integer
min0
max
99999999999999

Page number of records you wish to skip before selecting records. Final skipped records count would be limit * offset.

q
string

Additional query in PlusAuth Query Language format.

sort_by
string | array<string>

Properties that should be ordered by, with their ordering type. To define order type append it to the field with dot. You can pass this parameter multiple times or you can include all values separated by commas.

Examples: "id.asc,created_at.desc" "email.asc" 

GET
/custom-domain
cURL
cURLC#DartGoJavaJavaScriptPHPPythonRubyRustSwift
1
2
3
Loading...
Response
200
Paginated list of custom domains
Loading...

Response Body Schema

total
integer
Required
results
array<object>
results.
domain
string
Required
length
0-256
results.
enabled
boolean
Required
results.
id
string
Required
length
0-16

Unique identifier of entity

results.
verified
boolean
Required
results.
verification_value
string
results.
mx_record
object
Required
results.mx_record.
type
string
Required

Available Values: CNAMETXT

results.mx_record.
value
string
Required