rizamodocs
Links

Get a short link

GET
/links/{id}

One short link, with its clicks so far, per day (UTC) and per country.

Authorization

apiKey
headerAuthorizationBearer <token>

An API key from the web app, under Developers. It starts with rz_live_.

Path Parameters

id*string

The short link's id (lnk_).

Lengthlength <= 100

Response Body

OK

application/json
  1. response
id*string
code*string
shortUrl*string

The link to share. It sends people on to url and counts the click.

url*string

Where it sends people.

profileId*|

The profile it belongs to. Null: it is its creator's (the person, key or agent that made it).

source*|null
createdBy*||||

Null when Rizamo made it on its own, such as for a comment automation.

clicks*integer

Clicks so far. Link previews and bots are not counted; one person clicking twice counts twice.

Range-9007199254740991 <= value <= 9007199254740991
expiresAt*|

From then on the link answers 404. Null: it never expires.

disabledAt*|

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
Formatdate-time
updatedAt*string
Formatdate-time
stats*
Example Request
curl -X GET 'https://api.rizamo.com/v1/links/lnk_01m4b3r6g0e48txnypr2tcytdp'
Example Response
{  "id": "lnk_01m4b3r6g0e48txnypr2tcytdp",  "code": "k7Qm2p",  "shortUrl": "https://go.rizamo.com/k7Qm2p",  "url": "https://cafelumen.pt/menu?utm_source=instagram&utm_medium=social&utm_campaign=winter-menu",  "profileId": "prof_01m40k9k80fxd8cvng8derm7g9",  "source": null,  "createdBy": {    "type": "agent",    "agent": "claudecode",    "name": "Claude Code",    "agentId": "agac_01m4rmaz80fs9a5amx5zbezkq2",    "onBehalfOf": {      "userId": "user_01m4pc7v40fdm89vjt5k51b5h8",      "name": "Ana Costa"    }  },  "clicks": 214,  "expiresAt": null,  "disabledAt": null,  "createdAt": "2026-11-04T10:12:31.000Z",  "updatedAt": "2026-11-04T10:12:31.000Z",  "stats": {    "days": [      {        "day": "2026-11-06",        "clicks": 151      },      {        "day": "2026-11-07",        "clicks": 63      }    ],    "countries": [      {        "country": "PT",        "clicks": 188      },      {        "country": "BR",        "clicks": 17      },      {        "country": "XX",        "clicks": 9      }    ]  }}

Create a short link POST

A short address on Rizamo's link host that sends people on to `url` and counts each click, by day and country. Nothing about the person who clicks is kept: no IP address, cookie or device. Link previews (Instagram, Facebook, WhatsApp, Slack, X and others) and bots are not counted. Without `profileId`, the link is yours (the person, key or agent that made it) and people limited to some profiles do not see it. A team makes up to 1,000 links in 24 hours, and only once it has a connected account or a paid plan (403 until then).

Update a short link PATCH

A new `url` applies to every click from now on, wherever the link was shared; it can take a minute to reach every place, at most 11 minutes in one under heavy load. `expiresAt` null makes it never expire. A new `url` needs the team to have a connected account or a paid plan, as making a link does.