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

# List documents

> Return the documents in your organization, one page at a time.



## OpenAPI

````yaml api-reference/openapi.json GET /documents
openapi: 3.0.0
info:
  title: DSALTA API
  version: 1.0.0
  description: >-
    DSALTA Public API (v1). Authenticate with a Bearer API token issued from
    your organization settings. Each token carries resource-level scopes (e.g.
    documents:read).
  contact: {}
servers:
  - url: https://apip.dsalta.com/v1
    description: Production
security: []
paths:
  /documents:
    get:
      tags:
        - Documents
      summary: List Documents
      operationId: ListDocuments
      parameters:
        - in: query
          name: page
          required: false
          schema:
            type: number
            format: double
        - in: query
          name: limit
          required: false
          schema:
            type: number
            format: double
        - in: query
          name: search
          required: false
          schema:
            type: string
        - in: query
          name: framework
          required: false
          schema:
            type: string
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicListResponse_PublicDocument_'
              examples:
                Example 1:
                  value:
                    data:
                      - id: ckv1document00001
                        docId: DOC-014
                        name: Information Security Policy
                        type: POLICY
                        status: COMPLETED
                        description: Company-wide information security policy.
                        dueDate: null
                        frameworks:
                          - SOC 2
                        owner: Jane Doe
                        files:
                          - id: ckv1file00000001
                            url: >-
                              https://storage.googleapis.com/dsalta-bucket/evidence/doc-014.pdf?X-Goog-Expires=900
                            type: file
                        controls:
                          passing: 3
                          total: 3
                        createdAt: '2026-01-15T10:00:00.000Z'
                        updatedAt: '2026-11-01T08:30:00.000Z'
                    pagination:
                      page: 1
                      limit: 25
                      total: 1
                      totalPages: 1
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Example 1:
                  value:
                    success: false
                    message: Invalid or expired API token
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                Example 1:
                  value:
                    success: false
                    message: 'API token is missing required scope(s): documents:read'
      security:
        - apiToken:
            - documents:read
components:
  schemas:
    PublicListResponse_PublicDocument_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PublicDocument'
          type: array
        pagination:
          $ref: '#/components/schemas/PublicPaginationMeta'
      required:
        - data
        - pagination
      type: object
      additionalProperties: false
    ErrorResponse:
      properties:
        details:
          $ref: '#/components/schemas/Record_string.unknown_'
        message:
          type: string
        success:
          type: boolean
          enum:
            - false
          nullable: false
      required:
        - message
        - success
      type: object
    PublicDocument:
      properties:
        id:
          type: string
        docId:
          type: string
          description: Human-facing document number, e.g. "DOC-014".
        name:
          type: string
        type:
          type: string
          description: Document type, e.g. "POLICY" | "EVIDENCE".
        status:
          type: string
          description: Review status, e.g. "NOT_STARTED" | "IN_PROGRESS" | "COMPLETED".
        description:
          type: string
        dueDate:
          type: string
          nullable: true
          description: ISO 8601 due date, or null if none.
        frameworks:
          items:
            type: string
          type: array
          description: Names of the frameworks this document maps to.
        owner:
          type: string
          nullable: true
          description: Owner's display name, or null. Never an email or internal id.
        files:
          items:
            $ref: '#/components/schemas/PublicDocumentFile'
          type: array
          description: >-
            Evidence on the document — uploaded files and added links, each with
            an

            id so it can be removed. Empty when there is none.
        controls:
          properties:
            total:
              type: number
              format: double
            passing:
              type: number
              format: double
          required:
            - total
            - passing
          type: object
          nullable: true
          description: >-
            The controls this document is linked to as evidence: how many are
            passing

            out of the total. Null when the document is not linked to any
            control.
        createdAt:
          type: string
          description: ISO 8601 creation timestamp.
        updatedAt:
          type: string
          description: ISO 8601 last-update timestamp.
      required:
        - id
        - docId
        - name
        - type
        - status
        - description
        - dueDate
        - frameworks
        - owner
        - files
        - controls
        - createdAt
        - updatedAt
      type: object
      additionalProperties: false
    PublicPaginationMeta:
      description: >-
        Public API (v1) response envelope.


        The internal controllers are inconsistent — some return
        `SuccessResponse<T>`,

        some a bare `{ data, total }`. The public contract standardises on one
        shape

        so customers integrate against something stable:
          - single item  -> { data: T }
          - collection    -> { data: T[], pagination: {...} }

        These types are part of the published contract. Changing a field here is
        a

        breaking API change, not an internal refactor.
      properties:
        page:
          type: number
          format: double
          description: 1-based page number echoed back from the request.
        limit:
          type: number
          format: double
          description: Page size echoed back from the request.
        total:
          type: number
          format: double
          description: Total number of records across all pages.
        totalPages:
          type: number
          format: double
          description: Total number of pages at this page size.
      required:
        - page
        - limit
        - total
        - totalPages
      type: object
      additionalProperties: false
    Record_string.unknown_:
      properties: {}
      type: object
      description: Construct a type with a set of properties K of type T
    PublicDocumentFile:
      description: 'One piece of evidence on a document: an uploaded file or an added link.'
      properties:
        id:
          type: string
        url:
          type: string
          description: Short-lived download URL for a file, or the link URL for a link.
        type:
          type: string
          enum:
            - file
            - link
          description: '"file" (uploaded to DSALTA) or "link" (an external URL).'
      required:
        - id
        - url
        - type
      type: object
      additionalProperties: false
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer
      bearerFormat: DSALTA_API_TOKEN

````

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