Skip to main content
GET
Retrieve document links

Authorizations

Authorization
string
header
required

Workspace API key, prefixed rqk_.

Path Parameters

id
string
required

Response

OK

id
string
domain
string
Example:

"rqk.sh"

key
string

Short key. Combined with domain this forms the short URL.

url
string

Destination URL. Null for file links.

title
string
description
string
image
string
isActive
boolean
isArchived
boolean
isQR
boolean
isFile
boolean
expiresAt
string<date-time>
ios
string

iOS-specific destination.

android
string

Android-specific destination.

workspaceId
string
documentId
string
clicks
integer
createdAt
string<date-time>
updatedAt
string<date-time>