# Reqlick in Claude and ChatGPT
Source: https://docs.reqlick.com/ai-assistants

Connect Reqlick to Claude, ChatGPT, Cursor or any MCP client. Create links and QR codes, share files and read analytics by asking.

Reqlick has a remote MCP server. Connect it once and your AI assistant can work in your Reqlick workspaces for you.

```text theme={null}
https://api.reqlick.com/mcp
```

You sign in with your Reqlick account. Every plan can connect, and your plan's limits apply as they do in the dashboard.

## Connect

<Tabs>
  <Tab title="Claude">
    1. Open **Settings → Connectors** on claude.ai.
    2. Choose **Add custom connector**. Name it `Reqlick` and paste the URL above.
    3. Keep the defaults, **Sign in now** and **Use Claude's published identity**, then click **Add**.
    4. Click **Connect** and sign in with your Reqlick account.

    The connector also works in the Claude desktop and mobile apps.
  </Tab>

  <Tab title="ChatGPT">
    1. Open **Plugins** in ChatGPT, click **+**, then **Create app**.
    2. Name it `Reqlick`, paste the URL above as the server URL and keep **OAuth**.
    3. Accept the notice about custom servers and create the app.
    4. Sign in with your Reqlick account when ChatGPT asks.

    If you don't see **Create app**, turn on developer mode in ChatGPT's settings first.
  </Tab>

  <Tab title="Claude Code">
    ```bash theme={null}
    claude mcp add --transport http reqlick https://api.reqlick.com/mcp
    ```

    Then run `/mcp` in Claude Code, pick `reqlick` and sign in.
  </Tab>

  <Tab title="Cursor and others">
    Add a remote MCP server with the URL above. Any client that supports streamable HTTP and OAuth works.

    ```json theme={null}
    {
      "mcpServers": {
        "reqlick": { "url": "https://api.reqlick.com/mcp" }
      }
    }
    ```
  </Tab>
</Tabs>

To check the connection, ask: **"Who am I on Reqlick?"** The assistant lists your account and workspaces.

## What you can ask

<AccordionGroup>
  <Accordion title="Short links" icon="link">
    Create, search, edit, pause and archive links. Edits cover the destination, short key, title, expiry, password, iPhone and Android destinations, tags and UTM parameters.

    * "Shorten [https://example.com/spring-sale](https://example.com/spring-sale) as rqk.sh/spring in my Marketing workspace."
    * "Add utm\_source=newsletter to rqk.sh/spring."
    * "Pause rqk.sh/spring, and tag it black-friday."
  </Accordion>

  <Accordion title="QR codes" icon="qrcode">
    Create a QR code with your colours and shapes. The assistant shows the image in the chat. You can restyle it later, and the printed code keeps working because the short URL does not change.

    * "Make a dark blue QR code with rounded dots for [https://example.com/menu](https://example.com/menu)."
    * "Point the menu QR code at the new winter menu."
  </Accordion>

  <Accordion title="Files" icon="file">
    Assistants that can send a local file over HTTP, like Claude Code, Cursor and custom agents, can share a file as a link or a QR code. They ask Reqlick for an upload link, upload the file, then create the link.

    A file attached in the claude.ai or ChatGPT chat window cannot reach Reqlick. Upload it in the dashboard first, then ask the assistant to share it.

    * "Share ./brochure.pdf as rqk.sh/brochure."
    * "Replace the file behind rqk.sh/brochure with ./brochure-v2.pdf."
  </Accordion>

  <Accordion title="Bulk creation" icon="layer-group">
    Up to 100 links, or 25 QR codes, in one request. Rows that fail come back with a reason, and the rest are still created.

    * "Shorten these 30 product URLs with utm\_campaign=autumn."
  </Accordion>

  <Accordion title="Analytics" icon="chart-line">
    Clicks over time, top links, and breakdowns by country, region, city, device, browser, OS, language and referrer. Paid plans can also export up to 200 clicks as CSV.

    * "How many clicks did rqk.sh/spring get this month, by country?"
    * "Which QR code was scanned most this year?"
  </Accordion>
</AccordionGroup>

## Plans and limits

The assistant acts as you, with the same rules as the dashboard.

