Domains › Get a domain

Domains

Get a domain

GET/api/{ORG}/domains/{domain}Permalink

Answers the Domain.

Permission
Domains · view
Plan
Plans that include the API: Pricing
Retry
Safe: a read changes nothing

Example request

bash
curl "https://console.brevily.com/api/NORTHWIND/domains/go.example.com" \  -H "x-api-key: brv_ak_7Fq2Lw9xK3" \  -H "x-api-secret: $BREVILY_SECRET"

Example answer

json
{  "domain": "go.example.com",  "name": "example",  "shared": false,  "status": "PENDING",  "parent": "example",  "offersSubdomains": false,  "planStatus": "ACTIVE",  "choiceDueOn": "2026-11-05T09:41:00Z",  "isDefault": false,  "purpose": "LINKS",  "method": "DNS_TXT",  "verifiedOn": "2026-11-05T09:41:00Z",  "heldUntil": "2026-11-05T09:41:00Z",  "freeOn": "2026-11-05T09:41:00Z",  "certificate": {    "status": "example",    "issuedOn": "2026-11-05T09:41:00Z",    "expiresOn": "2026-11-05T09:41:00Z"  },  "records": [    {      "type": "TXT",      "name": "example",      "value": "example",      "ttl": "example"    }  ],  "links": 1,  "slugLength": 1,  "slugMode": "RANDOM",  "allowChosenSlugs": false,  "allowSlugModeOverride": false,  "defaultRedirectUrl": "https://www.example.com/sale/autumn",  "notFoundRedirectUrl": "https://www.example.com/sale/autumn",  "expiredRedirectUrl": "https://www.example.com/sale/autumn",  "disabledRedirectUrl": "https://www.example.com/sale/autumn",  "passClickIds": false,  "passNames": [    "example"  ],  "createdOn": "2026-11-05T09:41:00Z"}

Made-up values.

PathPermalink

Path parameters
NameTypeRequiredDescriptionAllowed values
ORGstringrequiredYour organisation’s code.3 to 20 characters
domainstringrequired—

QueryPermalink

Query parameters
NameTypeRequiredDescriptionAllowed values
statusstringoptionalNarrows the answer: ?status=<value>, or ?status=eq:<value>.—
addstringoptionalNarrows the answer: ?add=<value>, or ?add=eq:<value>.—
checkedstringoptionalNarrows the answer: ?checked=<value>, or ?checked=eq:<value>.—
qstringoptionalA search term.—
sortstringoptionalOne of domain, status, then :asc or :desc (?sort=domain:desc).—

AnswerPermalink

Domain

Answer fields
NameTypeDescriptionAllowed values
domainstringThe hostname, lower case.—
namestringThe name it is listed under.—
sharedbooleanOne of Brevily’s shared domains; false for an organisation’s own.—
statusstringPENDING until its DNS record proves it (a requested subdomain: until it is approved); DELETED once removed while links named it.PENDING, VERIFIED, SUSPENDED, DELETED
parentstringThe shared domain a requested subdomain sits under; null for any other domain.or null
offersSubdomainsbooleanA shared domain organisations may ask a subdomain of; false for any other domain.—
planStatusstringAgainst the plan: serving, being chosen between, picked to stay, or switched off.ACTIVE, CHOOSE, KEEP, PARKED
choiceDueOndate-timeWhen an open choice of the domains to keep is due; null when none is.or null
isDefaultbooleanThe shared domain a new link lands on when none is chosen.—
purposestringLINKS, or only one kind: the short links of shared reports and public link stats (SHARES), partners’ referral links (PARTNER) or Brevily’s own campaign links (CAMPAIGN).LINKS, SHARES, PARTNER, CAMPAIGN
methodstringThe record that proves it (that proved it, once verified): its TXT record; null when none.DNS_TXT; or null
verifiedOndate-timeWhen it was proved; null while it has not been.or null
heldUntildate-timeAn unverified claim holds its name until then; null otherwise.or null
freeOndate-timeA removed own domain holds its name until then; null otherwise.or null
certificateCertificate—
recordsDnsRecord[]The DNS records to add: the one that proves it, and the ones that connect it.—
linksintegerLinks on it that still answer (active, disabled, expired).—
slugLengthintegerHow long a generated back-half is now (it grows with use).—
slugModestringHow generated back-halves are drawn.RANDOM, SEQUENTIAL, SHUFFLED
allowChosenSlugsbooleanPeople may type their own back-half on it.—
allowSlugModeOverridebooleanA link may pick the other generator.—
defaultRedirectUrlstringWhere its root sends visitors; null for the default.or null
notFoundRedirectUrlstringWhere an unknown back-half sends visitors; null for the default page.or null
expiredRedirectUrlstringWhere an expired link sends visitors; null for the default page.or null
disabledRedirectUrlstringWhere a disabled link sends visitors; null for the default page.or null
passClickIdsbooleanAn own domain’s default: its links pass the ad networks’ click ids (gclid, fbclid, msclkid and the rest) from the visit, unless a link or its folder chooses for itself. True until set false.—
passNamesstring[]An own domain’s default: other names of the visit’s parameters its links pass on beside utm_ ones (never a redirect’s, such as next or url).—
createdOndate-timeWhen it was added.or null
Fields of certificate
Fields of certificate
NameTypeDescriptionAllowed values
statusstringPENDING, ISSUED or FAILED.—
issuedOndate-timeWhen it was issued; null until it is.or null
expiresOndate-timeWhen it expires; null until it is issued.or null
Fields of records
Fields of records
NameTypeDescriptionAllowed values
typestringThe record’s type.TXT, A, AAAA
namestringThe name the record sits at.—
valuestringWhat it holds.—
ttlstringIts time to live ("Auto": the provider’s default).—

ErrorsPermalink

Errors
Status Code When
400 VALIDATION_FAILED A field, a parameter or the body is wrong; details.fields says which.
401 UNAUTHENTICATED No key, a key that does not match, or one expired or revoked.
403 ACCESS_DENIED The key lacks Domains · view, or the organisation’s plan does not include it.
404 NOT_FOUND No organisation with that code for this key, or no such record in it.
429 RATE_LIMITED Too many calls: wait Retry-After seconds.

Rate limitsPermalink

Counted with every other call of the organisation, by plan: Pricing. The answer carries RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset; more on rate limits.