Assessments

Get Assessment Record

Use this API to retrieve an assessment record containing basic assessment information, sections with questions and responses, and current status. By default, returns a lightweight version that excludes risk information, approvers, respondents, attachments, and other detailed metadata. Set showAllDetails=true to get the full export equivalent response. The informationRequests, notes and stageHistory datasets are not returned by this API; use the include parameter of Get Assessment to retrieve them.

get/api/assessment/v2/assessments/{assessmentId}/record

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/assessment/v2/assessments/{assessmentId}/record
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: ASSESSMENT_READ, ASSESSMENT

Path parameters

assessmentIdstring uuid required

UUID of the assessment

Query parameters

showAllDetailsboolean

When true, returns the full assessment export with all details including risks, approvers, respondents, attachments, etc. When false (default), returns a lightweight record with only basic info, sections, questions, and responses.

excludeSkippedQuestionsboolean

Flag to exclude skipped questions (only applicable when showAllDetails=true)

Response

OK

OR

Changes

No recorded changes to this operation across all 1 revision of this API.