GET
/
documents
/
{id}
/
links
curl --request GET \
  --url https://api.reqlick.com/documents/{id}/links \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "1110580a82031111aaa01111",
    "documentId": "1110580a82031111aaa01111",
    "url": "<string>",
    "key": "try-reqlick",
    "expiresAt": "2023-11-07T05:31:56Z",
    "password": "<string>",
    "proxy": false,
    "isFile": true,
    "isQR": false,
    "title": "Instant File Sharing Link with Reqlick",
    "description": "Turn your files into shareable links and connect effortlessly",
    "image": "/_static/thumbnail.png",
    "allowedEmails": [
      "<string>"
    ],
    "createdAt": "2024-07-16T10:48:19.492Z",
    "updatedAt": "2024-07-16T10:48:19.492Z",
    "projectId": "1110580a82031111aaa01111",
    "isPublic": true,
    "isActive": true,
    "isArchived": false,
    "isRecord": false,
    "domain": "rqk.sh",
    "utm_source": "<string>",
    "utm_medium": "<string>",
    "utm_campaign": "<string>",
    "utm_term": "<string>",
    "utm_content": "<string>",
    "ref": "<string>",
    "ios": "<string>",
    "android": "<string>",
    "tagId": "<string>",
    "createdSessionId": "<string>",
    "views": [
      {
        "id": "1110580a82031111aaa01111",
        "linkId": "1110580a82031111aaa01111",
        "documentId": "1110580a82031111aaa01111",
        "projectId": "1110580a82031111aaa01111",
        "viewedAt": "2024-01-16T10:48:34.528Z",
        "isBot": false,
        "qrcodeId": "<string>"
      }
    ],
    "_count": {
      "views": 1100
    }
  }
]

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

200
application/json
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

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

Creation date of the link

Example:

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

​
updatedAt
string

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