|                                      | Free                     | Paid plans               |
| ------------------------------------ | ------------------------ | ------------------------ |
| Links, QR codes, files               | Up to your plan's limits | Up to your plan's limits |
| Password, expiry, device targeting   | No                       | Pro and above            |
| Click counts                         | Yes                      | Yes                      |
| Visitors, trends, breakdowns, export | No                       | Yes                      |
| Analytics history                    | 30 days                  | Your plan's retention    |

When a limit is reached, the assistant tells you why. Read-only members can search and read analytics but cannot change anything. Requests share the API's rate limit of 100 per minute.

## Privacy and access

* You sign in with OAuth. The assistant never sees your password, and Reqlick never sees your conversation.
* The assistant can only reach workspaces you belong to.
* Every change the assistant makes is recorded in Reqlick's audit log, like a change made in the dashboard.
* To disconnect, remove the Reqlick connector in your assistant's settings.

Read the [privacy policy](https://reqlick.com/privacy-policy) for what Reqlick stores.

## Troubleshooting

<AccordionGroup>
  <Accordion title="No Reqlick account found for this login">
    You signed in with an account that has no Reqlick workspace. Sign in with the email you use on app.reqlick.com.
  </Accordion>

  <Accordion title="The link is saved but not redirecting yet">
    Ask the assistant to update the link with no changes. That publishes it again.
  </Accordion>

  <Accordion title="Something else">
    Write to [support@reqlick.com](mailto:support@reqlick.com) with the prompt you used and the time.
  </Accordion>
</AccordionGroup>


# Delete a document
Source: https://docs.reqlick.com/api-reference/endpoint/documents/delete/documentById/index

DELETE /documents/{id}
Delete a document by ID for the authenticated workspace.



# Retrieve a list of documents
Source: https://docs.reqlick.com/api-reference/endpoint/documents/get/retrieveAllDocuments/index

GET /documents
Retrieve all documents for the authenticated workspace.



# Retrieve a document
Source: https://docs.reqlick.com/api-reference/endpoint/documents/get/retrieveDocumentById/index

GET /documents/{id}
Retrieve a document for the authenticated workspace.



# Retrieve a list of links
Source: https://docs.reqlick.com/api-reference/endpoint/documents/get/retrieveDocumentLinksById/index

GET /documents/{id}/links
Retrieve document links for the authenticated workspace.



# Retrieve analytics
Source: https://docs.reqlick.com/api-reference/endpoint/documents/get/retrieveDocumentStatsById/index

GET /documents/{id}/stats
Retrieve docuemnt analytics for the authenticated workspace.



# Archive a file
Source: https://docs.reqlick.com/api-reference/endpoint/documents/post/archiveDocument/index

POST /documents/{id}/archive
Stop sharing a file without deleting it.



# Create a new document
Source: https://docs.reqlick.com/api-reference/endpoint/documents/post/createNewDocumentByWorkspace/index

POST /documents/{url}
Create a new document for the authenticated workspace.



# Restore a file
Source: https://docs.reqlick.com/api-reference/endpoint/documents/post/restoreDocument/index

POST /documents/{id}/restore
Bring an archived file's links back, deactivated.



# Update a document
Source: https://docs.reqlick.com/api-reference/endpoint/documents/put/updateDocumentById/index

PUT /documents/{id}
Update a document for the authenticated workspace by its ID.



# Delete a domain
Source: https://docs.reqlick.com/api-reference/endpoint/domains/delete/domainBySlug/index

DELETE /domains/{slug}
Delete a domain for the authenticated workspace



# Retrieve a list of domains
Source: https://docs.reqlick.com/api-reference/endpoint/domains/get/retrieveAllDomains/index

GET /domains/{slug}
Retrieve a list of domains for the authenticated workspace



# Retrieve domain status
Source: https://docs.reqlick.com/api-reference/endpoint/domains/get/verifyDomainStatusBySlug/index

GET /domains/{slug}/status
Retrieve a domain verification status for the authenticated workspace



# Create a new domain
Source: https://docs.reqlick.com/api-reference/endpoint/domains/post/createNewDomain/index

POST /domains/{slug}
Create a new domain for the authenticated workspace



# Add domain redirect URL
Source: https://docs.reqlick.com/api-reference/endpoint/domains/post/redirectDomain/index

POST /domains/{slug}/redirect
Add domain redirect URL for the authenticated workspace



# Delete a link
Source: https://docs.reqlick.com/api-reference/endpoint/links/delete/delete-link-by-id/index

DELETE /links/{id}
Delete a link for the authenticated workspace



# Permanently delete a link
Source: https://docs.reqlick.com/api-reference/endpoint/links/delete/permanently-delete-link/index

DELETE /links/{id}/permanent
Remove a link or QR code for good. This cannot be undone.



# Retrieve a link
Source: https://docs.reqlick.com/api-reference/endpoint/links/get/get-link-by-id/index

GET /links/{id}
Retrieve a link for the authenticated workspace by its ID



# Retrieve a short key
Source: https://docs.reqlick.com/api-reference/endpoint/links/get/random/index

GET /links/random
Retrieve a short key



# Retrieve analytics
Source: https://docs.reqlick.com/api-reference/endpoint/links/get/stats-by-id/index

GET /links/{id}/stats
Retrieve link analytics for the authenticated workspace.



# Create a new document link
Source: https://docs.reqlick.com/api-reference/endpoint/links/post/link-for-document/index

POST /links/document
Create a new link for a document for the authenticated workspace.



# Create a new link
Source: https://docs.reqlick.com/api-reference/endpoint/links/post/new-link/index

POST /links/new/{workspace}
Create a new link for the authenticated workspace.



# Restore a link
Source: https://docs.reqlick.com/api-reference/endpoint/links/post/restore-link/index

POST /links/{id}/restore
Bring an archived link back, deactivated.



# Update a link status
Source: https://docs.reqlick.com/api-reference/endpoint/links/put/update-link-status-by-id/index

PUT /links/{id}/status
Update a link status for the authenticated workspace by its ID.



# Update a link
Source: https://docs.reqlick.com/api-reference/endpoint/links/put/update-link/index

PUT /links/update
Update a link for the authenticated workspace.



# Create a new QR Code
Source: https://docs.reqlick.com/api-reference/endpoint/qrcodes/post/qrcode/index

POST /qrcodes/{url}
Create a new QR Code for the authenticated workspace.



# Retrieve a subscription
Source: https://docs.reqlick.com/api-reference/endpoint/subscriptions/get/subscription-by-user/index

GET /subscriptions
Retrieve a subscription for the authenticated workspace by its ID



# Retrieve a user
Source: https://docs.reqlick.com/api-reference/endpoint/users/get/me/index

GET /users/me
Retrieve a user for the authenticated workspace



# Retrieve usage
Source: https://docs.reqlick.com/api-reference/endpoint/users/get/usage/index

GET /users/usage
Retrieve all usage for the authenticated workspace



# Delete a workspace
Source: https://docs.reqlick.com/api-reference/endpoint/workspaces/delete/projectByUrl/index

DELETE /workspaces/{url}
Delete a workspace for the authenticated workspace.



# Retrieve workspace files
Source: https://docs.reqlick.com/api-reference/endpoint/workspaces/get/documents/index

GET /workspaces/{url}/documents
List the files uploaded to a workspace.



# Retrieve a list of links
Source: https://docs.reqlick.com/api-reference/endpoint/workspaces/get/links/index

GET /workspaces/{url}/links
Retrieve a list of links for the authenticated workspace.



# Retrieve a list of members
Source: https://docs.reqlick.com/api-reference/endpoint/workspaces/get/members/index

GET /workspaces/{url}/members
Retrieve a list of members for the authenticated workspace.



# Retrieve a workspace
Source: https://docs.reqlick.com/api-reference/endpoint/workspaces/get/projectByUrl/index

GET /workspaces/{url}
Retrieve a workspace by its URL.



# Retrieve clicks analytics
Source: https://docs.reqlick.com/api-reference/endpoint/workspaces/get/projects-analytics-click/index

GET /workspaces/{url}/analytics/clicks
Retrieve a clicks analytics for the authenticated workspace.



# Retrieve analytics
Source: https://docs.reqlick.com/api-reference/endpoint/workspaces/get/projects-analytics-stats/index

GET /workspaces/{url}/analytics/stats
Retrieve analytics for the authenticated workspace.



# Retrieve a list of QR Codes
Source: https://docs.reqlick.com/api-reference/endpoint/workspaces/get/qrcodes/index

GET /workspaces/{url}/qrcodes
Retrieve a list of QR Codes for the authenticated workspace.



# Update a workspace
Source: https://docs.reqlick.com/api-reference/endpoint/workspaces/put/projectByUrl/index

PUT /workspaces/{url}
Update a workspace information by its URL.



# Update a workspace logo
Source: https://docs.reqlick.com/api-reference/endpoint/workspaces/put/projectLogo/index

PUT /workspaces/{url}/logo
Update a workspace logo by its URL.



# Introduction
Source: https://docs.reqlick.com/api-reference/introduction

Fundamental concepts of Reqlick's API.

<Info>
  Reqlick's API is currently in beta. If you have any questions or feedback,
  please reach out to us at
  [support@reqlick.com](mailto:support@reqlick.com?subject=reqlick.com%20API%20Feedback).
</Info>

## Base URL

Reqlick's API is built on REST principles and is served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.

The Base URL for all API endpoints is:

```
https://api.reqlick.com
```

## Authentication

Authentication to Reqlick's API is performed via the Authorization header with a Bearer token. To authenticate, you need to include the Authorization header with the word `Bearer` followed by your token in your API requests like so:

```
Authorization: Bearer <Your-Token>
```

You can get your token under your Settings > API Keys

## Response Codes

The API returns standard HTTP response codes to indicate the success or failure of an API request. Here are a few examples:

| Code  | Description                                                                                    |
| ----- | ---------------------------------------------------------------------------------------------- |
| `200` | The request was successful.                                                                    |
| `400` | The request was invalid or cannot be served.                                                   |
| `401` | The request requires user authentication.                                                      |
| `403` | The server understood the request, but refuses to authorize it.                                |
| `404` | The requested resource could not be found.                                                     |
| `429` | Too many requests.                                                                             |
| `500` | The server encountered an unexpected condition which prevented it from fulfilling the request. |


# Data model
Source: https://docs.reqlick.com/data-model

A quick overview of how Reqlick is structured.

Whether you are using Reqlick's [API](/api-reference/introduction) or not, this page is a quick way to understand how Reqlick works.

Within Reqlick, all data belongs to a [**Workspace**](#workspaces). Within a workspace, you have [Links](#links), [Documents](#documents), [Subscriptions](#subscriptions), [Domains](#domains) and more.

## 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.

<Accordion title="Workspace model">
  <ResponseField name="id" type="string">
    The unique identifier for the workspace.
  </ResponseField>

  <ResponseField name="url" type="string">
    The URL of the workspace.
  </ResponseField>

  <ResponseField name="name" type="string">
    The name of the workspace.
  </ResponseField>

  <ResponseField name="logo" type="string">
    The logo of the workspace.
  </ResponseField>

  <ResponseField name="links" type="object[]">
    The links of the workspace.
  </ResponseField>

  <ResponseField name="documents" type="object[]">
    The documents of the workspace.
  </ResponseField>

  <ResponseField name="qrcode" type="object[]">
    The QR Codes of the workspace.
  </ResponseField>

  <ResponseField name="views" type="object[]">
    The views associated with the related links, qrcodes and documents in the
    workspace.
  </ResponseField>

  <ResponseField name="domains" type="object[]">
    The domains associated with the workspace.
  </ResponseField>

  <ResponseField name="members" type="object[]">
    The members of the workspace.
  </ResponseField>

  <ResponseField name="isArchived" type="boolean">
    Indicates whether the workspace is archived.
  </ResponseField>

  <ResponseField name="subscriptionId" type="string">
    The subscription ID of the workspace.
  </ResponseField>

  <ResponseField name="createdAt" type="string">
    The date and time when the workspace was created.
  </ResponseField>

  <ResponseField name="viewedAt" type="string">
    The date and time when the workspace was viewed.
  </ResponseField>

  <ResponseField name="updatedAt" type="string">
    The date and time when the workspace was updated.
  </ResponseField>
</Accordion>

## 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](/api-reference/introduction) or the [Reqlick dashboard](https://app.reqlick.com).

<Accordion title="Link model">
  <ResponseField name="id" type="string">
    The unique identifier for the link.
  </ResponseField>

  <ResponseField name="documentId" type="string">
    The ID of the associated document.
  </ResponseField>

  <ResponseField name="url" type="string">
    The URL of the link.
  </ResponseField>

  <ResponseField name="key" type="string">
    The unique key of the link (e.g., /github), also stored in Redis.
  </ResponseField>

  <ResponseField name="domain" type="string">
    The domain associated with the link.
  </ResponseField>

  <ResponseField name="expiresAt" type="string">
    The optional expiration date of the link.
  </ResponseField>

  <ResponseField name="password" type="string">
    The password required to access the link, also stored in Redis.
  </ResponseField>

  <ResponseField name="isFile" type="boolean">
    Indicates whether the link is associated with a file.
  </ResponseField>

  <ResponseField name="isQR" type="boolean">
    Indicates whether the link is associated with a QR code.
  </ResponseField>

  <ResponseField name="title" type="string">
    The OG title for the link.
  </ResponseField>

  <ResponseField name="description" type="string">
    The OG description for the link.
  </ResponseField>

  <ResponseField name="image" type="string">
    The OG image for the link (e.g., [https://reqlick.com/\_static/thumbnail.png](https://reqlick.com/_static/thumbnail.png)).
  </ResponseField>

  <ResponseField name="views" type="object[]">
    The tracked views associated with the link.
  </ResponseField>

  <ResponseField name="projectId" type="string">
    The ID of the associated project.
  </ResponseField>

  <ResponseField name="isPublic" type="boolean">
    Indicates whether the link is public.
  </ResponseField>

  <ResponseField name="isActive" type="boolean">
    Indicates whether the link is active.
  </ResponseField>

  <ResponseField name="isArchived" type="boolean">
    Indicates whether the link is archived.
  </ResponseField>

  <ResponseField name="utm_source" type="string">
    The UTM source for the link (e.g., youtube.com).
  </ResponseField>

  <ResponseField name="utm_medium" type="string">
    The UTM medium for the link (e.g., social).
  </ResponseField>

  <ResponseField name="utm_campaign" type="string">
    The UTM campaign for the link (e.g., summer-sale).
  </ResponseField>

  <ResponseField name="utm_term" type="string">
    The UTM term for the link (e.g., reqlick).
  </ResponseField>

  <ResponseField name="utm_content" type="string">
    The UTM content for the link (e.g., description).
  </ResponseField>

  <ResponseField name="ref" type="string">
    The referral for the link.
  </ResponseField>

  <ResponseField name="ios" type="string">
    The custom link for iOS devices.
  </ResponseField>

  <ResponseField name="android" type="string">
    The custom link for Android devices.
  </ResponseField>

  <ResponseField name="qrcode" type="object[]">
    The QR codes associated with the link.
  </ResponseField>

  <ResponseField name="createdAt" type="string">
    The date and time when the link was created.
  </ResponseField>

  <ResponseField name="updatedAt" type="string">
    The date and time when the link was last updated.
  </ResponseField>
</Accordion>

## 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](/api-reference/introduction), you can upload, update, and delete documents.

<Accordion title="Document model">
  <ResponseField name="id" type="string">
    The unique identifier for the document.
  </ResponseField>

  <ResponseField name="name" type="string">
    The name of the document.
  </ResponseField>

  <ResponseField name="description" type="string">
    The description of the document.
  </ResponseField>

  <ResponseField name="file" type="string">
    The reference to where the file is stored (e.g., S3, Google Cloud Storage).
  </ResponseField>

  <ResponseField name="size" type="number">
    The size of the file (in bytes).
  </ResponseField>

  <ResponseField name="type" type="string">
    The file type (e.g., pdf, docx).
  </ResponseField>

  <ResponseField name="links" type="object[]">
    The links associated with the document.
  </ResponseField>

  <ResponseField name="views" type="object[]">
    The tracked views associated with the document.
  </ResponseField>

  <ResponseField name="projectId" type="string">
    The ID of the associated project.
  </ResponseField>

  <ResponseField name="createdAt" type="string">
    The date and time when the document was created.
  </ResponseField>

  <ResponseField name="updatedAt" type="string">
    The date and time when the document was last updated.
  </ResponseField>
</Accordion>

## 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](/api-reference/introduction). Each QR code is linked to a specific shortened link for easy access.

<Accordion title="QR Code model">
  <ResponseField name="id" type="string">
    The unique identifier for the QR code.
  </ResponseField>

  <ResponseField name="image" type="string">
    The image of the QR code.
  </ResponseField>

  <ResponseField name="bgColor" type="string">
    The background color of the QR code.
  </ResponseField>

  <ResponseField name="fgColor" type="string">
    The foreground color of the QR code.
  </ResponseField>

  <ResponseField name="level" type="string">
    The error correction level of the QR code.
  </ResponseField>

  <ResponseField name="size" type="number">
    The size of the QR code.
  </ResponseField>

  <ResponseField name="url" type="string">
    The URL associated with the QR code.
  </ResponseField>

  <ResponseField name="image_src" type="string">
    The source URL for the image associated with the QR code.
  </ResponseField>

  <ResponseField name="image_excavate" type="boolean">
    Indicates whether to excavate the image (e.g., if the image is embedded).
  </ResponseField>

  <ResponseField name="image_height" type="number">
    The height of the image associated with the QR code.
  </ResponseField>

  <ResponseField name="image_width" type="number">
    The width of the image associated with the QR code.
  </ResponseField>

  <ResponseField name="views" type="object[]">
    The tracked views associated with the QR code.
  </ResponseField>

  <ResponseField name="projectId" type="string">
    The ID of the associated project.
  </ResponseField>

  <ResponseField name="link" type="object">
    The link associated with the QR code.
  </ResponseField>

  <ResponseField name="linkId" type="string">
    The ID of the associated link.
  </ResponseField>

  <ResponseField name="createdAt" type="string">
    The date and time when the QR code was created.
  </ResponseField>

  <ResponseField name="updatedAt" type="string">
    The date and time when the QR code was last updated.
  </ResponseField>
</Accordion>

## Domains

On Reqlick, you can add custom domains to create branded short links for better brand recognition.

<Accordion title="Domain model">
  <ResponseField name="id" type="string">
    The unique identifier for the domain.
  </ResponseField>

  <ResponseField name="slug" type="string">
    The unique slug for the domain.
  </ResponseField>

  <ResponseField name="verified" type="boolean">
    Indicates whether the domain has been verified.
  </ResponseField>

  <ResponseField name="target" type="string">
    The target URL or resource associated with the domain.
  </ResponseField>

  <ResponseField name="type" type="string">
    The type of the domain (e.g., redirect).
  </ResponseField>

  <ResponseField name="description" type="string">
    A description of the domain.
  </ResponseField>

  <ResponseField name="primary" type="boolean">
    Indicates whether the domain is the primary domain.
  </ResponseField>

  <ResponseField name="lastChecked" type="string">
    The date and time when the domain was last checked.
  </ResponseField>

  <ResponseField name="createdAt" type="string">
    The date and time when the domain was created.
  </ResponseField>

  <ResponseField name="updatedAt" type="string">
    The date and time when the domain was last updated.
  </ResponseField>

  <ResponseField name="projectId" type="string">
    The ID of the associated project.
  </ResponseField>
</Accordion>

## 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](https://app.reqlick.com).

<Accordion title="Subscription model">
  <ResponseField name="id" type="string">
    The unique identifier for the subscription.
  </ResponseField>

  <ResponseField name="userId" type="string">
    The ID of the associated user.
  </ResponseField>

  <ResponseField name="plan" type="string">
    The subscription plan of the user.
  </ResponseField>

  <ResponseField name="billingCycleStart" type="number">
    The day of the month when the billing cycle starts.
  </ResponseField>

  <ResponseField name="stripeId" type="string">
    The Stripe ID associated with the subscription.
  </ResponseField>

  <ResponseField name="isCanceledAtPeriodEnd" type="boolean">
    Indicates whether the subscription will be canceled at the end of the current
    billing period.
  </ResponseField>

  <ResponseField name="isActive" type="boolean">
    Indicates whether the subscription is currently active.
  </ResponseField>

  <ResponseField name="isPaymentFailed" type="boolean">
    Indicates whether the payment for the subscription has failed.
  </ResponseField>

  <ResponseField name="isCanceledAt" type="string">
    The date and time when the subscription was canceled.
  </ResponseField>

  <ResponseField name="isCancelAt" type="string">
    The date and time when the subscription is scheduled to be canceled.
  </ResponseField>

  <ResponseField name="interval" type="string">
    The billing interval for the subscription (e.g., year, month).
  </ResponseField>

  <ResponseField name="subscriptionScheduleId" type="string">
    The ID of the subscription schedule.
  </ResponseField>

  <ResponseField name="periodEnd" type="string">
    The end date of the subscription period.
  </ResponseField>

  <ResponseField name="projects" type="object[]">
    The projects associated with the subscription.
  </ResponseField>

  <ResponseField name="amount" type="number">
    The amount of the subscription (\$0 by default).
  </ResponseField>

  <ResponseField name="domainsLimit" type="number">
    The limit on the number of domains for the subscription.
  </ResponseField>

  <ResponseField name="projectsLimit" type="number">
    The limit on the number of projects for the subscription.
  </ResponseField>

  <ResponseField name="usersLimit" type="number">
    The limit on the number of users for the subscription.
  </ResponseField>

  <ResponseField name="stockageLimit" type="bigint">
    The storage limit for the subscription (in bytes; 512MB by default).
  </ResponseField>

  <ResponseField name="clicksLimit" type="number">
    The limit on the number of clicks for the subscription.
  </ResponseField>

  <ResponseField name="shortLinksLimit" type="number">
    The limit on the number of short links for the subscription.
  </ResponseField>

  <ResponseField name="qrCodeLinksLimit" type="number">
    The limit on the number of QR code links for the subscription.
  </ResponseField>

  <ResponseField name="stockageUsage" type="bigint">
    The current storage usage (in bytes).
  </ResponseField>

  <ResponseField name="clicksUsage" type="number">
    The current number of clicks used.
  </ResponseField>

  <ResponseField name="createdAt" type="string">
    The date and time when the subscription was created.
  </ResponseField>

  <ResponseField name="updatedAt" type="string">
    The date and time when the subscription was last updated.
  </ResponseField>
</Accordion>

## 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.

<Accordion title="User model">
  <ResponseField name="id" type="string">
    The unique identifier for the user.
  </ResponseField>

  <ResponseField name="name" type="string">
    The first name of the user.
  </ResponseField>

  <ResponseField name="lastName" type="string">
    The last name of the user.
  </ResponseField>

  <ResponseField name="email" type="string">
    The email address of the user, which must be unique.
  </ResponseField>

  <ResponseField name="image" type="string">
    The URL of the user's profile image.
  </ResponseField>

  <ResponseField name="password" type="string">
    The hashed password of the user.
  </ResponseField>

  <ResponseField name="createdAt" type="string">
    The date and time when the user was created.
  </ResponseField>

  <ResponseField name="lastLogin" type="string">
    The date and time when the user last logged in.
  </ResponseField>

  <ResponseField name="team" type="object[]">
    The team members associated with the user.
  </ResponseField>

  <ResponseField name="subscription" type="object">
    The subscription associated with the user.
  </ResponseField>

  <ResponseField name="tokens" type="object[]">
    The tokens associated with the user.
  </ResponseField>

  <ResponseField name="apiTokens" type="object[]">
    The API tokens associated with the user.
  </ResponseField>

  <ResponseField name="client_id" type="string">
    The client ID associated with the user.
  </ResponseField>

  <ResponseField name="client_secret" type="string">
    The client secret associated with the user.
  </ResponseField>
</Accordion>


# Introduction
Source: https://docs.reqlick.com/introduction

Reqlick is a platform that manages links, including Short Links, QR Codes, and File to Link options.

<img alt="Hero Light" />

We help brands, businesses, digital marketers, creators, educators and non-profits
get closer to their audiences with in-depth insights and analytics.

## Features

Here are some of the features that Reqlick offers:

<AccordionGroup>
  <Accordion title="Advanced Analytics" icon="chart-line">
    Reqlick provides powerful analytics for your links, including geolocation,
    device, browser, and referrer information.
  </Accordion>

  <Accordion title="Branded Short Links" icon="link">
    Reqlick offers custom domains on paid plans for you to create branded links
    that stand out.
  </Accordion>

  <Accordion title="Custom QR Codes" icon="qrcode">
    Reqlick offers custom QR codes alongside branded short links, so you can use
    both in one place.
  </Accordion>

  <Accordion title="File To link" icon="files">
    Transform all your files (PDFs, PowerPoint, images, Excel, GIFs, and more)
    into trackable branded short links within seconds.
  </Accordion>

  <Accordion title="Personalization" icon="user">
    Customize your link's behavior with device targeting, link expiration, link
    utm, and more.
  </Accordion>

  <Accordion title="Team Collaboration" icon="users">
    Invite your teammates to collaborate on your links, QR codes and files.
  </Accordion>
</AccordionGroup>

## Setting up

To get started with Reqlick, you can do any of the following:

<CardGroup>
  <Card title="Try our API" icon="code" href="/api-reference/introduction">
    Learn how to use Reqlick's API to create and manage links programmatically
  </Card>
</CardGroup>