Skip to main content
POST
Create an assessment

Authorizations

Authorization
string
header
required

An API key issued by a company administrator — an environment prefix (production: sdb_live_) followed by 32 characters. The prefix identifies the environment and MUST NOT be hard-coded or validated by clients; treat the whole key as opaque. Shown exactly once at creation; only a one-way hash is stored.

Scopes (granted per key on the create screen; :write never implies :read):

  • skills:read
  • skills:write
  • people:read
  • people:write
  • careers:read
  • careers:write
  • training:read
  • training:write
  • flags:read
  • flags:write
  • org:read
  • org:write
  • assessments:read
  • learning:read
  • learning:write
  • certifications:read
  • certifications:write
  • assessments:write
  • proficiency:read
  • proficiency:write
  • surveys:read
  • surveys:write
  • labels:read
  • labels:write

Headers

Idempotency-Key
string

Any unique string (at most 200 characters). Retrying with the same key and identical content replays the stored response for 24h instead of executing twice.

Maximum string length: 200

Body

application/json
title
string
required
Maximum string length: 500
Example:

"Q2 Skills Review"

description
string
Maximum string length: 4000
Example:

"Annual proficiency check-in."

managerGradesVisibleAt
enum<string>
default:immediately
Available options:
immediately,
after_employee_assessment,
after_manager_assessment,
after_assessment_ended
allPeople
boolean

Target everyone. Defaults to true when no scope is given.

Example:

true

scope
object

Population selections; ignored when allPeople is true.

peopleTypeIds
string[]

People type ids to include.

employeeDeadlineAt
string

Employee track deadline (ISO 8601).

Example:

"2026-03-31"

managerDeadlineAt
string

Manager track deadline (ISO 8601).

Example:

"2026-04-15"

Response

The created resource, enveloped.

data
object
required