---
title: "List your links"
method: GET
path: "/urls"
tags: ["URLs"]
---

# List your links

`GET /urls`

## Request

- Base URL: `https://gajo.io/api/v1`
- URL: `https://gajo.io/api/v1/urls`
- Auth: API key in header `x-api-key`

Your links, newest first, including deactivated and expired links, one page at a time. `X-Total-Count` has the total; when more links remain, a `Link` header (`rel="next"`) points at the next page.

## Query parameters

- `page` integer
- `limit` integer

## Response `200`

Your links.

- ShortUrlListResult: Envelope shared by every response.
  - `success` true, required: `true` when the request succeeded.
  - `message` string, nullable: Human-readable status or error message. Often `null` on reads.
  - `data` ShortUrl[], required: Operation-specific payload; `null` or absent when there is nothing to return.
    - `shortCode` string, required: The short code. Generated codes are never reassigned.
    - `originalUrl` string, required: Destination URL (may be an app deep link on Pro).
    - `fallbackUrl` string, nullable, required: Web fallback used when `originalUrl` is an app deep link and the app is not installed (e.g. the App Store listing). `null` otherwise.
    - `active` boolean, required: `false` once the link has been deactivated.
    - `clickCount` integer, required: Human clicks (bot and link-preview traffic excluded).
    - `isCustomCode` boolean, required: `true` for Pro custom codes (served under `/c/`).
    - `createdDate` string, date-time, required
    - `expiresDate` string, date-time, nullable, required: When the link stops redirecting; `null` = never expires.

## Other responses

- `400`: `page` or `limit` is out of range.
- `401`: The `x-api-key` header is missing, or the key is unknown or revoked.
- `429`: Per-minute rate limit exceeded. Wait `Retry-After` seconds.
- `500`: Unexpected server error.

---

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