List Domains
Getting Started
Authenticate using the Login API to obtain an access token. Include the returned Bearer Token in the Authorization header and provide a unique X-Device-ID with all authenticated requests. All requests must be made over HTTPS and are subject to rate limits.
Base URL: https://insprl.com/api
POST /external/domain/list
Use the List Domains API to retrieve domains available within your SPRL account.
This endpoint returns custom domains, branded domains, and system domains that can be used when creating short URLs through browser extensions, WordPress plugins, automation platforms, mobile applications, and custom integrations.
Request Information
| Method | POST |
| API Endpoint | https://insprl.com/api/external/domain/list |
| Authentication | Required |
Header Parameters
| Parameter | Type | Description |
|---|
| Authorization | String | Bearer authentication token received from the Login API. |
| X-Device-ID | String | The same device identifier used during login. |
| Content-Type | JSON | application/json |
Request Parameters
| Parameter | Type | Validate | Description |
|---|
| No request parameters required. |
Response Parameters
| Parameter | Type | Description |
|---|
| success | Boolean | Request status (true/false). |
| data | Array | List of available domains. |
| data.domain_id | Integer | Unique domain identifier. |
| data.domain | String | Domain name. |
| data.type | String | Domain type (system, branded, custom). |
| data.is_default | Boolean | Indicates whether the domain is the account default domain. |
| data.status | Boolean | Current domain status. |
Response Codes
| SPRL Code | HTTP Status | Mode | Response Field | Description |
| 100 | 200 | success | data | Request processed successfully. |
| 101 | 401 | failed | message | Authentication failed. Invalid session, token or credentials. |
| 102 | 422 | failed | errors | Parameter validation failed. Check the request fields. |
| 103 | 404 | failed | message | Requested resource was not found. |
| 104 | 403 | failed | message | Access denied or account restricted. |
| 105 | 429 | failed | message | Too many requests. Please retry later. |
| 106 | 500 | failed | message | Unexpected server error. Please try again later. |
Error Flag Reference
| Category | Flag | Type | Description |
| Authentication | INVALID_SESSION | auth_error | The supplied token or device identifier is invalid. |
| Authentication | INVALID_CREDENTIALS | auth_error | Invalid login credentials supplied. |
| Validation | INVALID_PARAMETER | validation_error | One or more request parameters are invalid. |
| Resource | RESOURCE_NOT_FOUND | resource_error | The requested URL, folder, domain or resource could not be found. |
| Account | ACCOUNT_RESTRICTED | account_error | The account is restricted or access has been denied. |
| Rate Limit | RATE_LIMIT_EXCEEDED | rate_limit_exceeded | The request rate limit has been exceeded. |
| Server | UNEXPECTED_ERROR | server_error | An unexpected internal server error occurred. |