Workspaces is the defacto way of organizing your links and working with your team on Reqlick. You can think of a Reqlick workspace like a workspace on Slack or Discord – it’s a shared space where you can invite your team members to collaborate on links, QR codes and files.
When interacting with Reqlick’s API, you will also need to specify the Workspace URL to perform any operation. You can find the workspace URL under the General settings page of your workspace.
id
string
required
The unique identifier for the workspace.
url
string
required
The URL of the workspace.
name
string
required
The name of the workspace.
logo
string
The logo of the workspace.
links
object[]
The links of the workspace.
documents
object[]
The documents of the workspace.
qrcode
object[]
The QR Codes of the workspace.
views
object[]
The views associated with the related links, qrcodes and documents in the
workspace.
Links are the bread and butter of Reqlick. You can shorten any URL to a Reqlick link, which you can then share with your audience. Links can be created, updated, and deleted via the Reqlick API or the Reqlick dashboard.
id
string
required
The unique identifier for the link.
documentId
string
The ID of the associated document.
url
string
The URL of the link.
key
string
required
The unique key of the link (e.g., /github), also stored in Redis.
domain
string
required
The domain associated with the link.
expiresAt
string
The optional expiration date of the link.
password
string
The password required to access the link, also stored in Redis.
isFile
boolean
default: "true"
Indicates whether the link is associated with a file.
isQR
boolean
default: "false"
Indicates whether the link is associated with a QR code.
Documents are the files that you can upload and manage within your workspace. These can include contracts, reports, or any file you need to store and share with your team. Using the Reqlick API, you can upload, update, and delete documents.
id
string
required
The unique identifier for the document.
name
string
required
The name of the document.
description
string
The description of the document.
file
string
required
The reference to where the file is stored (e.g., S3, Google Cloud Storage).
size
number
The size of the file (in bytes).
type
string
The file type (e.g., pdf, docx).
links
object[]
The links associated with the document.
views
object[]
The tracked views associated with the document.
projectId
string
The ID of the associated project.
createdAt
string
The date and time when the document was created.
updatedAt
string
The date and time when the document was last updated.
Reqlick allows you to generate custom QR codes for your links, providing a visual and scannable representation of your shortened URLs. These QR codes can be customized with colors, logos, and other design elements.
You can create, update, and delete QR codes via the Reqlick API. Each QR code is linked to a specific shortened link for easy access.
id
string
required
The unique identifier for the QR code.
image
string
required
The image of the QR code.
bgColor
string
The background color of the QR code.
fgColor
string
The foreground color of the QR code.
level
string
required
The error correction level of the QR code.
size
number
The size of the QR code.
url
string
required
The URL associated with the QR code.
image_src
string
The source URL for the image associated with the QR code.
image_excavate
boolean
Indicates whether to excavate the image (e.g., if the image is embedded).
image_height
number
The height of the image associated with the QR code.
image_width
number
The width of the image associated with the QR code.
views
object[]
The tracked views associated with the QR code.
projectId
string
The ID of the associated project.
link
object
The link associated with the QR code.
linkId
string
The ID of the associated link.
createdAt
string
The date and time when the QR code was created.
updatedAt
string
The date and time when the QR code was last updated.
Reqlick operates on a subscription-based model, allowing users to unlock various features depending on their subscription level. You can manage subscription plans, view current subscriptions, and upgrade or downgrade subscriptions only on the Reqlick dashboard.
id
string
required
The unique identifier for the subscription.
userId
string
The ID of the associated user.
plan
string
default: "FREE"
The subscription plan of the user.
billingCycleStart
number
The day of the month when the billing cycle starts.
stripeId
string
The Stripe ID associated with the subscription.
isCanceledAtPeriodEnd
boolean
default: "false"
Indicates whether the subscription will be canceled at the end of the current
billing period.
isActive
boolean
default: "true"
Indicates whether the subscription is currently active.
isPaymentFailed
boolean
default: "false"
Indicates whether the payment for the subscription has failed.
isCanceledAt
string
The date and time when the subscription was canceled.
isCancelAt
string
The date and time when the subscription is scheduled to be canceled.
interval
string
The billing interval for the subscription (e.g., year, month).
subscriptionScheduleId
string
The ID of the subscription schedule.
periodEnd
string
The end date of the subscription period.
projects
object[]
The projects associated with the subscription.
amount
number
default: "0"
The amount of the subscription ($0 by default).
domainsLimit
number
default: "0"
The limit on the number of domains for the subscription.
projectsLimit
number
default: "1"
The limit on the number of projects for the subscription.
usersLimit
number
default: "1"
The limit on the number of users for the subscription.
stockageLimit
bigint
default: "536870912"
The storage limit for the subscription (in bytes; 512MB by default).
clicksLimit
number
default: "1000"
The limit on the number of clicks for the subscription.
shortLinksLimit
number
default: "10"
The limit on the number of short links for the subscription.
qrCodeLinksLimit
number
default: "2"
The limit on the number of QR code links for the subscription.
stockageUsage
bigint
default: "0"
The current storage usage (in bytes).
clicksUsage
number
default: "0"
The current number of clicks used.
createdAt
string
The date and time when the subscription was created.
updatedAt
string
The date and time when the subscription was last updated.
Users are the individuals who interact with Reqlick. Each user is associated with one or more workspaces and can be assigned different roles, such as admin or collaborator. The API allows for user creation, role management, and user authentication.
id
string
required
The unique identifier for the user.
name
string
The first name of the user.
lastName
string
The last name of the user.
email
string
The email address of the user, which must be unique.
