API documentation
Links
Create and manage your short links, targeting rules, pixels, and redirects.
Authentication
Every request must send the Authorization header with a Bearer token matching the admin API key.
Get API key.
Endpoint
GET https://rqrcode.com/api/links/
Example
curl --request GET \
--url 'https://rqrcode.com/api/links/' \
--header 'Authorization: Bearer {api_key}'
Parameters
| Parameters | Details | Description |
|---|---|---|
| page |
Optional
ui.admin.api_docs.common.types.Integer
|
The page number that you want to get the results for. Defaults to 1. |
| results_per_page |
Optional
ui.admin.api_docs.common.types.Integer
|
How many results you want per page. Allowed values are: 10, 25, 50, 100, 250, 500, 1000. Defaults to 25. |
Response example
{
"data": [
{
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "example",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"pageviews": 10,
"order": 0,
"start_date": null,
"end_date": null,
"datetime": "2026-04-20 07:53:23"
}
],
"meta": {
"page": 1,
"results_per_page": 25,
"total": 1,
"total_pages": 1
},
"links": {
"first": "https://rqrcode.com/api/links?page=1",
"last": "https://rqrcode.com/api/links?page=1",
"next": null,
"prev": null,
"self": "https://rqrcode.com/api/links?page=1"
}
}
Endpoint
GET https://rqrcode.com/api/links/{link_id}
Example
curl --request GET \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
Parameters
No additional parameter.
Response example
{
"data": {
"id": 1,
"project_id": null,
"domain_id": 0,
"type": "link",
"url": "example",
"location_url": "https://example.com/",
"settings": {
"password": null,
"sensitive_content": false
},
"pageviews": 10,
"order": 0,
"start_date": null,
"end_date": null,
"datetime": "2026-04-20 07:53:23"
}
}
Endpoint
POST https://rqrcode.com/api/links
Example
curl --request POST \
--url 'https://rqrcode.com/api/links' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'url=example' \
--form 'location_url=https://rqrcode.com/'
Parameters
| Parameters | Details | Description |
|---|---|---|
| location_url |
Required
ui.admin.api_docs.common.types.String
|
Destination URL. Available when: is_bulk = 0 |
| location_urls |
Required
ui.admin.api_docs.common.types.String
|
Destination URL. Available when: is_bulk = 1 |
| url |
Optional
ui.admin.api_docs.common.types.String
|
The generated URL alias. Leave empty for a random one. Available when: is_bulk = 0 |
| is_bulk |
Optional
ui.admin.api_docs.common.types.Boolean
|
- |
| domain_id |
Optional
ui.admin.api_docs.common.types.Integer
|
- |
| project_id |
Optional
ui.admin.api_docs.common.types.Integer
|
- |
| pixels_ids |
Optional
ui.admin.api_docs.common.types.Integer
|
- |
| schedule |
Optional
ui.admin.api_docs.common.types.Boolean
|
- |
| start_date |
Optional
ui.admin.api_docs.common.types.String
|
Available when: schedule = true |
| end_date |
Optional
ui.admin.api_docs.common.types.String
|
Available when: schedule = true |
| pageviews_limit |
Optional
ui.admin.api_docs.common.types.Integer
|
- |
| expiration_url |
Optional
ui.admin.api_docs.common.types.String
|
- |
| password |
Optional
ui.admin.api_docs.common.types.String
|
- |
| forward_query_parameters_is_enabled |
Optional
ui.admin.api_docs.common.types.Boolean
|
- |
| utm_source |
Optional
ui.admin.api_docs.common.types.String
|
- |
| utm_medium |
Optional
ui.admin.api_docs.common.types.String
|
- |
| utm_campaign |
Optional
ui.admin.api_docs.common.types.String
|
- |
| sensitive_content |
Optional
ui.admin.api_docs.common.types.Boolean
|
- |
| http_status_code |
Optional
ui.admin.api_docs.common.types.Integer
|
Allowed values: 301, 302, 307, 308 |
| app_linking_is_enabled |
Optional
ui.admin.api_docs.common.types.Boolean
|
- |
| cloaking_is_enabled |
Optional
ui.admin.api_docs.common.types.Boolean
|
- |
| cloaking_title |
Optional
ui.admin.api_docs.common.types.String
|
- |
| cloaking_meta_description |
Optional
ui.admin.api_docs.common.types.String
|
- |
| cloaking_custom_js |
Optional
ui.admin.api_docs.common.types.String
|
- |
| cloaking_favicon |
Optional
ui.admin.api_docs.common.types.File
|
- |
| cloaking_opengraph |
Optional
ui.admin.api_docs.common.types.File
|
- |
| targeting_type |
Optional
ui.admin.api_docs.common.types.String
|
Allowed values: continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = continent_code |
| targeting_continent_code_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = continent_code |
| targeting_country_code_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = country_code |
| targeting_country_code_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = country_code |
| targeting_city_name_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = city_name |
| targeting_city_name_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = city_name |
| targeting_device_type_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = device_type |
| targeting_device_type_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = device_type |
| targeting_browser_language_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = browser_language |
| targeting_browser_language_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = browser_language |
| targeting_rotation_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = rotation |
| targeting_rotation_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = rotation |
| targeting_os_name_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = os_name |
| targeting_os_name_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = os_name |
| targeting_browser_name_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = browser_name |
| targeting_browser_name_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = browser_name |
Response example
{
"data": {
"id": 1
}
}
Endpoint
POST https://rqrcode.com/api/links/{link_id}
Example
curl --request POST \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'is_enabled=0'
Parameters
| Parameters | Details | Description |
|---|---|---|
| location_url |
Optional
ui.admin.api_docs.common.types.String
|
Destination URL. |
| url |
Optional
ui.admin.api_docs.common.types.String
|
The generated URL alias. Leave empty for a random one. |
| domain_id |
Optional
ui.admin.api_docs.common.types.Integer
|
- |
| project_id |
Optional
ui.admin.api_docs.common.types.Integer
|
- |
| pixels_ids |
Optional
ui.admin.api_docs.common.types.Integer
|
- |
| schedule |
Optional
ui.admin.api_docs.common.types.Boolean
|
- |
| start_date |
Optional
ui.admin.api_docs.common.types.String
|
Available when: schedule = true |
| end_date |
Optional
ui.admin.api_docs.common.types.String
|
Available when: schedule = true |
| pageviews_limit |
Optional
ui.admin.api_docs.common.types.Integer
|
- |
| expiration_url |
Optional
ui.admin.api_docs.common.types.String
|
- |
| password |
Optional
ui.admin.api_docs.common.types.String
|
- |
| forward_query_parameters_is_enabled |
Optional
ui.admin.api_docs.common.types.Boolean
|
- |
| utm_source |
Optional
ui.admin.api_docs.common.types.String
|
- |
| utm_medium |
Optional
ui.admin.api_docs.common.types.String
|
- |
| utm_campaign |
Optional
ui.admin.api_docs.common.types.String
|
- |
| sensitive_content |
Optional
ui.admin.api_docs.common.types.Boolean
|
- |
| http_status_code |
Optional
ui.admin.api_docs.common.types.Integer
|
Allowed values: 301, 302, 307, 308 |
| app_linking_is_enabled |
Optional
ui.admin.api_docs.common.types.Boolean
|
- |
| cloaking_is_enabled |
Optional
ui.admin.api_docs.common.types.Boolean
|
- |
| cloaking_title |
Optional
ui.admin.api_docs.common.types.String
|
- |
| cloaking_meta_description |
Optional
ui.admin.api_docs.common.types.String
|
- |
| cloaking_custom_js |
Optional
ui.admin.api_docs.common.types.String
|
- |
| cloaking_favicon |
Optional
ui.admin.api_docs.common.types.File
|
- |
| cloaking_opengraph |
Optional
ui.admin.api_docs.common.types.File
|
- |
| targeting_type |
Optional
ui.admin.api_docs.common.types.String
|
Allowed values: continent_code, country_code, city_name, device_type, browser_language, rotation, os_name, browser_name |
| targeting_continent_code_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = continent_code |
| targeting_continent_code_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = continent_code |
| targeting_country_code_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = country_code |
| targeting_country_code_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = country_code |
| targeting_city_name_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = city_name |
| targeting_city_name_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = city_name |
| targeting_device_type_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = device_type |
| targeting_device_type_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = device_type |
| targeting_browser_language_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = browser_language |
| targeting_browser_language_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = browser_language |
| targeting_rotation_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = rotation |
| targeting_rotation_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = rotation |
| targeting_os_name_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = os_name |
| targeting_os_name_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = os_name |
| targeting_browser_name_key[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = browser_name |
| targeting_browser_name_value[index] |
Optional
ui.admin.api_docs.common.types.String
|
Available when: targeting_type = browser_name |
Response example
{
"data": {
"id": 1
}
}
Endpoint
DELETE https://rqrcode.com/api/links/{link_id}
Example
curl --request DELETE \
--url 'https://rqrcode.com/api/links/{link_id}' \
--header 'Authorization: Bearer {api_key}'
Parameters
No additional parameter.
Response example
Empty 200 response body on success.