Skip to main content
GET

Authorizations

x-api-key
string
header
required

API key used to authenticate and authorise every request. Include it in the x-api-key header.

Headers

Accept
enum<string>
required

Defines the response type.

Available options:
application/vnd.Creative Force.v2.3+json,
application/vnd.Creative Force.v2.3+xml
x-api-language
enum<string>[]

Defines the languages included in the response. If non are provided, the account default language is returned.

Value all overrides any other values present.

You can request multiple languages using a comma-separated string of languages.

The selected language must be supported by your account or a 400 error is returned.

Available options:
all,
ar_AR,
bg_BG,
bn_IN,
ca_ES,
cs_CZ,
cy_GB,
da_DK,
de_DE,
en_GB,
en_US,
el_GR,
es_NN,
es_LA,
et_EE,
fa_NN,
fi_FI,
fr_FR,
fr_CA,
he_IL,
hi_IN,
hr_HR,
hu_HU,
hy_AM,
it_IT,
ja_JP,
ko_KR,
lt_LT,
ms_MY,
nl_NL,
nb_NO,
pl_PL,
pt_BR,
ro_RO,
ru_RU,
sk_SK,
sl_SI,
sq_AL,
sr_RS,
sv_SE,
sw_NN,
th_TH,
tr_TR,
uk_UA,
vi_VN,
zh_CN,
zh_HK

Path Parameters

assignment_slug
string
required

Slug of the assignment.

Pattern: ^[A-Za-z0-9]{24}[JR]$

Response

Assignment retrieved.

Single scoring task for an application, addressed to either a reviewer or a role within a given round and score set.

Created automatically by panel allocation rules or manually by a panel manager. Lifecycle is tracked in status; the scoring outcome lives in score.

Exactly one of reviewer and role is populated.

application
object

Application the assignment refers to.

category
object

Category the application belongs to.

chapter
object

Chapter the category belongs to.

comments
object | null

Comments attached to the assignment.

null for role-based assignments (where role is populated and reviewer is absent), since role holders do not own per-assignment comment threads.

created
string<date-time>

Time the assignment was created.

form
string

Slug of the form attached to the application.

method
string

How the assignment was created.

Known values include Manual, Automatic (Panel), Recused, and Stray. Other values are possible depending on the score-set mode.

panels
object[]

Panels the assignment is associated with.

reviewer
object | null

Reviewer assigned to score the application.

null for role-based assignments where role is populated instead.

role
object | null

Role assigned to score the application, used when the assignment is shared across all holders of a role rather than addressed to one reviewer.

null for reviewer-specific assignments where reviewer is populated.

rounds
object[]

Rounds the assignment applies to.

score
object | null

Score for this assignment, formatted per the score-set mode. null when no score has been recorded.

Shape varies by score-set mode. Two confirmed shapes:

Regular numeric or qualifying mode:

Voting mode:

VIP and top-pick modes follow their own conventions.

score_set
object | null

Score set used to evaluate the application.

slug
string

Short URL-safe identifier for the assignment.

status
string

Current state of the assignment.

Known values include To be scored, In progress, and Complete.

updated
string<date-time>

Time the assignment was last updated.