---
title: "Create a assessment"
method: POST
path: "/v1/org/{orgId}/assessment"
tags: ["assessment"]
---

# Create a assessment

`POST /v1/org/{orgId}/assessment`

## Path parameters

- `orgId` string, required

## Request body

- CreateAssessment
  - `label` string, required — human-readable label of assessment
  - `slug` string — unique slug of assessment
  - `type` 'REVIEW' | 'COMP_REVIEW' | 'SURVEY', required — type of assessment
  - `fields` object — assessment fields (description)
  - `shareAccess` ShareAccess[] — users who have been granted access to this assessment
    - `access` 'NONE' | 'LIMITED_READ' | 'LIMITED_WRITE' | 'STANDARD_READ' | 'STANDARD_WRITE' | 'COMPENSATION_READ' | 'FULL_READ' | 'COMP_PLANNING_PARTICIPANT' | 'COMPENSATION_WRITE' | 'WRITE' | 'COMPENSATION_OWNER' | 'OWNER', required — access permission level
    - `userId` string — user id
    - `groupId` string — group id
    - `fields` string — fields
  - `sensitive` 'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE' — view sensitivity of this assessment
  - `color` string — color of assessment
  - `startDate` string, date — Date this assessment begins. In the context of REVIEW goals, the date the review cycle begins.
  - `endDate` string, date — Date this assessment ends, or is completed. In the context of REVIEW assessment, the date the review cycle ends.
  - `status` 'DRAFT' | 'ACTIVE' | 'DONE' — status of this assessment - DRAFT, ACTIVE, DONE
  - `doneAt` string — timestamp when the status of this assessment was set to done
  - `taskCount` integer — number of tasks associated with this assessment
  - `taskDoneCount` integer — number of tasks associated with this assessment that are done
  - `peopleIncludedCount` integer — number of people included in this assessment
  - `query` string — Query for which people/jobs can be included in the review.
  - `showDatesInCalendar` boolean — True if user wants dates to show on company calendar
  - `calibrationHighlightedQuestionIds` string[] — Form questions to highlight during calibration. Only applies to REVIEW assessments.

## Response `201`

assessment created

- Assessment
  - `id` string, required — globally unique id
  - `orgId` string, required — parent organization id
  - `label` string, required — human-readable label of assessment
  - `slug` string, required — unique slug of assessment
  - `type` 'REVIEW' | 'COMP_REVIEW' | 'SURVEY', required — type of assessment
  - `fields` object — assessment fields (description)
  - `shareAccess` ShareAccess[] — users who have been granted access to this assessment
    - `access` 'NONE' | 'LIMITED_READ' | 'LIMITED_WRITE' | 'STANDARD_READ' | 'STANDARD_WRITE' | 'COMPENSATION_READ' | 'FULL_READ' | 'COMP_PLANNING_PARTICIPANT' | 'COMPENSATION_WRITE' | 'WRITE' | 'COMPENSATION_OWNER' | 'OWNER', required — access permission level
    - `userId` string — user id
    - `groupId` string — group id
    - `fields` string — fields
  - `sensitive` 'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE' — view sensitivity of this assessment
  - `color` string — color of assessment
  - `startDate` string, date — Date this assessment begins. In the context of REVIEW goals, the date the review cycle begins.
  - `endDate` string, date — Date this assessment ends, or is completed. In the context of REVIEW assessment, the date the review cycle ends.
  - `status` 'DRAFT' | 'ACTIVE' | 'DONE' — status of this assessment - DRAFT, ACTIVE, DONE
  - `doneAt` string — timestamp when the status of this assessment was set to done
  - `taskCount` integer — number of tasks associated with this assessment
  - `taskDoneCount` integer — number of tasks associated with this assessment that are done
  - `peopleIncludedCount` integer — number of people included in this assessment
  - `query` string — Query for which people/jobs can be included in the review.
  - `showDatesInCalendar` boolean — True if user wants dates to show on company calendar
  - `calibrationHighlightedQuestionIds` string[] — Form questions to highlight during calibration. Only applies to REVIEW assessments.
  - `createId` string — created by user id
  - `createBehalfId` string — created on behalf of user id
  - `createAttribution` Attribution
    - `principalUserId` string
    - `agentUserIds` string[]
    - `eventId` string
    - `aiChatId` string
    - `aiToolUseId` string
    - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
  - `createAt` string — created timestamp
  - `updateId` string — last updated by user id
  - `updateBehalfId` string — last updated on behalf of user id
  - `updateAttribution` Attribution
    - `principalUserId` string
    - `agentUserIds` string[]
    - `eventId` string
    - `aiChatId` string
    - `aiToolUseId` string
    - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
  - `updateAt` string — last updated timestamp
  - `deleteId` string — deleted by user id
  - `deleteBehalfId` string — deleted on behalf of user id
  - `deleteAttribution` Attribution
    - `principalUserId` string
    - `agentUserIds` string[]
    - `eventId` string
    - `aiChatId` string
    - `aiToolUseId` string
    - `channel` 'WEB' | 'MOBILE' | 'SLACK' | 'TEAMS' | 'MCP'
  - `deleteAt` string — deleted timestamp

## Other responses

- `400` — invalid data
- `401` — not authorized
- `403` — permission denied
- `404` — org not found

---

[API](https://skmtc.net/charthop/apis/charthop-api.md) · [All operations](https://skmtc.net/charthop/apis/charthop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/charthop/charthop-api/versions/50a1edd6b27e/schema)