Find frameworks by workspace id

List frameworks by workspace id

Securitybearer
Request
path Parameters
id
required
number
query Parameters
page
number >= 1
Default: 1

Which page of data are you requesting

limit
number [ 1 .. 50 ]
Default: 20

How many items are you requesting

q
string

Filter data by searching for framework names

excludeIds
Array of numbers

Exclude frameworks by array of id

Example:
getAll
boolean

return all frameworks?

isReady
boolean

Filter controls on if they are ready

Example: isReady=true
isEnabled
boolean
Default: true

Filter frameworks enabled

Example: isEnabled=true
Responses
200
400

Malformed data and/or validation errors

401

Invalid Authorization

403

You are not allowed to perform this action

404

Record Not Found

500

Internal server error

default

Response Code: 412

You must accept the Drata terms and conditions to use the API

get/workspaces/{id}/frameworks
Request samples
Response samples
application/json
{
  • "frameworks": [
    • {
      • "id": "123",
      • "name": "SOC2",
      • "hasLevel": true,
      • "levelLabel": true,
      • "selectedLevel": "42",
      • "privacy": true,
      • "description": "Report on controls at a Service Organization",
      • "longDescription": "",
      • "slug": "soc2-slug",
      • "tag": "SOC2",
      • "label": "SOC 2",
      • "totalInScopeControls": "42",
      • "numInScopeRequirements": "42",
      • "numReadyInScopeRequirements": "42",
      • "enabledAt": true,
      • "frameworkEnabled": true,
      • "controlsEnabled": true,
      • "color": "#174880",
      • "bgColor": "#174880",
      • "activeLogo": "https://drata.com",
      • "inactiveLogo": "https://drata.com",
      • "createdAt": "2020-07-06 12:00:00.000000",
      • "updatedAt": "2020-07-06 12:00:00.000000",
      • "isReady": true,
      • "productFrameworkEnabled": true,
      • "customFrameworkId": "123e4567-e89b-12d3-a456-426614174000",
      • "type": "CUSTOM"
      }
    ]
}