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

# List links

> Retrieve a paginated list of links for the workspace.



## OpenAPI

````yaml GET /links
openapi: 3.0.3
info:
  title: linkutm API
  version: 1.0.0
  description: >-
    REST API for linkutm — short links, UTM tagging, custom domains, folders,
    tags and click analytics.


    Every endpoint documented here is served under
    `https://api.linkutm.com/api/v1`.
servers:
  - url: https://api.linkutm.com/api/v1
    description: Local development
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Links
    description: Create, read, update and delete short links, individually or in bulk.
  - name: Domains
    description: Register and verify the custom domains short links are served from.
  - name: Folders
    description: Group links into folders.
  - name: Tags
    description: Label links and manage which links carry which tag.
  - name: Analytics
    description: Click analytics for the workspace and for individual links.
  - name: Imports
    description: Migrate links in from Short.io, Bitly and Rebrandly.
paths:
  /links:
    get:
      tags:
        - Links
      summary: List links
      description: Retrieve a paginated list of links for the workspace.
      operationId: listLinks
      parameters:
        - name: page
          in: query
          required: false
          description: 1-based page number.
          schema:
            type: integer
            minimum: 1
            default: 1
        - name: limit
          in: query
          required: false
          description: Rows per page.
          schema:
            type: integer
            minimum: 1
            default: 20
        - name: search
          in: query
          required: false
          description: >-
            Case-insensitive match against title, destination URL, description,
            short code and short URL.
          schema:
            type: string
        - name: utmSource
          in: query
          required: false
          description: Comma-separated list of `utm_source` values to include.
          schema:
            type: string
        - name: utmMedium
          in: query
          required: false
          description: Comma-separated list of `utm_medium` values to include.
          schema:
            type: string
        - name: archived
          in: query
          required: false
          description: >-
            `true` returns archived links **instead of** active ones. Any other
            value returns active links.
          schema:
            type: string
            enum:
              - 'true'
              - 'false'
            default: 'false'
        - name: folderId
          in: query
          required: false
          description: >-
            Comma-separated folder IDs. The literal value `unsorted` matches
            links with no folder.
          schema:
            type: string
        - name: tagIds
          in: query
          required: false
          description: Comma-separated tag IDs. A link matches if it carries any of them.
          schema:
            type: string
        - name: dateFrom
          in: query
          required: false
          description: Only links created at or after this instant.
          schema:
            type: string
            format: date-time
        - name: dateTo
          in: query
          required: false
          description: Only links created at or before this instant.
          schema:
            type: string
            format: date-time
        - name: orderBy
          in: query
          required: false
          description: Sort order.
          schema:
            type: string
            enum:
              - date_created
              - date_updated
              - clicks
              - title
            default: date_created
      responses:
        '200':
          description: A page of links.
          content:
            application/json:
              schema:
                type: object
                properties:
                  links:
                    type: array
                    items:
                      $ref: '#/components/schemas/LinkListItem'
                  pagination:
                    $ref: '#/components/schemas/Pagination'
        '400':
          description: >-
            Validation failed, or a required header or query parameter is
            missing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 400
                message:
                  - Destination URL is required
                error: Bad Request
        '401':
          description: Missing, malformed, expired or revoked credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 401
                message: Invalid or expired API key
                error: Unauthorized
        '403':
          description: >-
            Authenticated, but the role, plan or workspace membership does not
            allow this call.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 403
                message: Please upgrade your plan to create more links.
                error: Forbidden
        '404':
          description: The workspace slug in `x-workspace-id` does not resolve.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 404
                message: Link not found
                error: Not Found
        '500':
          description: Unexpected server error. Safe to retry with backoff.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                statusCode: 500
                message: Internal server error
