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