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

# List links of the token's workspace, newest first

> Requires a token with the `links:read` permission.



## OpenAPI

````yaml /openapi.json get /api/v1/links
openapi: 3.0.0
info:
  description: >-
    Every request carries `Authorization: Bearer utmk_…`. The token fixes the
    workspace; no request names one. Every operation declares `x-permission`,
    the token permission it requires.
  title: UTM Builder API
  version: '1'
servers:
  - url: https://app.utmkit.co
    variables: {}
security:
  - bearer: []
tags: []
paths:
  /api/v1/links:
    get:
      tags:
        - links
      summary: List links of the token's workspace, newest first
      description: Requires a token with the `links:read` permission.
      operationId: UtmBuilderWeb.API.V1.LinkController.index
      parameters:
        - description: >-
            search string — free terms and key:value filters (spec 042); the
            keys are domain, code, tag, campaign (the container's name), state
            (live|pending|withdrawn), destination (unreachable|reachable),
            channel (misfiled|ok — where Google Analytics 4 will file the clicks
            against where the values were aiming), utm_source, utm_medium,
            utm_campaign, utm_term, utm_content; quote a value with spaces
          in: query
          name: q
          required: false
          schema:
            maxLength: 200
            type: string
        - description: cursor — id of the last link seen
          in: query
          name: after
          required: false
          schema:
            type: integer
        - description: ''
          in: query
          name: limit
          required: false
          schema:
            default: 100
            maximum: 100
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LinkList'
          description: Links
      callbacks: {}
components:
  schemas:
    LinkList:
      properties:
        data:
          items:
            $ref: '#/components/schemas/Link'
          type: array
        next_after:
          description: pass as `after` for the next page
          nullable: true
          type: integer
      title: LinkList
      type: object
    Link:
      properties:
        android_url:
          nullable: true
          type: string
        campaign_id:
          nullable: true
          type: integer
        created_at:
          format: date-time
          type: string
        created_by:
          properties:
            api_token_id:
              nullable: true
              type: integer
            user_id:
              type: integer
          type: object
        destination:
          type: string
        expires_at:
          format: date-time
          nullable: true
          type: string
        id:
          type: integer
        ios_url:
          nullable: true
          type: string
        note:
          nullable: true
          type: string
        qr_url:
          description: the short URL with the scan marker
          format: uri
          type: string
        short_code:
          type: string
        short_url:
          format: uri
          type: string
        state:
          enum:
            - live
            - pending
            - blocked
            - expired
          type: string
        tags:
          description: the link's tags, by name without regard to case
          items:
            properties:
              color:
                enum:
                  - gray
                  - red
                  - orange
                  - amber
                  - green
                  - teal
                  - blue
                  - purple
                type: string
              name:
                type: string
            type: object
          type: array
        utm_campaign:
          nullable: true
          type: string
        utm_content:
          nullable: true
          type: string
        utm_medium:
          nullable: true
          type: string
        utm_source:
          nullable: true
          type: string
        utm_term:
          nullable: true
          type: string
      title: Link
      type: object
  securitySchemes:
    bearer:
      description: utmk_<lookup><secret>, minted on /tokens
      scheme: bearer
      type: http

````