---
title: "List Links"
method: GET
path: "/links"
tags: ["Links"]
---

# List Links

`GET /links`

## Request

- Base URL: `https://api.rebrandly.com/v1`
- URL: `https://api.rebrandly.com/v1/links`
- Auth: API key in header `apikey`

Retrieves a paginated list of links in the specified workspace.

**Authorization:** Requires authenticated user with workspace access.

## Query parameters

- `limit` integer
- `orderBy` string
- `orderDir` 'asc' | 'desc'
- `last` string
- `domain.id` string
- `domain.fullName` string
- `slashtag` string
- `creator.id` string
- `favourite` boolean
- `status.active` boolean

## Headers

- `Workspace` string
- `apikey` string, required

## Response `200`

List of links

- Link[]
  - `id` string, required: Link public ID (link_public_id)
  - `title` string: Human-readable title for the link
  - `slashtag` string, required: URL path component
  - `destination` string, uri, required: Target URL where the link redirects
  - `shortUrl` string, required: Complete short URL (domain + slashtag)
  - `domainId` string: Public ID of the domain used
  - `domainName` string: Full domain name
  - `domain` object: Domain object with details
    - `id` string
    - `ref` string
    - `fullName` string
    - `sharing` object
  - `clicks` integer: Number of clicks on the link
  - `createdAt` string, date-time, required: Timestamp when link was created
  - `updatedAt` string, date-time, required: Timestamp when link was last updated
  - `status` 'active' | 'deleted' | 'blocked', required: Link status
  - `description` string: Link description (only if links.notes feature is enabled)
  - `workspace` object: Workspace information
    - `id` string: Workspace public ID
  - `https` boolean: Whether the link supports HTTPS

## Other responses

- `401`: Unauthorized - Missing or invalid authentication

---

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