---
title: "List short links"
method: GET
path: "/workspace/{workspace_id}/links/"
tags: ["Short links"]
---

# List short links

`GET /workspace/{workspace_id}/links/`

## Request

- Base URL: `https://hovercode.com/api/v2`
- URL: `https://hovercode.com/api/v2/workspace/{workspace_id}/links/`
- Auth: API key in header `Authorization`

Newest first. Paginated 50 per page (max 200). `q` searches destinations, display names and slugs.

## Path parameters

- `workspace_id` string, uuid, required

## Query parameters

- `q` string
- `page` integer
- `page_size` integer

## Response `200`

OK

- union: Page of short links.
  - object: DRF page-number pagination envelope.
    - `count` integer, required
    - `next` string, uri, nullable, required
    - `previous` string, uri, nullable, required
    - `results` LinkListItem[], required
      - `id` string, uuid, required
      - `link` string, required: Destination URL.
      - `link_type` 'Link'
      - `display_name` string, nullable
      - `short_url` string, uri, nullable, required
      - `slug` string, nullable
      - `domain` string, nullable
      - `total_clicks` integer
      - `unique_clicks` integer
      - `png` string, uri, nullable
      - `created` string, date-time, required
  - EmptyResults: Returned instead of a pagination envelope when the list is empty.
    - `message` 'No results found', required
    - `results` unknown[], required
      - unknown

## Other responses

- `401`: Missing or invalid API token.
- `404`: Not found, or not in a workspace you belong to.
- `429`: Rate limit exceeded. Wait `Retry-After` seconds before retrying.

---

[API](https://skmtc.dev/hovercode/apis/hovercode-api.md) · [All operations](https://skmtc.dev/hovercode/apis/hovercode-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hovercode/apis/hovercode-api/revisions/4a9bc3cafe41?raw)