Workspaces
Retrieve a list of links
Retrieve a list of links for the authenticated workspace.
GET
/
workspaces
/
{url}
/
links
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
url
string
requiredWorkspace URL
Response
200 - application/json
id
string
Link ID
documentId
string
Document ID
url
string | null
Link URL
key
string
Link key
expiresAt
string | null
Expiration date
isFile
boolean
File status
isQR
boolean
QR code status
title
string
Link title
description
string
Link description
image
string
Link image URL
createdAt
string
Creation date
updatedAt
string
Last update date
isPublic
boolean
Public status
isActive
boolean
Active status
isArchived
boolean
Archived status
domain
string
Domain
utm_source
string | null
UTM source
utm_medium
string | null
UTM medium
utm_campaign
string | null
UTM campaign
utm_term
string | null
UTM term
utm_content
string | null
UTM content
ref
string | null
Reference
ios
string | null
iOS data
android
string | null
Android data
views
integer
Number of views
isProtected
boolean
Protected status
createdBy
object
shortLink
string
Short link URL