Domains API Reference¶
The /v1/domains endpoint provides programmatic access to the list of domains available for creating and managing short links within your organization.
1. List Available Domains¶
GET /v1/domains
Retrieves all domains authorized for short link generation. This includes:
- Platform Default Domains: The global platform domain (
rby.one) withis_default: true. Short links on this domain generate random 8-character Base36 codes. Custom aliases are not allowed. - Branded Custom Domains: Active, verified custom domains belonging to your organization with
is_default: false. Short links on custom domains support user-defined custom aliases (e.g.go.yourbrand.com/promo).
Required Permissions¶
- Authentication: Bearer Token or HMAC-SHA256 signature
- Required Scope:
links:read
Request Headers¶
Response 200 OK¶
{
"domains": [
{
"domain": "rby.one",
"is_default": true
},
{
"domain": "go.yourbrand.com",
"is_default": false
}
]
}
Response Attributes¶
| Field | Type | Description |
|---|---|---|
domains |
array |
List of domain objects available for short link creation. |
domains[].domain |
string |
The domain hostname (e.g. rby.one, go.yourbrand.com). |
domains[].is_default |
boolean |
true if the domain is a platform default domain; false for organization custom domains. |