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

# Retrieve link

> Requires the `links:read` scope. A link in another account returns `404`, the same as one that doesn't exist.



## OpenAPI

````yaml GET /links/{id}
openapi: 3.1.0
info:
  title: URLdn API
  version: 1.0.0
  description: >
    Create and manage short links, tags and custom domains, read click
    analytics, generate

    QR codes and ask the AI analyst. Included on every plan, with limits by
    plan. Limits apply

    to your whole account, across all its keys.


    Keep API keys on your server: anything in front-end code can be read by
    anyone.
servers:
  - url: https://api.urldn.com/v1
security:
  - apiKey: []
tags:
  - name: Links
  - name: Tags
  - name: Domains
  - name: Analytics
  - name: QR codes
  - name: AI analyst
  - name: Account
paths:
  /links/{id}:
    parameters:
      - $ref: '#/components/parameters/LinkId'
    get:
      tags:
        - Links
      summary: Retrieve link
      description: >-
        Requires the `links:read` scope. A link in another account returns
        `404`, the same as one that doesn't exist.
      operationId: getLink
      responses:
        '200':
          description: The link
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Link'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  parameters:
    LinkId:
      name: id
      in: path
      required: true
      schema:
        type: string
        pattern: ^[a-f0-9]{24}$
  schemas:
    Link:
      type: object
      required:
        - id
        - shortUrl
        - shortCode
        - url
        - domain
        - title
        - tags
        - isActive
        - isQrCode
        - hasPassword
        - expiresAt
        - createdAt
      properties:
        id:
          type: string
        shortUrl:
          type: string
          format: uri
        shortCode:
          type: string
        url:
          type: string
          format: uri
          description: The destination
        domain:
          type:
            - string
            - 'null'
          description: Your custom domain, or null for the default
        title:
          type:
            - string
            - 'null'
        tags:
          type: array
          items:
            type: string
        isActive:
          type: boolean
        isQrCode:
          type: boolean
        hasPassword:
          type: boolean
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
    Error:
      type: object
      required:
        - error
        - message
      properties:
        error:
          type: string
          description: A stable machine-readable code
          examples:
            - quota_exceeded
        message:
          type: string
        details:
          type: object
          additionalProperties: true
  responses:
    Unauthorized:
      description: '`missing_api_key`, `invalid_api_key` or `revoked_api_key`'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: '`plan_required`, `insufficient_scope` or `domain_not_allowed`'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: '`not_found`. Anything in another account also returns this.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    RateLimited:
      description: >-
        `rate_limited`, `monthly_quota_exceeded` or `too_many_auth_failures`.
        Wait for `Retry-After` seconds.
      headers:
        Retry-After:
          description: Seconds to wait before retrying
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: 'Your API key: `Authorization: Bearer urldn_live_...`'

````

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