> ## Documentation Index
> Fetch the complete documentation index at: https://docs.kealinks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List links

> Most recent first, archived links excluded. Capped at 200.



## OpenAPI

````yaml /openapi.json get /api/links
openapi: 3.1.0
info:
  title: kealink API
  version: '2026-08-21'
  description: >-
    Permanent link shortening and dynamic QR codes.


    **A code we issue never stops resolving.** Not when the destination changes,
    not

    when a subscription lapses, not when the link is archived. Customers print
    these

    on physical materials, so a dead redirect is a reprint bill. Every design

    decision below follows from that.


    ### Authentication


    Send an API key as `Authorization: Bearer klk_...`. Mint one with

    `POST /api/billing/claim`. Keys are stored hashed and shown exactly once.


    ### Paying as an agent


    You do not need an account. `POST /api/links` with no credentials answers

    `402` with a machine-payment challenge — MPP (`WWW-Authenticate: Payment`)
    and

    x402 (`PAYMENT-REQUIRED`) on the same response. Pay either one, retry, and
    you

    get a permanent link plus an API key to repoint it with later.


    ### Errors


    Always `{ "error": "a sentence" }` with a real status code. `402` means this

    action needs payment — never that existing links stopped working.
  contact:
    name: kealink support
    url: https://kealinks.com
servers:
  - url: https://api.kealinks.com
    description: Production
security: []
tags:
  - name: Links
    description: Create and repoint permanent codes.
  - name: QR codes
    description: Print-ready artwork for a link.
  - name: Analytics
    description: Scans and clicks, by day, country, device or referrer.
  - name: Domains
    description: Serve your codes on your own hostname.
  - name: Account
    description: Tier, quota and what this account may do.
  - name: Billing
    description: Subscription lifecycle.
  - name: Team
    description: Workspaces and members.
  - name: Machine payments
    description: Buy a permanent link with no account, over MPP or x402. Built for agents.
  - name: Meta
    description: Discovery and health.
paths:
  /api/links:
    get:
      tags:
        - Links
      summary: List links
      description: Most recent first, archived links excluded. Capped at 200.
      operationId: listLinks
      responses:
        '200':
          description: Your links.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkList'
        '401':
          description: Missing or invalid credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    LinkList:
      type: object
      properties:
        links:
          type: array
          items:
            $ref: '#/components/schemas/LinkSummary'
      required:
        - links
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: string
          description: A sentence you can show a human. Never a code to switch on.
          examples:
            - Your subscription is inactive. Existing links keep resolving.
      required:
        - error
      additionalProperties: false
      description: >-
        Every failure returns this shape with a real status code. 402
        specifically means 'inactive subscription, existing links still work' —
        the message says so.
    LinkSummary:
      type: object
      properties:
        id:
          type: string
        slug:
          type: string
          description: >-
            The path segment the code resolves on. Drawn from an unambiguous
            alphabet (no 0/O, no 1/l/I) because people type these off printed
            material. Omit on create and one is allocated for you.
          examples:
            - m4rq7bd
        destination:
          type: string
          minLength: 1
          description: >-
            Where the code resolves to. http/https only; localhost, private
            ranges and cloud metadata endpoints are refused. Stored normalised,
            so `HTTPS://Example.COM` and `https://example.com/` are the same
            link.
          format: uri
          examples:
            - https://example.com/spring-menu
        status:
          type: integer
          description: >-
            0 = active, 1 = quarantine, 2 = abuse. Every link is created in
            quarantine, which forces a live safety check on each resolution
            until the link earns release: three clean checks once it is at least
            seven days old. Quarantine is a property of the link, never of the
            account — it is not a paywall and a quarantined link still resolves.
          examples:
            - 1
        created_at:
          type: integer
          description: When the link was created. Epoch milliseconds.
          examples:
            - 1755734400000
        host:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The custom domain this link resolves on, or null for the default
            domain.
          examples:
            - null
      required:
        - id
        - slug
        - destination
        - status
        - created_at
        - host
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key (`klk_...`) or a Clerk session token. Both resolve to the
        same account and behave identically.

````