Get Domain
Returns information about a specific custom domain in your account.
Endpoint
GET
v5/domain/{domain_id}
Requires authentication
Path Parameters
The domain to retrieve.
domain_id
string
required
The ID of the domain to retrieve.
Query Parameters
This endpoint does not accept additional query parameters beyond authentication credentials.
None
Response
Returns a single domain record nested under its domain ID key.
result_ok
boolean
Whether the request succeeded.
data
object
A keyed object containing a single domain record, where the 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/YOUR_DOMAIN_ID?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"
}
}
}