> ## Documentation Index
> Fetch the complete documentation index at: https://docs.reqlick.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve usage

> Retrieve all usage for the authenticated workspace



## OpenAPI

````yaml GET /users/usage
openapi: 3.1.0
info:
  title: Reqlick API
  description: >-
    REST API for Reqlick — link shortening, QR codes, file-to-link, custom
    domains and analytics.


    Authenticate with a workspace API key (`Authorization: Bearer rqk_...`),
    created under Settings → API Keys.


    A key is scoped to the single workspace it was created in. Using it against
    a different workspace returns 403, even when the owning user is a member of
    both.


    API access requires a paid plan.
  version: 3.0.0
  contact:
    name: Reqlick Support
    email: support@reqlick.com
servers:
  - url: https://api.reqlick.com
security:
  - bearerAuth: []
tags:
  - name: Links
  - name: QR Codes
  - name: Documents
  - name: Domains
  - name: Workspaces
  - name: Users
  - name: Subscriptions
paths:
  /users/usage:
    get:
      tags:
        - Users
      summary: Retrieve usage
      description: Usage and limits for the current billing period.
      operationId: getUsage
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Usage'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: No subscription
components:
  schemas:
    Usage:
      type: object
      properties:
        id:
          type: string
        plan:
          type: string
        isPaid:
          type: boolean
        shortLinksUsage:
          type: integer
        shortLinksLimit:
          type: integer
        qrCodeLinksUsage:
          type: integer
        qrCodeLinksLimit:
          type: integer
        clicksUsage:
          type: integer
          description: Null when the analytics store is unavailable.
        clicksLimit:
          type: integer
        domainsUsage:
          type: integer
        domainsLimit:
          type: integer
        seatsUsage:
          type: integer
        usersLimit:
          type: integer
        projectUsage:
          type: integer
        projectsLimit:
          type: integer
        storageUsage:
          type: integer
          description: Bytes.
        filesUsage:
          type: integer
        filesLimit:
          type: integer
        retentionLimit:
          type: string
    Error:
      type: object
      properties:
        error:
          type: string
      required:
        - error
  responses:
    Unauthorized:
      description: >-
        Missing, malformed or revoked API key — or the plan no longer includes
        API access
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Workspace API key, prefixed `rqk_`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.