Skip to main content
GET
Get workspace links

Authorizations

Authorization
string
header
required

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

Path Parameters

url
string
required

Workspace URL

Response

Successfully retrieved all links

id
string

Link ID

Example:

"1110580a82031111aaa01111"

documentId
string

Document ID

Example:

"1110580a82031111aaa01111"

url
string | null

Link URL

Example:

null

key
string

Link key

Example:

"try-reqlick"

expiresAt
string<date-time> | null

Expiration date

Example:

null

isFile
boolean

File status

Example:

true

isQR
boolean

QR code status

Example:

false

title
string

Link title

Example:

"Reqlick title"

description
string

Link description

Example:

"Reqlick description"

image
string

Link image URL

Example:

"image.png"

createdAt
string<date-time>

Creation date

Example:

"2024-06-05T12:55:41.946Z"

updatedAt
string<date-time>

Last update date

Example:

"2024-06-05T12:55:41.946Z"

isPublic
boolean

Public status

Example:

true

isActive
boolean

Active status

Example:

true

isArchived
boolean

Archived status

Example:

false

domain
string

Domain

Example:

"rqk.sh"

utm_source
string | null

UTM source

Example:

null

utm_medium
string | null

UTM medium

Example:

null

utm_campaign
string | null

UTM campaign

Example:

null

utm_term
string | null

UTM term

Example:

null

utm_content
string | null

UTM content

Example:

null

ref
string | null

Reference

Example:

null

ios
string | null

iOS data

Example:

null

android
string | null

Android data

Example:

null

views
integer

Number of views

Example:

1

isProtected
boolean

Protected status

Example:

false

createdBy
object

Short link URL

Example:

"https://rqk.sh/try-reqlick"