Workspaces
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.Workspace model
Workspace model
string
required
The unique identifier for the workspace.
string
required
The URL of the workspace.
string
required
The name of the workspace.
string
The logo of the workspace.
object[]
The links of the workspace.
object[]
The documents of the workspace.
object[]
The QR Codes of the workspace.
object[]
The views associated with the related links, qrcodes and documents in the
workspace.
object[]
The domains associated with the workspace.
object[]
The members of the workspace.
boolean
default:"false"
Indicates whether the workspace is archived.
string
required
The subscription ID of the workspace.
string
The date and time when the workspace was created.
string
The date and time when the workspace was viewed.
string
The date and time when the workspace was updated.
Links
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.Link model
Link model
string
required
The unique identifier for the link.
string
The ID of the associated document.
string
The URL of the link.
string
required
The unique key of the link (e.g., /github), also stored in Redis.
string
required
The domain associated with the link.
string
The optional expiration date of the link.
string
The password required to access the link, also stored in Redis.
boolean
default:"true"
Indicates whether the link is associated with a file.
boolean
default:"false"
Indicates whether the link is associated with a QR code.
string
The OG title for the link.
string
The OG description for the link.
string
The OG image for the link (e.g., https://reqlick.com/_static/thumbnail.png).
object[]
The tracked views associated with the link.
string
required
The ID of the associated project.
boolean
default:"true"
Indicates whether the link is public.
boolean
default:"true"
Indicates whether the link is active.
boolean
default:"false"
Indicates whether the link is archived.
string
The UTM source for the link (e.g., youtube.com).
string
The UTM medium for the link (e.g., social).
string
The UTM campaign for the link (e.g., summer-sale).
string
The UTM term for the link (e.g., reqlick).
string
The UTM content for the link (e.g., description).
string
The referral for the link.
string
The custom link for iOS devices.
string
The custom link for Android devices.
object[]
The QR codes associated with the link.
string
The date and time when the link was created.
string
The date and time when the link was last updated.
Documents
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.Document model
Document model
string
required
The unique identifier for the document.
string
required
The name of the document.
string
The description of the document.
string
required
The reference to where the file is stored (e.g., S3, Google Cloud Storage).
number
The size of the file (in bytes).
string
The file type (e.g., pdf, docx).
object[]
The links associated with the document.
object[]
The tracked views associated with the document.
string
The ID of the associated project.
string
The date and time when the document was created.
string
The date and time when the document was last updated.
QR Codes
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.QR Code model
QR Code model
string
required
The unique identifier for the QR code.
string
required
The image of the QR code.
string
The background color of the QR code.
string
The foreground color of the QR code.
string
required
The error correction level of the QR code.
number
The size of the QR code.
string
required
The URL associated with the QR code.
string
The source URL for the image associated with the QR code.
boolean
Indicates whether to excavate the image (e.g., if the image is embedded).
number
The height of the image associated with the QR code.
number
The width of the image associated with the QR code.
object[]
The tracked views associated with the QR code.
string
The ID of the associated project.
object
The link associated with the QR code.
string
The ID of the associated link.
string
The date and time when the QR code was created.
string
The date and time when the QR code was last updated.
Domains
On Reqlick, you can add custom domains to create branded short links for better brand recognition.Domain model
Domain model
string
required
The unique identifier for the domain.
string
required
The unique slug for the domain.
boolean
default:"false"
Indicates whether the domain has been verified.
string
The target URL or resource associated with the domain.
string
default:"redirect"
The type of the domain (e.g., redirect).
string
A description of the domain.
boolean
default:"false"
Indicates whether the domain is the primary domain.
string
The date and time when the domain was last checked.
string
The date and time when the domain was created.
string
The date and time when the domain was last updated.
string
The ID of the associated project.
Subscriptions
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.Subscription model
Subscription model
string
required
The unique identifier for the subscription.
string
The ID of the associated user.
string
default:"FREE"
The subscription plan of the user.
number
The day of the month when the billing cycle starts.
string
The Stripe ID associated with the subscription.
boolean
default:"false"
Indicates whether the subscription will be canceled at the end of the current
billing period.
boolean
default:"true"
Indicates whether the subscription is currently active.
boolean
default:"false"
Indicates whether the payment for the subscription has failed.
string
The date and time when the subscription was canceled.
string
The date and time when the subscription is scheduled to be canceled.
string
The billing interval for the subscription (e.g., year, month).
string
The ID of the subscription schedule.
string
The end date of the subscription period.
object[]
The projects associated with the subscription.
number
default:"0"
The amount of the subscription ($0 by default).
number
default:"0"
The limit on the number of domains for the subscription.
number
default:"1"
The limit on the number of projects for the subscription.
number
default:"1"
The limit on the number of users for the subscription.
bigint
default:"536870912"
The storage limit for the subscription (in bytes; 512MB by default).
number
default:"1000"
The limit on the number of clicks for the subscription.
number
default:"10"
The limit on the number of short links for the subscription.
number
default:"2"
The limit on the number of QR code links for the subscription.
bigint
default:"0"
The current storage usage (in bytes).
number
default:"0"
The current number of clicks used.
string
The date and time when the subscription was created.
string
The date and time when the subscription was last updated.
Users
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.User model
User model
string
required
The unique identifier for the user.
string
The first name of the user.
string
The last name of the user.
string
The email address of the user, which must be unique.
string
The URL of the user’s profile image.
string
The hashed password of the user.
string
The date and time when the user was created.
string
The date and time when the user last logged in.
object[]
The team members associated with the user.
object
The subscription associated with the user.
object[]
The tokens associated with the user.
object[]
The API tokens associated with the user.
string
The client ID associated with the user.
string
The client secret associated with the user.