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

# Listar enlaces cortos

> Lista los enlaces cortos creados en tu cuenta.



## OpenAPI

````yaml /es/short-links-api/api-reference/openapi-short-links.json get /v1/short-links
openapi: 3.0.3
info:
  title: 'API de notificación: enlaces cortos'
  description: >-
    API para **crear**, **enumerar**, **actualizar** y **eliminar** enlaces
    cortos del espacio de trabajo (dominio predeterminado **clicar.co** o según
    configuración), además de **análisis** (series temporales y pausas) y
    **lista de clics individuales**.


    **Autenticación:** Clave API en `Authorization: Bearer sk_live_xxxxx` o
    `x-api-key: sk_live_xxxxx`. El **espacio de trabajo** es siempre el de la
    clave (cada clave API pertenece a un espacio de trabajo); **no** envíe
    `x-workspace-id` en API v1: las solicitudes con este encabezado completado
    reciben **400** (`WORKSPACE_HEADER_NOT_ALLOWED`).


    **Ámbitos:** `short_links:read` (OBTENER) y `short_links:manage` (POST,
    PATCH, BORRAR).
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Producción
security:
  - ntfShortLinksBearerAuth: []
  - ntfShortLinksApiKeyHeader: []
tags:
  - name: Enlaces cortos
    description: CRUD, listado, análisis y eventos de clic en `/v1/short-links`.
paths:
  /v1/short-links:
    get:
      tags:
        - Short links
      summary: Listar enlaces cortos
      description: Lista los enlaces cortos creados en tu cuenta.
      operationId: ntfShortLinks_getV1ShortLinks
      parameters:
        - name: page
          in: query
          schema:
            type: string
          description: >-
            Número de página (≥ 1). Valor predeterminado: `1`. Los valores no
            numéricos caen a `1`.
        - name: limit
          in: query
          schema:
            type: string
          description: >-
            Artículos por página (1–100). Valor predeterminado: `20`. Se ajustan
            los valores fuera del rango.
        - name: source
          in: query
          schema:
            type: string
            enum:
              - AUTO
              - MANUAL
              - API
          description: Filtra por fuente de enlace. Omitir para todos.
      responses:
        '200':
          description: Lista paginada de enlaces.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfShortLinks_ListResponse'
              examples:
                success:
                  summary: Lista con dos artículos
                  value:
                    success: true
                    data:
                      - id: clshort01exampleid0001
                        code: promo24
                        domain: clicar.co
                        targetUrl: https://loja.exemplo.com/campanha?utm_source=sms
                        shortUrl: https://clicar.co/promo24
                        source: API
                        isActive: true
                        clickCount: 128
                        createdAt: '2026-04-18T14:22:00.000Z'
                        expiresAt: null
                      - id: clshort01exampleid0002
                        code: a3K9m
                        domain: clicar.co
                        targetUrl: https://docs.exemplo.com/onboarding
                        shortUrl: https://clicar.co/a3K9m
                        source: AUTO
                        isActive: true
                        clickCount: 12
                        createdAt: '2026-04-17T09:00:00.000Z'
                        expiresAt: '2026-12-31T23:59:59.000Z'
                    pagination:
                      page: 1
                      limit: 20
                      total: 2
                      totalPages: 1
        '401':
          description: Clave API faltante o no válida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfShortLinks_ErrorResponse'
              examples:
                unauthorized:
                  value:
                    success: false
                    error: Unauthorized
                    message: Invalid or missing API Key
                    code: UNAUTHORIZED
        '402':
          description: Espacio de trabajo bloqueado (plan caducado o suspendido).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfShortLinks_ErrorResponse'
              examples:
                paymentRequired:
                  value:
                    success: false
                    error: Payment Required
                    message: Plan expired or suspended
                    code: WORKSPACE_BLOCKED
        '403':
          description: Falta el alcance `short_links:read`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfShortLinks_ErrorResponse'
              examples:
                forbiddenScope:
                  value:
                    success: false
                    error: Forbidden
                    message: 'Missing scope: short_links:read'
                    code: FORBIDDEN
components:
  schemas:
    NtfShortLinks_ListResponse:
      type: object
      required:
        - success
        - data
        - pagination
      properties:
        success:
          type: boolean
          example: true
        data:
          type: array
          items:
            $ref: '#/components/schemas/NtfShortLinks_ListItem'
        pagination:
          $ref: '#/components/schemas/NtfShortLinks_Pagination'
    NtfShortLinks_ErrorResponse:
      type: object
      description: Error genérico de API v1 (enlaces cortos).
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: >-
            Etiqueta de error de estilo HTTP (por ejemplo, no autorizado,
            solicitud incorrecta, no encontrada).
        message:
          type: string
          nullable: true
          description: >-
            Mensaje legible por humanos para usuarios finales (localizado a
            través de Accept-Language/x-locale cuando corresponda).
        code:
          type: string
          nullable: true
          description: >-
            Código API v1 estable (enumeración). Siempre presente en los
            errores. Úselo con el estado HTTP para decidir reintentar o
            corregir. Ver [Respuestas de
            error](/es/guides/conceitos/resposta-de-erros).
      required:
        - success
        - error
        - message
        - code
    NtfShortLinks_ListItem:
      type: object
      required:
        - id
        - code
        - domain
        - targetUrl
        - shortUrl
        - source
        - isActive
        - clickCount
        - createdAt
        - expiresAt
      properties:
        id:
          type: string
        code:
          type: string
        domain:
          type: string
        targetUrl:
          type: string
        shortUrl:
          type: string
          format: uri
        source:
          type: string
          enum:
            - AUTO
            - MANUAL
            - API
        isActive:
          type: boolean
        clickCount:
          type: integer
          minimum: 0
        createdAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          nullable: true
          format: date-time
    NtfShortLinks_Pagination:
      type: object
      required:
        - page
        - limit
        - total
        - totalPages
      properties:
        page:
          type: integer
          minimum: 1
        limit:
          type: integer
          minimum: 1
          maximum: 100
        total:
          type: integer
          minimum: 0
        totalPages:
          type: integer
          minimum: 1
  securitySchemes:
    ntfShortLinksBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Clave API sin autorización de encabezado. Ejemplo: `Authorization:
        Bearer sk_live_xxxxx`
    ntfShortLinksApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'Clave API sin encabezado x-api-key. Ejemplo: `x-api-key: sk_live_xxxxx`'

````