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

# Get all Shortened URLs

> Get all URLs Shortened

## Get all Shortened URLs

Lists shortened URLs for the authenticated affiliate. Requires scope `shortener:read`.

### Query Parameters

| Parameter           | Default | Description                                 |
| ------------------- | ------- | ------------------------------------------- |
| `page`              | 1       | Page number                                 |
| `limit`             | 10      | Items per page (max 100)                    |
| `search`            | —       | Search in original or short URL             |
| `active`            | true    | Filter by active status                     |
| `organizationId`    | —       | Filter by brand UUID                        |
| `type`              | —       | Link type: Coupon, BrandPage, Offer, Custom |
| `startAt` / `endAt` | —       | Created-at period filter                    |

### Response

```json theme={null}
{
  "data": [
    {
      "originalUrl": "https://...",
      "shortUrl": "https://staging.lmdee.link/abc",
      "urlCode": "abc",
      "organizationId": "...",
      "active": true,
      "linkType": "Offer"
    }
  ],
  "meta": {
    "total": 6,
    "page": 1,
    "limit": 10,
    "totalPages": 1
  }
}
```

Detail lookup uses `urlCode` as path parameter: `GET /affiliate/shortener/urls/{urlCode}`.


## OpenAPI

````yaml GET /affiliate/shortener/urls
openapi: 3.1.0
info:
  title: Lomadee Public API
  description: >-
    REST API for affiliate brands, channels, campaigns, orders, products, and
    link shortener. Authenticate with x-api-key. Rate limit: 60 req/60s per key
    and IP.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.lomadee.com.br/
    description: Production — target URL for all integrations
  - url: https://api-beta.lomadee.com.br/
    description: Beta (legacy) — available during transition; will be retired soon
security:
  - x-api-key: []
paths:
  /affiliate/shortener/urls:
    get:
      description: Get all URLs Shortened
      parameters:
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          schema:
            type: integer
            default: 10
            maximum: 100
        - name: search
          in: query
          schema:
            type: string
        - name: active
          in: query
          schema:
            type: boolean
            default: true
        - name: organizationId
          in: query
          schema:
            type: string
        - name: type
          in: query
          description: Filter by link type (Coupon, BrandPage, Offer, Custom)
          schema:
            type: string
        - name: startAt
          in: query
          schema:
            type: string
            format: date-time
        - name: endAt
          in: query
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: Shorten URL response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllShortenURL'
          headers:
            X-RateLimit-Limit:
              description: Max requests per window
              schema:
                type: integer
            X-RateLimit-Remaining:
              description: Remaining requests in window
              schema:
                type: integer
            X-RateLimit-Reset:
              description: Unix timestamp when window resets
              schema:
                type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  schemas:
    AllShortenURL:
      required: []
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/ShortenURL'
        meta:
          $ref: '#/components/schemas/Meta'
    ShortenURL:
      type: object
      properties:
        originalUrl:
          description: The original URL
          type: string
        shortUrl:
          description: The short URL
          type: string
        urlCode:
          description: The unique identifier for the shortened URL
          type: string
        organizationId:
          description: The organization ID
          type: string
        active:
          description: If the URL is active
          type: boolean
        count:
          description: The count of clicks of the URL
          type: number
        linkType:
          description: The link type
          type: string
          enum:
            - Coupon
            - BrandPage
            - Offer
    Meta:
      type: object
      properties:
        total:
          type: integer
        page:
          type: integer
        limit:
          type: integer
        totalPages:
          type: integer
  responses:
    Unauthorized:
      description: API key missing or invalid
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
              code:
                type: string
    Forbidden:
      description: Valid key without required scope
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
              code:
                type: string
    TooManyRequests:
      description: Rate limit exceeded (60 req/60s per key + IP)
      headers:
        X-RateLimit-Limit:
          description: Max requests per window
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Remaining requests in window
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix timestamp when window resets
          schema:
            type: integer
        Retry-After:
          description: Seconds until retry
          schema:
            type: integer
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                example: false
              message:
                type: string
              code:
                type: string
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key

````