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

# List links

`GET /v1/links`

## Request

- Base URL: `https://api.affiliaterail.com`
- URL: `https://api.affiliaterail.com/v1/links`
- Auth: HTTP bearer

**Scope:** `read`

## Query parameters

- `program_id` string, required: Required on every list
- `limit` string: 1 to 100, default 25
- `starting_after` string: Object id; returns the page after it (older)
- `ending_before` string: Object id; returns the page before it (newer)
- `expand[]` union: Relations to embed: partner
  - string
  - string[]
- `include[]` union: Extras to include: stats
  - string
  - string[]
- `partner_id` string

## Response `200`

Links

- LinkList
  - `data` Link[], required
    - `id` string, required: Prefixed id (`lnk_…`)
    - `object` 'link', required
    - `partner_id` string, required: Prefixed id (`part_…`)
    - `param` string, required
    - `value` string, required
    - `destination_url` string, required
    - `url` string, required: The destination with the tracking parameter applied
    - `short_url` string, nullable, required
    - `short_slug` string, nullable, required
    - `short_domain` string, nullable, required
    - `label` string, nullable, required
    - `rate_override` unknown
    - `stats` object
      - `clicks` integer, required
      - `referrals` integer, required
      - `customers` integer, required
    - `created_at` string, date-time, required: ISO-8601, UTC
    - `updated_at` string, date-time, required: ISO-8601, UTC
  - `has_more` boolean, required: Pass the last object's id as `starting_after` to fetch the next page
  - `total_count` integer, required: Count of every object matching the filters, ignoring the cursor

## Other responses

- `400`: Invalid request
- `401`: Missing or unknown API key
- `403`: Key lacks the required scope
- `404`: No such object in your organization
- `422`: The request was understood and refused
- `429`: Rate limited: see Retry-After

---

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