Download OpenAPI specification:Download
Welcome to the SimpleURL API documentation! Our RESTful APIs allow you to programmatically manage your short links, branded domains, and campaigns.
All API requests require authentication using an API key. You must send the key in the X-API-Key header.
X-API-Key: YOUR_API_KEY_HERE
You can generate and manage your API keys from your Account Settings in the dashboard.
To ensure platform stability, API requests are rate-limited based on your subscription tier. If you exceed your limit, the API will respond with a 429 Too Many Requests status code. Please ensure your application handles rate limiting gracefully.
Adds a new branded domain to the account and returns DNS setup instructions.
Branded domain details
| domain required | string The custom branded domain name to add (e.g. links.acme.com or acme.com). |
{- "domain": "links.acme.com"
}{- "id": 1,
- "domain": "links.acme.com",
- "type": "SUBDOMAIN",
- "status": "PENDING",
- "verificationInstructions": {
- "type": "CNAME",
- "host": "links",
- "value": "cname.simpleurl.tech",
- "nameservers": [
- "string"
], - "note": "string"
}
}Triggers a DNS verification check for the given branded domain to activate it.
| domain required | string |
{- "id": 1,
- "domain": "links.acme.com",
- "status": "ACTIVE",
- "message": "Domain verified successfully",
- "verificationInstructions": {
- "type": "CNAME",
- "host": "links",
- "value": "cname.simpleurl.tech",
- "nameservers": [
- "string"
], - "note": "string"
}
}Retrieves details of a specific short URL by keyword.
| keyword required | string |
| domain | string Default: "smplu.link" |
{- "success": true,
- "data": {
- "keyword": "my-promo",
- "description": "Summer Promo Campaign",
- "domain": "smplu.link",
- "hasQrCode": true,
- "createdAt": "2026-05-31T09:16:48Z"
}
}Updates the destination URL and/or description of an existing short URL.
| keyword required | string |
Updated short URL details
| url | string The new target long URL. If omitted, only the description will be updated. |
| description | string The new description/notes for the short URL. |
| domain | string Default: "smplu.link" The branded domain configured for this keyword. Defaults to 'smplu.link'. |
{- "description": "Updated Summer Campaign Link",
- "domain": "links.mybrand.com"
}{- "success": true,
- "data": {
- "keyword": "my-promo",
- "description": "Summer Promo Campaign",
- "domain": "smplu.link",
- "hasQrCode": true,
- "createdAt": "2026-05-31T09:16:48Z"
}
}Returns a paginated list of short URLs belonging to the authenticated user.
| page | integer <int32> Default: 1 |
| pageSize | integer <int32> Default: 10 |
| search | string |
| domain | string |
| isPublic | boolean |
{- "success": true,
- "data": [
- {
- "keyword": "my-promo",
- "description": "Summer Promo Campaign",
- "domain": "smplu.link",
- "hasQrCode": true,
- "createdAt": "2026-05-31T09:16:48Z"
}
], - "pagination": {
- "currentPage": 1,
- "pageSize": 10,
- "hasNext": true,
- "hasPrevious": false
}
}Creates a new short URL. You can provide a custom keyword or leave it blank to auto-generate one.
Short URL details
| url required | string The target long URL to shorten. |
| keyword | string Custom keyword for the shortened URL. If omitted, a random 5-character keyword will be generated. |
| description | string Optional description/notes to identify this short URL. |
| domain | string Default: "smplu.link" The branded custom domain configured on your account. Defaults to 'smplu.link'. |
| createQrCode | boolean Default: false Whether to automatically enable/generate a client-side QR code for this link. Defaults to false. |
{- "keyword": "my-promo",
- "description": "Summer 2026 Promo Campaign",
- "domain": "links.mybrand.com",
- "createQrCode": false
}{- "success": true,
- "data": {
- "keyword": "my-promo",
- "description": "Summer Promo Campaign",
- "domain": "smplu.link",
- "hasQrCode": true,
- "createdAt": "2026-05-31T09:16:48Z"
}
}Creates up to 100 short URLs in a single request.
List of short URLs to create in bulk
required | Array of objects (CreateShortUrlV1Request) A list of short URL objects to create in bulk (maximum 100). | ||||||||||
Array
| |||||||||||
{- "urls": [
- {
- "keyword": "my-promo",
- "description": "Summer 2026 Promo Campaign",
- "domain": "links.mybrand.com",
- "createQrCode": false
}
]
}{- "success": true,
- "data": {
- "created": [
- {
- "keyword": "my-promo",
- "description": "Summer Promo Campaign",
- "domain": "smplu.link",
- "hasQrCode": true,
- "createdAt": "2026-05-31T09:16:48Z"
}
],
}, - "summary": {
- "total": 5,
- "successful": 4,
- "failed": 1
}
}Returns a paginated list of all short URLs that have a QR code enabled. Optionally filter by domain.
| page | integer <int32> Default: 1 |
| pageSize | integer <int32> Default: 10 |
| domain | string |
{- "success": true,
- "data": [
- {
- "id": 12345,
- "keyword": "my-promo",
- "domain": "smplu.link",
- "hasQrCode": true,
- "description": "Spring Promo Campaign",
- "createdAt": "2024-03-01T12:00:00Z"
}
], - "pagination": {
- "currentPage": 1,
- "pageSize": 10,
- "hasNext": true,
- "hasPrevious": false
}
}Enables a QR code on an existing short URL.
QR code enable details
| keyword required | string The short URL keyword to enable the QR code for. |
| domain | string The domain of the short URL. |
{- "keyword": "my-promo",
- "domain": "smplu.link"
}{- "success": true,
- "data": {
- "id": 12345,
- "keyword": "my-promo",
- "domain": "smplu.link",
- "hasQrCode": true,
- "description": "Spring Promo Campaign",
- "createdAt": "2024-03-01T12:00:00Z"
}
}Returns the QR code details for a single short URL.
| keyword required | string |
| domain | string Default: "smplu.link" |
{- "success": true,
- "data": {
- "id": 12345,
- "keyword": "my-promo",
- "domain": "smplu.link",
- "hasQrCode": true,
- "description": "Spring Promo Campaign",
- "createdAt": "2024-03-01T12:00:00Z"
}
}