Reference
Domains
Domain APIs are read-only. Use them to inspect domains available to your workspace. Registration, DNS verification, redirect settings, app-domain assignment, archive, and deletion stay in the web panel.
List Domains
GET/v1/domains
| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | Optional | Default 25. Maximum 100. |
| cursor | string | Optional | Use pagination.nextCursor from the previous page. |
| search | string | Optional | Case-insensitive domain contains filter. |
| domain | string | Optional | Case-insensitive exact domain filter. |
| archived | boolean | Optional | Defaults to false. |
| sort | created_at_desc | created_at_asc | updated_at_desc | updated_at_asc | Optional | Defaults to created_at_desc. |
List domains
curl "https://api.shortify.com/v1/domains?limit=25&search=go" \
-H "api-key: sk_live_your_server_key"Retrieve Domain
GET/v1/domains/{domainId}
Retrieve domain
curl "https://api.shortify.com/v1/domains/domain_01HV4Z4Y6W3D4J9B2Y8QH6P8JS" \
-H "api-key: sk_live_your_server_key"200
Success{
"success": true,
"data": {
"id": "domain_01HV4Z4Y6W3D4J9B2Y8QH6P8JS",
"domain": "go.example.com",
"verified": true,
"placeholder": null,
"expiredUrl": null,
"notFoundUrl": "https://example.com/not-found",
"primary": true,
"archived": false,
"createdAt": "2026-07-03T09:00:00.000Z",
"updatedAt": "2026-07-03T09:00:00.000Z"
},
"requestId": "req_01HV4Z4Y6W3D4J9B2Y8QH6P8JS"
}