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

# List short links

`GET /links`

## Request

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

Newest first, a page at a time: pass `nextCursor` as `cursor` for the next one.

## Query parameters

- `profileId` string: Only this profile's (`prof_`): one brand or client, from List profiles. A profile you do not reach is refused as not found.
- `sourceType` 'comment_automation' | 'post': Only links Rizamo made for this kind of thing.
- `sourceId` string: Only links made for this comment automation or post.
- `limit` integer: How many to return, up to 200: 100 when left out.
- `cursor` string: `nextCursor` from the page before.

## Response `200`

OK

- object
  - `items` Link[], required
    - `id` string, required
    - `code` string, required
    - `shortUrl` string, required: The link to share. It sends people on to `url` and counts the click.
    - `url` string, required: Where it sends people.
    - `profileId` string, nullable, required: The profile it belongs to. Null: it is its creator's (the person, key or agent that made it).
    - `source` object, nullable, required: What made the link, when Rizamo made it for something: a comment automation's messages or a post. Null for links made through the API.
      - `type` 'comment_automation' | 'post', required
      - `id` string, required
    - `createdBy` union, required
      - object
        - `type` 'agent', required
        - `agent` 'claude' | 'chatgpt' | 'claudecode' | 'cursor' | 'codex' | 'gemini' | 'perplexity' | 'openclaw' | 'n8n' | 'make' | 'zapier', nullable, required
        - `name` string, required
        - `agentId` string
        - `onBehalfOf` object: The person whose agent it is, who connected it and whom it acts as, with their role: "Ana via Claude Code". Events from before 2026-11-02 have it too, with the person's name now. Left out of an agent with no person, and of other records from before. After the person's erasure, `name` is "A former member" and `userId` empty.
          - `userId` string, required
          - `name` string, required
      - object
        - `type` 'user', required
        - `userId` string, required
        - `name` string, required
        - `initials` string, required
      - object
        - `type` 'api_key', required
        - `keyId` string, required
        - `name` string, required
      - object
        - `type` 'automation', required
        - `automationId` string, required
        - `name` string, required
    - `clicks` integer, required: Clicks so far. Link previews and bots are not counted; one person clicking twice counts twice.
    - `expiresAt` string, date-time, nullable, required: From then on the link answers 404. Null: it never expires.
    - `disabledAt` string, date-time, nullable, required: When Rizamo disabled it for breaking the Acceptable Use Policy: it answers 404 from then on, whatever changes. Null for every other link.
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `nextCursor` string, nullable, required: Null on the last page.

## Other responses

- `400`: `invalid_request`: A field is missing or wrong, or the request cannot be done as asked: the message names the field or says what to change.
- `401`: `unauthorized`: No API key or sign-in, or the key does not work: it was deleted, or it expired.
- `403`: `forbidden`: The caller may not do this: the key or agent lacks the scope (the message names it), or the action needs another role or a fresh sign-in.
- `404`: `not_found`: No such object, or it is outside your team or the profiles your key reaches.
- `429`: `rate_limited`: Over one of Rizamo's limits, or a network asked Rizamo to slow down: wait for `Retry-After` seconds, or as long as the message says.
- `500`: `internal`: Our side failed: retry, and send the `requestId` if it keeps failing.
- `503`: `timeout`: The request took too long to work out, most often a report: try again in a moment, or ask a report for a shorter period or one profile.

---

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