Return to top
On this page

Links

All endpoints need authentication. Base URL: https://api.revolink.link/apiv2.

Endpoints

MethodURLPermissionDescription
GET/apiv2/linkslinks:readList links
POST/apiv2/linkslinks:writeCreate a link
PUT/apiv2/linkslinks:writeCreate or update by slug
GET/apiv2/links/{id}links:readGet a link
PATCH/apiv2/links/{id}links:writeUpdate a link
DELETE/apiv2/links/{id}links:deleteDelete a link (permanent)
POST/apiv2/links/bulklinks:bulkCreate up to 100 links
PATCH/apiv2/links/bulklinks:bulkUpdate up to 100 links
DELETE/apiv2/links/bulklinks:bulkDelete up to 100 links

Click analytics of a link: GET /apiv2/links/{id}/analytics.

GET https://api.revolink.link/apiv2/links

Query parameterDescription
page, limitPage (default 1) and page size (default 50, maximum 200)
searchSubstring of the name, slug or description
domainShort domain. Several separated by commas
activetrue or false
tagIdsTag IDs separated by commas
sortByname, description, shortLink, clicks, active or createdAt (default)
orderasc or desc (default)
rqlA filter in the Revolink query language, see Advanced Filters
bash
curl "https://api.revolink.link/apiv2/links?search=sale&sortBy=clicks&order=desc" \
  -H "Authorization: Bearer rvlnk_your_api_key_here" \
  -H "X-Workspace-Id: your_workspace_id"

POST https://api.revolink.link/apiv2/links

Send url for a link with one destination, or rules for smart routing (exactly one default rule). name defaults to the host of the destination, slug is generated when omitted, domain defaults to rvlnk.link and may be a verified domain of the workspace.

bash
curl -X POST https://api.revolink.link/apiv2/links \
  -H "Authorization: Bearer rvlnk_your_api_key_here" \
  -H "X-Workspace-Id: your_workspace_id" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/spring-sale",
    "slug": "spring",
    "expirationDate": "2026-12-31T23:59:59Z"
  }'

Response 201 Created: { "data": { …the link… } }.

Smart routing

json
{
  "name": "App download",
  "rules": [
    { "isDefault": true, "targetUrl": "https://example.com/download" },
    { "isDefault": false, "targetUrl": "https://apps.apple.com/app/id1", "device": ["mobile"], "os": ["iOS"] }
  ]
}

A rule can match on country, region, city, device, os, browser, locale, timeStart and timeEnd (HH:MM, UTC) and daysOfWeek (0 = Sunday). A rule may also have a password.

Other fields

description, active, tagIds, clicksLimit, expirationDate, expiredUrl, conversionTracking, gpsTracking, shareStats, abTest, ogTitle, ogDescription, appearanceColor, qrColor, qrBgColor, qrShowLogo. Types and limits of every field are in the interactive reference.

PUT https://api.revolink.link/apiv2/links

slug is required. If a link with this slug exists on this domain it is updated (its slug and domain stay) and the API answers 200. Otherwise it is created and the API answers 201.

PATCH https://api.revolink.link/apiv2/links/{id}

Send only what changes.

  • url replaces the destination of the default rule.
  • rules, when sent, replace all rules. Keep the id of every rule you want to keep: it preserves the statistics of that rule.
  • tagIds is the full list of tags. An empty array removes all tags.
bash
curl -X PATCH https://api.revolink.link/apiv2/links/LINK_ID \
  -H "Authorization: Bearer rvlnk_your_api_key_here" \
  -H "X-Workspace-Id: your_workspace_id" \
  -H "Content-Type: application/json" \
  -d '{ "active": false }'

Bulk operations

RequestBody
POST /apiv2/links/bulk{ "links": [ …link objects as in create… ] }
PATCH /apiv2/links/bulk{ "updates": [ { "id": "…", …fields to change… } ] }
DELETE /apiv2/links/bulk{ "ids": [ "…", "…" ] }

Each request takes 1 to 100 items. The response reports every item separately, see Errors and responses.