> ## 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 workspace files

> List the files uploaded to a workspace.



## OpenAPI

````yaml GET /workspaces/{url}/documents
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:
  /workspaces/{url}/documents:
    get:
      tags:
        - Workspaces
      summary: Retrieve workspace files
      description: >-
        Lists the files uploaded to a workspace, with the links pointing at each
        one.


        A file has no archived flag of its own — it counts as archived when
        every link pointing at it is. A file with no links at all is reported as
        `active`, so `active` and `archived` together account for every file.
      operationId: listWorkspaceDocuments
      parameters:
        - $ref: '#/components/parameters/WorkspaceSlug'
        - name: page
          in: query
          schema:
            type: integer
            default: 1
        - name: limit
          in: query
          schema:
            type: integer
            default: 20
        - name: search
          in: query
          description: Matches the file name or its extension.
          schema:
            type: string
        - name: status
          in: query
          description: Filter by whether the file's links are archived.
          schema:
            type: string
            enum:
              - all
              - active
              - archived
            default: all
        - name: fileType
          in: query
          description: >-
            Filter by file family. Matching is case-insensitive, and `other`
            covers anything outside the named buckets, including files with no
            recorded extension.
          schema:
            type: string
            enum:
              - all
              - images
              - pdfs
              - documents
              - other
            default: all
        - name: sort
          in: query
          description: >-
            Result order. `most-clicks` ranks by the all-time clicks across a
            file's links.
          schema:
            type: string
            enum:
              - newest
              - oldest
              - most-clicks
              - largest
              - name-asc
            default: newest
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  documents:
                    type: array
                    items:
                      $ref: '#/components/schemas/Document'
                  total:
                    type: integer
                    description: Number of files matching the current filters.
                  page:
                    type: integer
                  limit:
                    type: integer
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    WorkspaceSlug:
      name: url
      in: path
      required: true
      description: Workspace slug.
      schema:
        type: string
  schemas:
    Document:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        file:
          type: string
          description: Storage key or URL.
        size:
          type: integer
          description: Bytes.
        type:
          type: string
        workspaceId:
          type: string
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    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'
    Forbidden:
      description: Authenticated, but the key has no access to this workspace or resource
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: This API key does not have access to this workspace
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Workspace API key, prefixed `rqk_`.

````