List Domains
Returns a list of all custom domains configured in your account.
Endpoint
GET
v5/domain
Requires authentication
Path Parameters
None
Query Parameters
All query parameters are optional.
page
integer
Page number to return. Defaults to 1.
resultsperpage
integer
Number of results to return per page. Default is 50, maximum is 500.
Response
Returns a keyed object of domain records, where each key is the domain ID.
result_ok
boolean
Whether the request succeeded.
data
object
Keyed object of domain records, where each key is the domain ID.
child attributes
id
integer
The unique ID of the domain.
customerID
string
The account (customer) ID this domain belongs to.
type
string
The domain type. Possible values:
Private, Subdomain.domain
string
The domain URL (e.g.
surveys.mycompany.com).redirect
string
The survey-not-found redirect URL. Empty string if not configured. Applies to Private domains only.
eStatus
string
The domain status (e.g.
Active).created
string
Timestamp when the domain was created.
Examples
Note GET requests are cached for 60 seconds. Repeated identical requests within that window will return cached results.
Request (cURL)
curl -X GET "https://api.alchemer.com/v5/domain?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET"
Response
{
"result_ok": true,
"data": {
"YOUR_DOMAIN_ID": {
"id": YOUR_DOMAIN_ID,
"customerID": "YOUR_CUSTOMER_ID",
"type": "Private",
"domain": "surveys.mycompany.com",
"redirect": "",
"eStatus": "Active",
"created": "2015-05-12 17:36:30"
},
"YOUR_DOMAIN_ID_2": {
"id": YOUR_DOMAIN_ID_2,
"customerID": "YOUR_CUSTOMER_ID",
"type": "Private",
"domain": "reviews.mycompany.com",
"redirect": "",
"eStatus": "Active",
"created": "2017-03-21 12:08:12"
}
}
}