KuikCodeDocs

API, Zapier and AI assistants

Create and manage KuikLinks from your own systems with the API, from Zapier, or by asking an AI assistant.

Everything you do with KuikLinks in the dashboard can also be done from outside it. The API and Zapier are included from PRO; AI assistants (MCP) are included in Business.

API

Links have their own resource, /links, next to /codes. Send your API key as a bearer token, as with every call; see Authentication.

curl https://api.kuikcode.com/v1/links \
  -H "Authorization: Bearer kc_live_..." \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f1c2a9e-spring-sale" \
  -d '{
    "url": "https://example.com/spring-sale",
    "name": "Spring sale",
    "slug": "spring-sale",
    "tags": ["campaign"],
    "utm": { "source": "newsletter", "medium": "email" }
  }'

The answer carries the address to share in shortUrl:

{
  "id": "L7c2Qp9XrT4vBn81ZsKdE",
  "name": "Spring sale",
  "url": "https://example.com/spring-sale",
  "shortUrl": "https://kuik.sh/spring-sale",
  "state": "ok",
  "clicks": 0
}
CallWhat it does
GET /linksList links. Filter with q, folderId, tag, tenantId or externalId
POST /linksCreate a link
GET /links/{id}Read one link
PATCH /links/{id}Change a link. Send only the fields that change
DELETE /links/{id}Delete a link
POST /links/bulkCreate many links, all or nothing. dryRun: true only checks
POST /links/{id}/codeMake a KuikCode that opens the link
GET /scans?kind=linkRead clicks. Add linkId for one link
POST /track/lead, POST /track/saleReport a lead or a sale for a click. See Conversion tracking

Things to know:

  • A refused address answers 422 with the code url_refused. The message says why: the address is malformed, it is another short link, or it is listed as unsafe. Other errors work as in the rest of the API; see Errors.
  • state tells you if a link is live. ok is live. review and flagged are live behind a notice page. blocked does not redirect. See Safety.
  • externalId is your own id for a link, unique in the workspace. Use it to find a link you created from your system: GET /links?externalId=order-10432.
  • Plan limits apply as in the dashboard: the links per month, readable endings from Core, expiration from PRO. A refusal answers 403 and names the limit.
  • Clicks and scans are never mixed. GET /scans and the analytics calls read KuikCode scans unless you send kind=link. On a click, via is qr when the visit came through the link's KuikCode.
  • Send an Idempotency-Key header on POST so a retry never creates a second link; see Idempotency.

Zapier

The KuikCode app for Zapier has three steps for links:

StepWhat it does
New Short Link Click (trigger)Starts a Zap when someone opens one of your links, or one link you pick
Create Short Link (action)Creates a link and returns the short address
Find Short Link (search)Finds a link by its destination, name or ending, and can create it when none matches

Connect your workspace as described in KuikCode app for Zapier.

AI assistants

With the MCP server connected, an assistant can work with your links in plain words: "shorten this link and call it Spring sale", "point the newsletter link at the new page", "how many clicks did the bio link get this week", "make a QR code for that link".

It can list, read, create and update links, make a KuikCode for a link and read clicks. It cannot delete a link.

On this page