Skip to main content
GET
/
grc
/
assessments
/
{assessment_id}
Get GRC Assessment
curl --request GET \
  --url https://api.leen.dev/v1/grc/assessments/{assessment_id} \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-CONNECTION-ID: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "NEW",
  "respondent": "<string>",
  "control_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "template_id": "<string>",
  "template_name": "<string>",
  "vendor_attributes": {
    "id": "<string>",
    "vendor": "<string>",
    "data": {}
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "questions": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "question": "<string>",
      "description": "<string>",
      "question_type": "<string>",
      "question_type_metadata": {
        "type": "RADIO",
        "options": [
          "<any>"
        ]
      },
      "mandatory": false,
      "parent_vendor_id": "<string>",
      "vendor_attributes": {
        "id": "<string>",
        "vendor": "<string>",
        "data": {}
      },
      "response": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "sub_questions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "question": "<string>",
          "description": "<string>",
          "question_type": "<string>",
          "question_type_metadata": {
            "type": "RADIO",
            "options": [
              "<any>"
            ]
          },
          "mandatory": false,
          "parent_vendor_id": "<string>",
          "vendor_attributes": {
            "id": "<string>",
            "vendor": "<string>",
            "data": {}
          },
          "response": "<string>",
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z",
          "sub_questions": [
            {}
          ],
          "condition": {
            "operator": "EQ",
            "value": "<string>"
          }
        }
      ]
    }
  ]
}

Authorizations

​
X-CONNECTION-ID
string
header
required
​
X-API-KEY
string
header
required

Path Parameters

​
assessment_id
string<uuid>
required

Query Parameters

​
use_pool
boolean
default:true

Response

Successful Response

Response model for returning GRC assessment details via an API endpoint.

​
id
string<uuid>
required

Leen's UUID for the GRC assessment

​
template_id
string
required

Identifier for the assessment template

​
template_name
string
required

Name of the assessment template

​
vendor_attributes
object
required

Vendor-specific attributes and identifiers Vendor-specific attributes for assessments.

​
state
enum<string>
default:NEW

Current state of the assessment Enum for different statuses of an assessment.

Available options:
NEW,
IN_PROGRESS,
COMPLETED,
CANCELLED
​
respondent
string | null

Name or identifier of the respondent for the assessment

​
control_id
string<uuid> | null

Identifier of the associated GRC control

​
created_at
string<date-time> | null

Timestamp when the assessment was created

​
updated_at
string<date-time> | null

Timestamp when the assessment was last updated

​
questions
Assessment Question · object[] | null

List of questions along with their responses

⌘I