Skip to content

List Links

Returns a paginated list of all links belonging to the current workspace. Results are sorted by creation date (newest first).

GET /v1/links
links:read

Query Parameters

ParameterTypeDefaultDescription
limitinteger50Number of links to return (1 – 200).
offsetinteger0Number of links to skip for pagination.
labelstringFilter links that include this label.
enabledbooleanFilter by enabled status (true or false).

Request Examples

Terminal window
curl "https://xqr.co/api/v1/links?limit=10&label=campaign" \
-H "Authorization: Bearer xqr_pk_a1b2c3d4.xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

Response

200 OK

An array of link objects.

{
"data": [
{
"id": "d47f2e1a-8c3b-4a5d-9e6f-1234567890ab",
"short_url": "https://xqr.co/summer24",
"short_code": "summer24",
"destination": "https://example.com/summer-sale?utm_source=qr",
"enabled": true,
"labels": ["campaign", "summer"],
"routing_rules": [],
"scan_count": 1483,
"last_scan_at": "2026-03-20T09:12:44Z",
"expires_at": "2026-09-30T23:59:59Z",
"created_at": "2026-03-01T10:00:00Z",
"updated_at": "2026-03-15T08:22:11Z"
},
{
"id": "a83c1d4e-2f5b-4890-bc7a-abcdef012345",
"short_url": "https://xqr.co/docs-v2",
"short_code": "docs-v2",
"destination": "https://docs.example.com/v2",
"enabled": true,
"labels": ["campaign"],
"routing_rules": [],
"scan_count": 327,
"last_scan_at": "2026-03-19T16:45:02Z",
"expires_at": null,
"created_at": "2026-02-14T12:00:00Z",
"updated_at": "2026-02-14T12:00:00Z"
}
],
"meta": {
"request_id": "req_1a2b3c4d5e6f7890",
"total": 42,
"limit": 10,
"offset": 0,
"rate_limit": {
"limit": 600,
"remaining": 598,
"reset": 1742572800
}
}
}

Was this page helpful?