sam|nord Developers
samnord.com
Assessments

GET /assessments/{id}

View a specific assessment. Requires assessments.read permission.

Path parameters

Name Type Required Description
id string yes The unique identifier of the record

Query parameters

Name Type Required Description
fields[] string[] no Select which fields to include in the response. When omitted, all fields are returned. When provided, only the specified fields are included. (e.g., ?fields[]=id&fields[]=title) One of: active, canonicalId, createdAt, description, educationalContentId, id, isCurrent, passPercentage, shuffleQuestions, status, timeLimitMinutes, title, updatedAt, version.
with[] string[] no Include related resources in the response. Pass multiple values as separate query parameters (e.g., ?with[]=createdBy&with[]=updatedBy). One of: createdBy, updatedBy, educationalContent, questions.

Responses

Status Description
200 A json object describing the assessment
403 The requesting user lacks appropriate permissions
404 The assessment was not found

Response 200 body

  • id string (uuid)
  • active boolean
  • canonicalId string (uuid)
  • createdAt string (date-time)
  • createdBy object
  • description string
  • educationalContent object
  • educationalContentId string (uuid)
  • isCurrent boolean
  • passPercentage integer
  • questions object[]
  • shuffleQuestions boolean
  • status string
  • timeLimitMinutes integer
  • title string
  • updatedAt string (date-time)
  • updatedBy object
  • version integer
{
    "id": "01944f76-3f07-76fe-b4fe-f8e5b0db5abe",
    "active": true,
    "canonicalId": "01944f76-3f07-76fe-b4fe-f8e5b0db5abe",
    "createdAt": "string",
    "createdBy": {
        "id": "string",
        "firstName": "string",
        "lastName": "string"
    },
    "description": "Test your knowledge of basic safety protocols",
    "educationalContent": {
        "id": "string",
        "title": "string"
    },
    "educationalContentId": "01944f76-3f07-76fe-b4fe-f8e5b0db5abc",
    "isCurrent": true,
    "passPercentage": 70,
    "questions": [
        {
            "id": "01944f76-3f07-76fe-b4fe-f8e5b0db5abe",
            "order": 0,
            "points": 1,
            "question": "What is the correct procedure for handling hazardous materials?",
            "required": true,
            "type": "multiple_choice"
        }
    ],
    "shuffleQuestions": false,
    "status": "draft",
    "timeLimitMinutes": 30,
    "title": "Safety Protocol Quiz",
    "updatedAt": "string",
    "updatedBy": {
        "id": "string",
        "firstName": "string",
        "lastName": "string"
    },
    "version": 1
}