devguard

Frameworks

Get a list of frameworks.

GET
/frameworks/

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

limit?number
Default100
Range5 <= value
page?number
Default1
Range1 <= value
organizationId*string
includeUserDefined?boolean
Defaulttrue
adoptedOnly?boolean
Defaultfalse
sortColumn?string
sortDirection?string
Value in"asc" | "desc"
search?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.devguard.ch/api/frameworks/?organizationId=string"
{
  "items": [
    {
      "id": "string",
      "organizationId": "string",
      "identifier": "string",
      "slug": "string",
      "version": "1.0",
      "identifierColor": "string",
      "publishedAt": "string",
      "deprecatedAt": "string",
      "isActive": true,
      "requiredTier": "free-trial",
      "name": "string",
      "description": "string",
      "isCentralized": true,
      "lastSyncAt": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "createdBy": "string",
      "_count": {
        "controls": 0
      },
      "frameworkAdoptions": [
        {
          "id": "string",
          "adoptedAt": "string"
        }
      ],
      "isAdopted": true,
      "adoption": {
        "id": "string",
        "adoptedAt": "string"
      }
    }
  ],
  "total": 0,
  "page": 0,
  "limit": 0
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

How is this guide?