Skip to main content
GET
Retrieve workspace links

Authorizations

Authorization
string
header
required

Workspace API key, prefixed rqk_.

Path Parameters

url
string
required

Workspace slug.

Query Parameters

page
integer
default:1
limit
integer
default:20
status
enum<string>
default:all

Filter by link state. all (the default) includes archived links. active means live right now — it excludes anything paused, archived, past its expiry date, or blocked by moderation.

Available options:
all,
active,
inactive,
archived
type
enum<string>
default:all

Filter by what the link points at. file-to-link returns links backed by an uploaded file.

Available options:
all,
links,
file-to-link
sort
enum<string>
default:newest

Result order. most-clicks ranks by all-time clicks; name-asc sorts by title, falling back to the key.

Available options:
newest,
oldest,
most-clicks,
name-asc

Response

OK

total
integer
page
integer
limit
integer