Skip to content

List codes

GET/v1/codes

Query parameters

limitnumberoptionalPage size, 1–100. Default 25.
cursorstringoptionalnextCursor of the previous page.
folderIdstringoptionalOnly codes in this folder.
typestringoptionalOnly one code type, e.g. url.
statusstringoptionalactive, paused, expired, scan_limit_reached or disabled.
dynamicbooleanoptionaltrue or false.
searchstringoptionalMatches the name and the slug.
sortstringoptionalcreated_at, updated_at, name or scans; prefix - for descending. Default -created_at.

Example request

requestGET /v1/codes
curl "https://api.dotwick.com/v1/codes?folderId=fld_8k2m4q7x&status=active&limit=50" \  -H "Authorization: Bearer sk_live_…"
response200 OK
{  "data": [    {      "id": "qr_8841ce2mxk",      "workspaceId": "ws_8f21ac4e9d0b7c11",      "name": "Van fleet – unit 14",      "type": "url",      "dynamic": true,      "status": "active",      "slug": "Xq7mK2p",      "domainId": null,      "shortUrl": "https://dotwick.co/Xq7mK2p",      "content": {        "type": "url",        "url": "https://example.com/fleet/van-014"      },      "design": {        "pattern": "rounded",        "eyes": {          "frame": "circle",          "ball": "circle"        },        "colors": {          "fg": "#18181B",          "bg": "#FFFFFF"        }      },      "rules": {        "routes": [],        "expiresAt": null,        "scanLimit": null,        "inactiveUrl": null,        "passwordProtected": false      },      "folderId": "fld_8k2m4q7x",      "templateId": null,      "createdBy": "u8Hk2LmN0pQ4rS6tV8wX0yZ2aB4cD6eF",      "createdAt": "2026-09-10T09:41:08.000Z",      "updatedAt": "2026-09-10T09:41:08.000Z",      "scans": 1284    }  ],  "nextCursor": "eyJ0IjoxNzU3NDk2ODY4fQ"}

More pages

When nextCursor is not null, pass it as cursor to get the next page. A key restricted to folders only sees codes in them. Scan counts can lag a few seconds behind the analytics endpoints.