> ## 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.

# Get short link

> Get short link details.



## OpenAPI

````yaml /en/short-links-api/api-reference/openapi-short-links.json get /v1/short-links/{id}
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/{id}:
    get:
      tags:
        - Short links
      summary: Get short link
      description: Get short link details.
      operationId: ntfShortLinks_getV1ShortLinksById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: ID (cuid) do link.
      responses:
        '200':
          description: Detalhe do link.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfShortLinks_DetailResponse'
              examples:
                detail:
                  value:
                    success: true
                    data:
                      id: clshort01exampleid0001
                      workspaceId: clws_example_workspace01
                      domain: clicar.co
                      code: promo24
                      targetUrl: https://loja.exemplo.com/campanha?utm_source=sms
                      targetUrlHash: >-
                        e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
                      outboundAttribution: SMS:clmsg01exampleid0001
                      source: API
                      createdByUserId: null
                      expiresAt: null
                      deletedAt: null
                      isActive: true
                      clickCount: 128
                      createdAt: '2026-04-18T14:22:00.000Z'
                      updatedAt: '2026-04-19T10:00:00.000Z'
                      shortUrl: https://clicar.co/promo24
        '401':
          description: Missing or invalid API Key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfShortLinks_ErrorResponse'
        '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
        '404':
          description: Link inexistente ou removido.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfShortLinks_ErrorResponse'
              examples:
                notFound:
                  value:
                    success: false
                    error: Not Found
                    message: Short link not found
                    code: NOT_FOUND
components:
  schemas:
    NtfShortLinks_DetailResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/NtfShortLinks_ShortLinkFull'
    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_ShortLinkFull:
      type: object
      description: Modelo persistido + `shortUrl`; datas em ISO 8601.
      properties:
        id:
          type: string
        workspaceId:
          type: string
        domain:
          type: string
        code:
          type: string
        targetUrl:
          type: string
        targetUrlHash:
          type: string
          description: SHA-256 hex da URL normalizada.
        outboundAttribution:
          type: string
          description: >-
            Vazio = compartilhado; formato `CANAL:id` liga clique ao envio (SMS,
            WHATSAPP, …).
        source:
          type: string
          enum:
            - AUTO
            - MANUAL
            - API
        createdByUserId:
          type: string
          nullable: true
        expiresAt:
          type: string
          nullable: true
          format: date-time
        deletedAt:
          type: string
          nullable: true
          format: date-time
        isActive:
          type: boolean
        clickCount:
          type: integer
          minimum: 0
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        shortUrl:
          type: string
          format: uri
  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`'

````