components:
  schemas:
    LinkListItem:
      type: object
      description: >-
        Link as returned by `GET /links`. This is a **different, flatter shape**
        than the detail record: it adds `shortUrl`, `folder` and `creator`, and
        omits the workspace, audit and safety columns.
      properties:
        id:
          type: string
          format: uuid
        url:
          type: string
        shortCode:
          type: string
        shortUrl:
          type: string
          description: >-
            Absolute short URL, built from the link's domain or the system
            default domain.
          nullable: true
          example: https://telzi.com/spring-sale
        title:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        favicon:
          type: string
          nullable: true
        clicks:
          type: integer
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        utmSource:
          type: string
          nullable: true
        utmMedium:
          type: string
          nullable: true
        utmCampaign:
          type: string
          nullable: true
        utmTerm:
          type: string
          nullable: true
        utmContent:
          type: string
          nullable: true
        customUtmParams:
          type: object
          nullable: true
          additionalProperties:
            type: string
        templateId:
          type: string
          format: uuid
          nullable: true
        hasPassword:
          type: boolean
        expiresAt:
          type: string
          format: date-time
          nullable: true
        scheduledAt:
          type: string
          format: date-time
          nullable: true
        schedulingTimezone:
          type: string
          nullable: true
        fallbackUrl:
          type: string
          nullable: true
        clickLimit:
          type: integer
          nullable: true
        iosUrl:
          type: string
          nullable: true
        androidUrl:
          type: string
          nullable: true
        geoTargets:
          type: object
          nullable: true
          additionalProperties:
            type: string
        geoTargetingEnabled:
          type: boolean
        ogTitle:
          type: string
          nullable: true
        ogDescription:
          type: string
          nullable: true
        ogImage:
          type: string
          nullable: true
        comments:
          type: string
          nullable: true
        qrCodeEnabled:
          type: boolean
        qrFgColor:
          type: string
          nullable: true
        qrBgColor:
          type: string
          nullable: true
        qrSize:
          type: integer
          nullable: true
        qrDesign:
          type: object
          nullable: true
          additionalProperties: true
        cloakingEnabled:
          type: boolean
        archived:
          type: boolean
        folderId:
          type: string
          format: uuid
          nullable: true
        domainId:
          type: string
          format: uuid
          nullable: true
        folder:
          type: object
          nullable: true
          properties:
            id:
              type: string
            name:
              type: string
              nullable: true
            color:
              type: string
              nullable: true
        domain:
          type: object
          nullable: true
          properties:
            id:
              type: string
            domain:
              type: string
              example: go.acme.com
            verified:
              type: boolean
        creator:
          type: object
          nullable: true
          description: Workspace member who created the link.
          properties:
            id:
              type: string
            name:
              type: string
              nullable: true
            avatar:
              type: string
              nullable: true
        tags:
          type: array
          items:
            type: object
            description: Join row between a link and a tag.
            properties:
              id:
                type: string
                description: ID of the join row, not of the tag.
              tag:
                type: object
                properties:
                  id:
                    type: string
                  name:
                    type: string
                    example: paid-social
                  color:
                    type: string
                    example: '#f97316'
        pixels:
          type: array
          items:
            type: object
            properties:
              pixelId:
                type: string
    Pagination:
      type: object
      description: Offset pagination. Used by `GET /links` and `GET /tags/{id}/links`.
      properties:
        page:
          type: integer
          example: 1
        limit:
          type: integer
          example: 20
        total:
          type: integer
          description: Total rows matching the filter.
          example: 137
        pages:
          type: integer
          description: Total pages at the current `limit`.
          example: 7
    Error:
      type: object
      description: >-
        Standard NestJS error envelope. `message` is a string for exceptions
        thrown by a service, and an array of strings when the global
        ValidationPipe rejects the body.
      properties:
        statusCode:
          type: integer
          example: 400
        message:
          description: Human-readable reason, or a list of field-level validation errors.
          oneOf:
            - type: string
            - type: array
              items:
                type: string
          example: Link not found
        error:
          type: string
          example: Bad Request
      required:
        - statusCode
        - message
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: 'Workspace API key, sent as `Authorization: Bearer lk_live_…`.'
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Dashboard session token from `POST /auth/login`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.