Skip to main content
GET
List shortcuts

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

cursor
string

Opaque pagination token returned as nextCursor from the previous page. Omit on the first request.

limit
integer
default:50

Page size. Out-of-range values are clamped to [1, 100]; defaults to 50.

Required range: 1 <= x <= 100
externalId
string

Filter to shortcuts whose externalId equals this value. The ext_ prefix is recommended for visual disambiguation from internal IDs, but the server accepts both prefixed (ext_<value>) and bare (<value>) forms. Combine with tenantId for multi-tenant lookups.

Required string length: 1 - 259
tenantId
string

Filter to shortcuts whose tenantId equals this value.

Required string length: 1 - 255
query
string

Free-text search over slug and title, using the same full-text and trigram matching as the in-app search. Results are relevance-ranked, which suppresses nextCursor — a search returns the first page only.

Required string length: 1 - 255
sort
enum<string>
default:clicks

Ordering. clicks (the default) orders by the workspace-wide click total; trending by 7-day relative change (only shortcuts with at least 5 clicks in each of the last two 7-day windows are scored — the rest sort last); myLastClick by the authenticated caller's own last click. Available on every plan: click-count values are gated (they are returned as 0 without the analytics entitlement) but the ordering is not. Re-orders the list, never narrows it.

Available options:
clicks,
created,
trending,
updated,
title,
myLastClick
dir
enum<string>
default:desc

Sort direction for the active sort. Shortcuts with no value for that ordering always sort last, in both directions.

Available options:
asc,
desc
archived
enum<string>
default:false

Include archived shortcuts. Soft-deleted shortcuts are never returned regardless of this value.

Available options:
true,
false,
1,
0
tags
string

Comma-separated tag IDs (up to 20). Tag IDs outside this workspace match nothing. Combine with tagsOp.

tagsOp
enum<string>
default:in

How to apply tags. in returns shortcuts carrying at least one of them; nin returns shortcuts carrying none of them.

Available options:
in,
nin
creator
string

Comma-separated user IDs (up to 20) to filter by the shortcut's original creator. This does not change when a shortcut is transferred — use owner for the current owner.

creatorOp
enum<string>
default:in

How to apply creator. in returns shortcuts created by one of them; nin returns shortcuts created by none of them, including shortcuts with no recorded creator.

Available options:
in,
nin
owner
string

Comma-separated user IDs (up to 20) to filter by the shortcut's current owner.

ownerOp
enum<string>
default:in

How to apply owner. in returns shortcuts owned by one of them; nin returns shortcuts owned by none of them, including unowned shortcuts.

Available options:
in,
nin
expired
enum<string>

Filter by expiry state. true returns only shortcuts whose expiresAt has already passed; false returns the rest — both the ones expiring in the future and the ones with no expiry at all. Omit to ignore expiry entirely. Evaluated against the server clock, so this means currently expired rather than has an expiry set, matching the redirect's 410 Gone behaviour.

Available options:
true,
false,
1,
0
passwordProtected
enum<string>

Filter by whether a password is set on the shortcut — the same derived flag returned as passwordProtected on each item. Never accepts or compares a password value. Omit to ignore.

Available options:
true,
false,
1,
0
masked
enum<string>

Filter by destination masking. true returns only shortcuts that render a Lora landing page instead of redirecting straight through. Omit to ignore.

Available options:
true,
false,
1,
0

Response

Paginated list of shortcuts.

Paginated list of shortcuts visible to the caller

items
ShortcutListItem · object[]
required
nextCursor
string | null
required

Cursor for the next page, or null if this is the last page.

Pattern: ^[A-Za-z0-9_-]{38,4096}$