> ## 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. # List short links > List short links created in your account. ## OpenAPI ````yaml /en/short-links-api/api-reference/openapi-short-links.json get /v1/short-links openapi: 3.0.3 info: title: Notifique API. Links curtos (Short Links) description: >- API para **criar**, **listar**, **atualizar** e **remover** links curtos do workspace (domínio padrão **clicar.co** ou o configurado), além de **analytics** (série temporal e quebras) e **lista de cliques** individuais. **Autenticação:** API Key em `Authorization: Bearer sk_live_xxxxx` ou `x-api-key: sk_live_xxxxx`. O **workspace** é sempre o da chave (cada API Key pertence a um workspace); **não** envie `x-workspace-id` na API v1, requisições com esse cabeçalho preenchido recebem **400** (`WORKSPACE_HEADER_NOT_ALLOWED`). **Escopos:** `short_links:read` (GET) e `short_links:manage` (POST, PATCH, DELETE). version: 1.0.0 servers: - url: https://api.notifique.dev description: Production security: - ntfShortLinksBearerAuth: [] - ntfShortLinksApiKeyHeader: [] tags: - name: Short links description: CRUD, listagem, analytics e eventos de clique em `/v1/short-links`. paths: /v1/short-links: get: tags: - Short links summary: List short links description: List short links created in your account. operationId: ntfShortLinks_getV1ShortLinks parameters: - name: page in: query schema: type: string description: >- Número da página (≥ 1). Padrão: `1`. Valores não numéricos caem para `1`. - name: limit in: query schema: type: string description: >- Itens por página (1–100). Padrão: `20`. Valores fora do intervalo são ajustados. - name: source in: query schema: type: string enum: - AUTO - MANUAL - API description: Filtra pela origem do link. Omitir para todos. responses: '200': description: Lista paginada de links. content: application/json: schema: $ref: '#/components/schemas/NtfShortLinks_ListResponse' examples: success: summary: Lista com dois itens 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: Missing or invalid API Key. 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: Workspace bloqueado (plano expirado ou suspenso). 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: Escopo `short_links:read` ausente. 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: Erro genérico da API v1 (short links). properties: success: type: boolean example: false error: type: string description: HTTP-style error label (e.g. Unauthorized, Bad Request, Not Found). message: type: string nullable: true description: >- Human-readable message for end users (localized via Accept-Language / x-locale when applicable). code: type: string nullable: true description: >- Stable API v1 code (enum). Always present on errors. Use with the HTTP status to decide retry or fix. See [Error responses](/en/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: >- API Key no header Authorization. Exemplo: `Authorization: Bearer sk_live_xxxxx` ntfShortLinksApiKeyHeader: type: apiKey in: header name: x-api-key description: 'API Key no header x-api-key. Exemplo: `x-api-key: sk_live_xxxxx`' ````