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

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



## OpenAPI

````yaml api-reference/openapi.json GET /frameworks
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:
  /frameworks:
    get:
      tags:
        - Frameworks
      summary: List Frameworks
      operationId: ListFrameworks
      parameters:
        - in: query
          name: page
          required: false
          schema:
            type: number
            format: double
        - in: query
          name: limit
          required: false
          schema:
            type: number
            format: double
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PublicListResponse_PublicFramework_'
              examples:
                Example 1:
                  value:
                    data:
                      - id: ckv1framework0001
                        name: SOC 2
                        description: Trust Services Criteria
                        status: IN_PROGRESS
                        isActive: true
                        controlsCompleted: 42
                        evidenceCompleted: 120
                        readinessPercentage: 78
                        regions:
                          - US
                        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): frameworks:read'
      security:
        - apiToken:
            - frameworks:read
components:
  schemas:
    PublicListResponse_PublicFramework_:
      properties:
        data:
          items:
            $ref: '#/components/schemas/PublicFramework'
          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
    PublicFramework:
      description: >-
        Public (v1) shape for a framework. A curated, stable subset of the
        internal

        `Framework` model — the internal model can gain or rename fields without

        breaking this contract, because the mapper is the only thing that
        bridges the

        two. Dates are ISO 8601 strings, not `Date`, so the wire format is
        explicit.
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
          nullable: true
        status:
          type: string
          description: Review status, e.g. "NOT_STARTED" | "IN_PROGRESS" | "COMPLETED".
        isActive:
          type: boolean
          description: Whether the organisation has this framework switched on.
        controlsCompleted:
          type: number
          format: double
          description: Count of completed controls.
        evidenceCompleted:
          type: number
          format: double
          description: Count of collected evidence items.
        readinessPercentage:
          type: number
          format: double
          description: >-
            Share of this framework's policies, documents and active tests
            passing, as

            a whole percentage (0–100).
        regions:
          items:
            type: string
          type: array
          description: Regions/jurisdictions the framework applies to.
        createdAt:
          type: string
          description: ISO 8601 creation timestamp.
        updatedAt:
          type: string
          description: ISO 8601 last-update timestamp.
      required:
        - id
        - name
        - description
        - status
        - isActive
        - controlsCompleted
        - evidenceCompleted
        - readinessPercentage
        - regions
        - 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
  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.