---
title: "Get framework by ID"
method: GET
path: "/frameworks/{frameworkId}"
tags: ["Frameworks"]
---

# Get framework by ID

`GET /frameworks/{frameworkId}`

Get a framework by ID.

## Path parameters

- `frameworkId` string, required

## Response `200`

Ok

- FrameworkDetail
  - `id` string, required — The framework's unique ID.
  - `displayName` string, required — The framework's display name.
  - `shorthandName` string, required — The short version of the framework's display name.
  - `description` string, required — The framework's description.
  - `numControlsCompleted` number, double, required — The number of completed controls in the framework.
  - `numControlsTotal` number, double, required — The total number of controls in the framework.
  - `numDocumentsPassing` number, double, required — The number of passing documents in the framework.
  - `numDocumentsTotal` number, double, required — The total number of documents in the framework.
  - `numTestsPassing` number, double, required — The number of passing tests in the framework.
  - `numTestsTotal` number, double, required — The total number of tests in the framework.
  - `requirementCategories` FrameworkRequirementCategory[], required — The famework's list of requirement categories.
    - `id` string, required — The framework's requiremet category unique ID.
    - `name` string, required — The framework's requiremet category name.
    - `shorthand` string, nullable, required — The framework's short name.
    - `requirements` object[], required
      - `controls` object[], required — The requirement's list of controls
        - `description` string, required — The control's description.
        - `name` string, required — The control's name.
        - `externalId` string, nullable, required — The control's external ID.
        - `id` string, required — The control's unique ID.
      - `description` string, nullable, required — The requirement's description
      - `shorthand` string, nullable, required — The requirement's short name.
      - `name` string, required — The requirement's name.
      - `id` string, required — The requirement's unique ID.

---

[API](https://skmtc.net/vanta/apis/build-integrations.md) · [All operations](https://skmtc.net/vanta/apis/build-integrations/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vanta/build-integrations/revisions/6c1f7590538b/schema)