GET
/
documents
/
{id}
/
links

Authorizations

Authorization
string
headerrequired

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
id
string

Link ID

documentId
string

Document ID associated with the link

url
string

URL of the link

key
string

Key of the link

expiresAt
string

Expiration date of the link

password
string

Password for the link

proxy
boolean

Indicates if the link is a proxy

isFile
boolean

Indicates if the link is a file

isQR
boolean

Indicates if the link is a QR code

title
string

Title of the link

description
string

Description of the link

image
string

URL of the link's image

allowedEmails
string[]
createdAt
string

Creation date of the link

updatedAt
string

Last update date of the link

projectId
string

Workspace ID associated with the link

isPublic
boolean

Indicates if the link is public

isActive
boolean

Indicates if the link is active

isArchived
boolean

Indicates if the link is archived

isRecord
boolean

Indicates if the link is a record

domain
string

Domain of the link

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
Retrieve a list of documentsRetrieve analytics