Skip to main content
GET
Retrieve document links

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Document ID

Query Parameters

workspace
string
required

Workspace URL

Response

Get document links information

id
string

Link ID

Example:

"1110580a82031111aaa01111"

documentId
string

Document ID associated with the link

Example:

"1110580a82031111aaa01111"

url
string

URL of the link

key
string

Key of the link

Example:

"try-reqlick"

expiresAt
string<date-time>

Expiration date of the link

password
string

Password for the link

proxy
boolean

Indicates if the link is a proxy

Example:

false

isFile
boolean

Indicates if the link is a file

Example:

true

isQR
boolean

Indicates if the link is a QR code

Example:

false

title
string

Title of the link

Example:

"Instant File Sharing Link with Reqlick"

description
string

Description of the link

Example:

"Turn your files into shareable links and connect effortlessly"

image
string

URL of the link's image

Example:

"/_static/thumbnail.png"

allowedEmails
string[]

List of allowed email addresses

createdAt
string<date-time>

Creation date of the link

Example:

"2024-07-16T10:48:19.492Z"

updatedAt
string<date-time>

Last update date of the link

Example:

"2024-07-16T10:48:19.492Z"

projectId
string

Workspace ID associated with the link

Example:

"1110580a82031111aaa01111"

isPublic
boolean

Indicates if the link is public

Example:

true

isActive
boolean

Indicates if the link is active

Example:

true

isArchived
boolean

Indicates if the link is archived

Example:

false

isRecord
boolean

Indicates if the link is a record

Example:

false

domain
string

Domain of the link

Example:

"rqk.sh"

utm_source
string

UTM source

utm_medium
string

UTM medium

utm_campaign
string

UTM campaign

utm_term
string

UTM term

utm_content
string

UTM content

ref
string

Reference

ios
string

iOS link

android
string

Android link

tagId
string

Tag ID

createdSessionId
string

Created session ID

views
object[]
_count
object