List Short URLs
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/short-url/list
Use the List Short URLs API to retrieve short URLs associated with your SPRL account.
This endpoint supports pagination, searching, and filtering, making it ideal for browser extensions, WordPress plugins, automation platforms, dashboards, and custom integrations.
Request Information
| Method | POST |
| API Endpoint | https://insprl.com/api/external/short-url/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 |
|---|
| page | Integer | Optional | Page number. Default: 1. |
| per_page | Integer | Optional | Number of records per page. Default: 20. |
| search | String | Optional | Search by URL slug, destination URL, or title. |
| status | Integer | Optional | Filter by URL status. |
| source | String | Optional | Filter by integration source such as wordpress, chrome, make or zapier. |
Response Parameters
| Parameter | Type | Description |
|---|
| success | Boolean | Request status (true/false). |
| data | Array | List of short URLs. |
| data.url_id | Integer | Unique URL identifier. |
| data.short_url | String | Generated short URL. |
| data.long_url | String | Destination URL. |
| data.url_flag | String | Short URL slug. |
| data.status | Integer | Current URL status. |
| data.clicks | Integer | Total clicks recorded. |
| data.created_at | DateTime | URL creation timestamp. |
| pagination | Object | Pagination details. |
| pagination.current_page | Integer | Current page number. |
| pagination.per_page | Integer | Records per page. |
| pagination.total | Integer | Total records available. |
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. |