KuikCodeDocs
APIReferenceCodes

List codes

GET
/codes

Active codes, most recently changed first. Filter by folder, tag or name; archived=true lists archived codes instead.

Authorization

apiKey
AuthorizationBearer <token>

An API key from Settings, Developers: Authorization: Bearer kc_live_...

In: header

Query Parameters

limit?integer

Items per page, 1 to 100.

Range1 <= value <= 100
Default50
cursor?string

The next_cursor from the previous page. Omit for the first page.

archived?string

true lists archived codes instead of active ones.

Default"false"

Value in

  • "true"
  • "false"
folderId?string

Only codes in this folder. Use root for unfiled codes.

tag?string
q?string

Name contains.

Lengthlength <= 200
sort?string
Default"updated"

Value in

  • "updated"
  • "created_desc"
  • "created_asc"
  • "name"
  • "scans"

Response Body

application/json

application/json

curl -X GET "https://example.com/codes"
{  "data": [    {      "id": "string",      "shortCode": "string",      "name": "string",      "scanUrl": "string",      "destination": {        "type": "string",        "url": "string",        "pageId": "string",        "fallbackUrl": "string",        "rules": [          {            "name": "string",            "url": "http://example.com",            "conditions": [              {                "type": "time",                "operator": "before",                "value": "string",                "valueEnd": "string"              }            ],            "joins": [              "and"            ]          }        ],        "summary": "string"      },      "folderId": "string",      "tags": [        "string"      ],      "archived": true,      "hasAccessCode": true,      "previewUrl": "string",      "scans": 0,      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string"}

Who am I GET

The key you are calling with, the workspace it belongs to, the plan's ceilings and current usage. The first call every integration should make.

Create a code POST

Creates a dynamic KuikCode. The destination is a URL, a KuikPage, or smart rules (PRO) that send scans to different places by device, country, language, time, date, weekday, scan count or location. Send an `Idempotency-Key` header to make retries safe.