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

# Count documents



## OpenAPI

````yaml get /v1/documents/counts
openapi: 3.0.0
info:
  title: Document APIs Specification
  description: Section for description
  version: '1.0'
  contact: {}
servers:
  - url: https://staging.api.us.aptlydone.com/document
  - url: https://staging.api.eu.aptlydone.com/document
  - url: https://api.us.aptlydone.com/document
  - url: https://api.eu.aptlydone.com/document
security: []
tags: []
paths:
  /v1/documents/counts:
    get:
      tags:
        - documents
      summary: Count documents
      operationId: DocumentController_getDocumentCounts_v1
      parameters:
        - name: tenantId
          required: true
          in: query
          description: Tenant ID
          schema:
            example: 77b19af1-dbd7-4a5a-bcf2-de7ea8e992a5
            type: string
        - name: userId
          required: false
          in: query
          description: User ID for filtering
          schema:
            example: null
            type: string
        - name: status
          required: false
          in: query
          description: Comma separated Document Status values
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Object'
        - name: search
          required: false
          in: query
          description: Document search string
          schema:
            example: ''
            type: string
        - name: documentType
          required: false
          in: query
          description: Comma separated Document Type IDs
          schema:
            example: null
            type: array
            items:
              type: string
        - name: oversight
          required: false
          in: query
          description: Comma separated Oversight Status values
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Object'
        - name: documentSharingType
          required: false
          in: query
          description: Comma separated Document Sharing Type values
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Object'
        - name: documentOwnerId
          required: false
          in: query
          description: Comma separated Document Owner IDs
          schema:
            example: null
            type: array
            items:
              type: string
        - name: isFavourite
          required: false
          in: query
          description: Document isFavourite
          schema:
            example: 'true'
            type: string
        - name: decisionLinkAllowed
          required: false
          in: query
          description: allow document link for decision
          schema:
            example: 'true'
            type: string
        - name: delegationLinkAllowed
          required: false
          in: query
          description: allow document link for delegation
          schema:
            example: 'true'
            type: string
        - name: responsibleUserId
          required: false
          in: query
          description: Comma separated Responsible User IDs
          schema:
            example: null
            type: array
            items:
              type: string
        - name: reviewerUserId
          required: false
          in: query
          description: Comma separated Reviewer User IDs
          schema:
            example: null
            type: array
            items:
              type: string
        - name: approverUserId
          required: false
          in: query
          description: Comma separated Approver User IDs
          schema:
            example: null
            type: array
            items:
              type: string
        - name: documentUploadType
          required: false
          in: query
          description: Document Upload Type/Source
          schema:
            $ref: '#/components/schemas/Object'
        - name: createdStartDate
          required: false
          in: query
          description: Start date time for date range filter on document created at
          schema:
            example: '2025-03-05T11:49:50.577Z'
            type: string
        - name: createdEndDate
          required: false
          in: query
          description: End date time for date range filter on document created at
          schema:
            example: '2025-03-05T11:49:50.577Z'
            type: string
        - name: updatedStartDate
          required: false
          in: query
          description: Start date time for date range filter on document updated at
          schema:
            example: '2025-03-05T11:49:50.577Z'
            type: string
        - name: updatedEndDate
          required: false
          in: query
          description: End date time for date range filter on document updated at
          schema:
            example: '2025-03-05T11:49:50.577Z'
            type: string
        - name: linkedDocumentIds
          required: false
          in: query
          description: >-
            Comma separated Document IDs already linked to decision/delegation
            (this is used to include already linked ARCHIVED documents in the
            list)
          schema:
            example: null
            type: array
            items:
              type: string
      responses:
        '200':
          description: Document counts retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentCountsResponseDtoResponse'
      security:
        - accessToken: []
components:
  schemas:
    Object:
      type: object
      properties: {}
    DocumentCountsResponseDtoResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP Status code
          example: 200
        timestamp:
          type: string
          description: Timestamp of the response
          example: '2026-01-12T09:12:23.874Z'
        message:
          type: string
          description: Response message
          example: Success
        data:
          description: Response data
          allOf:
            - $ref: '#/components/schemas/DocumentCountsResponseDto'
      required:
        - statusCode
        - timestamp
        - message
        - data
    DocumentCountsResponseDto:
      type: object
      properties:
        active:
          type: number
          example: 5
          description: Count of active documents (status = PUBLISHED)
        inactive:
          type: number
          example: 10
          description: Count of inactive documents (status = DRAFT or ARCHIVED)
        favorites:
          type: number
          example: 10
          description: >-
            Count of favorite documents for the current logged in user (status =
            PUBLISHED, DRAFT or ARCHIVED)
        all:
          type: number
          example: 15
          description: Count of all documents (status = PUBLISHED, DRAFT or ARCHIVED)
      required:
        - active
        - inactive
        - favorites
        - all
  securitySchemes:
    accessToken:
      scheme: bearer
      bearerFormat: JWT
      type: http

````