Domains
List domains
List sending domains configured in the API key workspace.
GET
/api/v1/domainsOn this page
Authentication
Send a RouteKite API key as a Bearer token. This endpoint requires the domain:read, domain:manage, or email:send scope.
| Name | Type | Requirement | Description |
|---|---|---|---|
Authorization | string | Required | Bearer API key with the required workspace scope.Example: Bearer rk_your_key |
Request body
| Name | Type | Requirement | Description |
|---|---|---|---|
include_archived | boolean | Optional | Include archived domains. Defaults to false. |
limit | integer | Optional | Return 1 to 100 domains. Defaults to 50. |
Response
| Name | Type | Requirement | Description |
|---|---|---|---|
object | string | Always | Always list. |
data | domain[] | Always | Workspace domains. |
count | integer | Always | Returned item count. |
Errors
| Status | Code | What it means | What to do |
|---|---|---|---|
| 401 | UNAUTHORIZED | The API key is invalid. | Check the Bearer header. |
| 403 | FORBIDDEN | The key cannot read sending configuration. | Use domain:read, domain:manage, or legacy email:send access. |
| 404 | DOMAIN_NOT_FOUND | The domain is not in this workspace. | Check the domain ID and API key workspace. |
| 429 | RATE_LIMITED | Too many requests were made. | Honor Retry-After before retrying. |
| 503 | SETUP_UNAVAILABLE | Configuration could not be loaded. | Retry after a short delay. |