> ## Documentation Index
> Fetch the complete documentation index at: https://docs.goodgrants.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Retrieve assignments
> Retrieves assignments that match the specified filters.
## OpenAPI
````yaml /api-reference/openapi-v2_3.yaml get /assignment
openapi: 3.1.0
info:
title: Good Grants API
version: '2.3'
description: >
The Good Grants API enables you to programmatically manage grant-making
programs, funding cycles, and application workflows.
Use this API to:
- Create and manage grant applications and submissions
- Automate review workflows and scoring assignments
- Track grant payments and fund allocations
- Generate compliance reports and analytics
- Integrate with external systems via webhooks
All API requests require authentication using an API key provided in the
`X-Api-Key` header.
license:
name: Creative Force Client Subscription Terms
url: https://creativeforce.team/agreement/
servers:
- url: https://api.us.cr4ce.com
description: US regional endpoint
- url: https://api.eu.cr4ce.com
description: EU regional endpoint
- url: https://api.au.cr4ce.com
description: Australasia regional endpoint
- url: https://api.ca.cr4ce.com
description: Canada regional endpoint
- url: https://api.hk.cr4ce.com
description: Hong Kong regional endpoint
security:
- ApiKeyAuth: []
tags:
- name: Account
description: >-
Use this operation to retrieve information about your organization
account.
The account resource provides metadata about the tenant associated with
your API key.
Note: Account information is read-only and contains organization-level
settings and identifiers.
- name: Action tasks
description: >-
Use these operations to manage individual review and evaluation
activities.
Action tasks represent specific actions that reviewers or administrators
need to complete during the evaluation process.
Tasks track timestamps, decisions, and reviewer associations.
Action tasks integrate with the broader review workflow and status
tracking.
- name: Allocation payments
description: >-
Use these operations to manage individual payments made against grant
allocations.
Allocation payments represent installments or disbursements of awarded
funds.
Payments track scheduling, status (pending, paid, cancelled), and amounts.
Comments can be added to payments for grantee communication and
record-keeping purposes.
- name: Allocations
description: >-
Use these operations to manage grant allocations awarded to applications.
An allocation represents the award of funds from a budget (fund) to an
application or applicant.
Allocations track the total grant amount, currency, and outstanding
balance.
Multiple payments can be made against a single allocation to facilitate
installment-based grants or milestone payments.
- name: Applications (realtime)
description: >-
Use these operations to perform granular updates on applications without
replacing the entire resource.
These endpoints enable real-time updates to specific application
properties such as:
title, category assignment, chapter assignment, individual field values,
document uploads, tags, and recusal status.
These operations are optimized for interactive applications that need to
update grants incrementally.
- name: Applications
description: >-
Use these operations to manage grant applications submitted to your
funding programs.
Applications are the core entity that flows through the entire lifecycle
from submission to review to grant award.
Applications can contain custom form fields, supporting documents,
contributors, and be organized by categories and chapters.
Each application progresses through various statuses including draft,
submitted, under review, and approved stages.
- name: Assignments
description: >-
Use these operations to manage review assignments for evaluating grant
applications.
Assignments connect reviewers (or roles) with applications and scoring
rubrics to facilitate the evaluation process.
Assignments can be created individually or in bulk (asynchronous
operations).
Each assignment tracks completion status, scores, and panel membership.
Assignments enable structured review workflows with configurable scoring
criteria.
- name: Attachments
description: >-
Use these operations to manage files uploaded to applications through
attachment tabs.
Attachments are distinct from field-based file uploads and allow for
supplementary materials such as letters of support or compliance
documents.
Each attachment can have its own metadata and custom fields for
categorization.
Attachments remain associated with their application throughout the
application lifecycle.
- name: Categories
description: >-
Use these operations to manage funding categories or program areas.
Categories organize applications into logical groups and can be
hierarchical with parent-child relationships.
Each category can have its own application form, chapter availability,
submission limits, and custom labels.
Categories support translated names and descriptions for multi-language
grant programs.
- name: Chapters
description: >-
Use these operations to manage geographic or organizational divisions
within your grant programs.
Chapters enable you to run regional funding programs, manage local grants,
or organize by funding priorities.
Applications can be assigned to chapters, and chapters can have their own
administrators and configurations.
Chapters support translated names and custom images for branding.
- name: Contributors
description: >-
Use these operations to manage additional people associated with
applications beyond the primary applicant.
Contributors represent project team members, fiscal sponsors, or partners
on a grant proposal.
Each contributor can have their own custom fields and data collection
requirements.
Contributors are organized by tabs and can be managed independently from
the main application.
- name: Documents
description: >-
Use these operations to generate and retrieve PDF documents and data
exports.
Documents can be created based on application data, grantee data,
compliance reports, or other program information.
Document generation is asynchronous - after creating a document, poll the
endpoint to check when generation is complete.
Generated documents are available for download and can be associated with
specific applicants or applications.
- name: Fields
description: >-
Use these operations to manage custom form fields used to collect data
throughout your grant programs.
Fields can be attached to applications, users, contributors, attachments,
and other resources.
Supported field types include text, textarea, select, multi-select, date,
file upload, table, and more.
Fields support conditional logic, validation rules, and different
protection levels.
Note: Field deletion and updates are managed through the Good Grants
interface.
- name: Files
description: >-
Use these operations to retrieve information about uploaded files.
Files provide metadata and download links for documents uploaded
throughout the system.
Access files using their secure token identifiers.
Note: Files are read-only via this endpoint - file uploads are handled
through resource-specific upload endpoints.
- name: Forms
description: >-
Use these operations to retrieve application form structures and
configurations.
Forms define the data collection structure for grant applications within
categories.
Each form contains custom fields organized into tabs, along with content
blocks and call-to-action elements.
Forms support various types including application forms, review forms, and
nomination forms.
Note: Forms are read-only via the API and must be configured through the
Good Grants interface.
- name: Funds
description: >-
Use these operations to manage budget sources for allocations and grants.
Funds represent pools of money available for distribution, such as
"Innovation Fund 2026" or "Community Development Budget".
Each fund tracks its budget, currency, and can have multiple allocations
drawn against it.
Funds enable financial tracking and reporting across your grant-making
programs.
- name: Grant reports
description: >-
Use these operations to manage grant reports and post-award compliance
documentation.
Grant reports track progress reporting requirements and outcomes for
awarded grants.
Reports capture applicant information, application details, custom form
fields, and status tracking.
- name: Grant statuses
description: >-
Use these operations to retrieve custom grant lifecycle statuses.
Grant statuses provide additional status tracking beyond standard
application review statuses.
These are used to track stages like "Eligibility Review", "Compliance
Check", "Funding Approved", "Grant Agreement Signed".
Note: Grant statuses are read-only via the API and must be configured
through the Good Grants interface.
- name: Leaderboard
description: >-
Use these operations to retrieve ranking results and scores for
applications.
The leaderboard shows how applications rank based on score sets, with
support for filtering by category, chapter, and tags.
Results can be filtered to show specific subsets of the funding program.
Note: The leaderboard is read-only and reflects calculated results from
the review process.
- name: Rounds
description: >-
Use these operations to retrieve round information for your grant
programs.
Rounds represent phases within a funding cycle, such as application
rounds, review rounds, or decision rounds.
Each round has specific start and end dates, associated forms, and can be
scoped to specific chapters.
Note: Rounds are read-only via the API and must be managed through the
Good Grants interface.
- name: Score sets
description: >-
Use these operations to retrieve scoring rubrics and evaluation criteria.
Score sets define the questions, scoring scales, and calculation methods
used to evaluate grant applications.
Score sets can operate in different modes including scoring, ranking, and
decision-making.
Note: Score sets are read-only via the API and must be configured through
the Good Grants interface.
- name: Seasons
description: >-
Use these operations to retrieve information about funding cycles
(seasons).
A season represents a time-bound grant program instance, such as "2026
Community Grants" or "Q1 2026 Innovation Fund".
Seasons contain forms, rounds, categories, and chapters.
Seasons progress through statuses: draft, active, archived, and destroyed.
Note: Seasons are read-only via the API and must be managed through the
Good Grants interface.
- name: Taxes
description: >-
Use these operations to retrieve tax configurations for financial
transactions.
Tax settings define how taxes are calculated and applied to orders and
payments.
Note: Tax configurations are read-only via the API and must be managed
through the Good Grants interface.
- name: Users
description: >-
Use these operations to manage user accounts in your grant-making
organization.
Users represent people who interact with your programs, including
applicants, reviewers, administrators, and other roles.
Users can be assigned roles, have custom profile fields, receive
notifications, and authenticate via API tokens.
Each user has a unique slug identifier and can participate across multiple
funding cycles.
- name: Webhooks
description: >-
Use these operations to manage webhook subscriptions for real-time event
notifications.
Webhooks notify your external systems when events occur in Good Grants,
such as application submissions, status changes, or payment completions.
Available events include: application created, application submitted,
application status changed, payment success, user confirmed, and 20+ more.
Configure webhooks to send HTTP POST requests to your specified URLs with
event payloads.
paths:
/assignment:
get:
tags:
- Assignments
summary: Retrieve assignments
description: Retrieves assignments that match the specified filters.
operationId: GetAssignmentCollectionV23
parameters:
- $ref: '#/components/parameters/assignmentSlugFilter'
- $ref: '#/components/parameters/assignmentStatusFilter'
- $ref: '#/components/parameters/categoryFilter'
- $ref: '#/components/parameters/chapterFilter'
- $ref: '#/components/parameters/judgeFilter'
- $ref: '#/components/parameters/methodFilter'
- $ref: '#/components/parameters/panelFilter'
- $ref: '#/components/parameters/scoreSetFilter'
- $ref: '#/components/parameters/seasonFilter'
- $ref: '#/components/parameters/stateFilter'
- $ref: '#/components/parameters/tagFilter'
- $ref: '#/components/parameters/deletedFilter'
- $ref: '#/components/parameters/trashedFilter'
- $ref: '#/components/parameters/page'
- $ref: '#/components/parameters/perPage'
- $ref: '#/components/parameters/assignmentOrder'
- $ref: '#/components/parameters/sortDirection'
- $ref: '#/components/parameters/Accept'
- $ref: '#/components/parameters/X-Api-Language'
responses:
'200':
description: Assignments retrieved.
headers:
ETag:
$ref: '#/components/headers/ETag'
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/AssignmentList'
application/xml:
schema:
$ref: '#/components/schemas/AssignmentList'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/Forbidden'
'429':
$ref: '#/components/responses/TooManyRequests'
'503':
$ref: '#/components/responses/ServiceUnavailable'
components:
parameters:
assignmentSlugFilter:
name: slug
in: query
required: false
description: Filter to a single assignment by slug. Returns at most one item.
schema:
type: string
pattern: ^[A-Za-z0-9]{24}[JR]$
assignmentStatusFilter:
name: status
in: query
required: false
description: Filter by assignment status.
schema:
type: string
enum:
- none
- in_progress
- complete
- abstained
categoryFilter:
name: category
in: query
required: false
description: Filter by category slug.
schema:
type: string
chapterFilter:
name: chapter
in: query
required: false
description: Filter by chapter slug.
schema:
type: string
judgeFilter:
name: reviewer
in: query
required: false
description: Filter by reviewer slug.
schema:
type: string
methodFilter:
name: method
in: query
required: false
description: Filter by assignment method.
schema:
type: string
enum:
- automatic
- manual
- random
- stray
- recused
panelFilter:
name: panel
in: query
required: false
description: Filter by panel slug.
schema:
type: string
scoreSetFilter:
name: score_set
in: query
required: false
description: Filter by score set slug.
schema:
type: string
seasonFilter:
name: season
in: query
required: false
description: |-
Filter by season slug.
Use `all` to show all seasons.
schema:
type: string
stateFilter:
name: state
in: query
required: false
description: |-
Filter by application state.
* `current` - Only current (non-archived) applications.
* `archived` - Only archived applications.
* `all` - Include both current and archived applications.
* `only` - Equivalent to `archived`.
* `none` - Exclude all applications.
schema:
type: string
enum:
- current
- archived
- all
- only
- none
tagFilter:
name: tag
in: query
required: false
description: Filter by tag.
schema:
type: string
deletedFilter:
name: deleted
in: query
required: false
description: |-
Filter by deletion mode.
* `only` - Show only deleted resources.
* `included` - Include deleted resources.
* `none` - Exclude deleted resources.
schema:
type: string
enum:
- only
- included
- none
trashedFilter:
name: trashed
in: query
required: false
description: |-
Filter by soft-deletion mode.
* `only` - Show only soft-deleted resources.
* `all` - Include soft-deleted resources alongside live ones.
* `none` - Exclude soft-deleted resources.
schema:
type: string
enum:
- only
- all
- none
page:
name: page
in: query
required: false
description: Specify the page number to return.
schema:
type: number
perPage:
name: per_page
in: query
required: true
description: >
Limit the number of items returned to between 1 and 100.
If you provide a value outside this range, you will receive a `400`
response.
schema:
type: number
assignmentOrder:
name: order
in: query
required: false
description: |-
Sort by a supported assignment column. Unsupported values fall back
silently to the default sort (`updated` descending).
schema:
type: string
enum:
- method
- status
- updated
sortDirection:
name: dir
in: query
required: false
description: >-
Sort in ascending or descending order. Invalid values are rejected with
`400 Bad Request`.
schema:
type: string
enum:
- asc
- desc
Accept:
name: Accept
in: header
required: true
description: Defines the response type.
schema:
type: string
enum:
- application/vnd.Creative Force.v2.3+json
- application/vnd.Creative Force.v2.3+xml
X-Api-Language:
name: x-api-language
in: header
required: false
description: >-
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.
style: simple
explode: false
schema:
type: array
items:
type: string
enum:
- 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
example:
- en_GB
- fr_FR
headers:
ETag:
description: Entity tag for the selected representation.
schema:
type: string
X-RateLimit-Limit:
description: Maximum number of requests allowed per minute.
schema:
type: integer
example: 60
X-RateLimit-Remaining:
description: Number of requests remaining in the current rate limit window.
schema:
type: integer
example: 58
X-RateLimit-Reset:
description: Unix timestamp when the rate limit window resets.
schema:
type: integer
example: 1783470988
Retry-After:
description: Number of seconds the client should wait before retrying.
schema:
type: integer
example: 60
schemas:
AssignmentList:
allOf:
- $ref: '#/components/schemas/Pagination'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Assignment'
example:
current_page: 1
data:
- application:
slug: IjKlMnOp
link: https://api.au.cr4ce.com/application/IjKlMnOp
title: Photo series
category:
slug: QrStUvWx
link: https://api.au.cr4ce.com/category/QrStUvWx
name:
en_GB: Photography
chapter:
slug: MnOpQrSt
link: https://api.au.cr4ce.com/chapter/MnOpQrSt
name:
en_GB: Image
comments:
judging:
- slug: AbCdEfGh
comment: Strong composition.
created_at: '2025-05-20T11:00:00Z'
updated_at: '2025-05-20T11:00:00Z'
user:
slug: YzAbCdEf
link: https://api.au.cr4ce.com/user/YzAbCdEf
name: Jane Doe
first_name: Jane
last_name: Doe
abstention: []
conflict: []
criteria:
- name: Composition
comments: []
created: '2025-05-20T10:30:00Z'
form: GhIjKlMn
method: Stray
panels: []
reviewer:
slug: YzAbCdEf
link: https://api.au.cr4ce.com/judge/YzAbCdEf
name: Jane Doe
role: null
rounds: []
score: null
score_set:
slug: KlMnOpQr
link: https://api.au.cr4ce.com/score-set/KlMnOpQr
name:
en_GB: Scoring rubric
slug: IjKlMnOpYzAbCdEfKlMnOpQrA
status: To be scored
updated: '2025-06-10T09:00:00Z'
first_page_url: https://api.au.cr4ce.com/assignment?per_page=50&page=1
from: 1
last_page: 4
last_page_url: https://api.au.cr4ce.com/assignment?per_page=50&page=4
next_page_url: https://api.au.cr4ce.com/assignment?per_page=50&page=2
path: https://api.au.cr4ce.com/assignment
per_page: 50
prev_page_url: ''
to: 50
total: 175
Pagination:
type: object
title: Pagination
description: >-
Pagination envelope returned by every list endpoint.
Wraps the result set with positional fields (`current_page`, `from`,
`to`, `total`) and navigation URLs (`first_page_url`, `last_page_url`,
`next_page_url`, `prev_page_url`) for traversing the full list. The
records themselves are returned in a sibling `data` array supplied by
the wrapping schema.
properties:
current_page:
type: integer
description: Number of the page returned by this response. The first page is `1`.
first_page_url:
type: string
description: >-
URL of the first page in the result set. Relative when the requested
page is beyond the last page.
from:
type:
- integer
- 'null'
description: >-
Position of the first record on this page within the full result
set. The first record is at position `1`. `null` when the requested
page is beyond the last page.
last_page:
type: integer
description: Number of the last page. Equals the total number of pages.
last_page_url:
type: string
description: >-
URL of the last page in the result set. Relative when the requested
page is beyond the last page.
next_page_url:
type: string
description: |-
URL of the next page in the result set.
Empty string when the current page is the last page.
path:
type: string
description: Canonical URL of the endpoint, without query parameters.
per_page:
type: integer
minimum: 1
maximum: 100
default: 10
description: Maximum number of records returned per page.
prev_page_url:
type: string
description: |-
URL of the previous page in the result set.
Empty string when the current page is the first page.
to:
type:
- integer
- 'null'
description: >-
Position of the last record on this page within the full result set.
`null` when the requested page is beyond the last page.
total:
type: integer
description: Total number of records across all pages.
Assignment:
type: object
title: Assignment
description: >-
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.
properties:
application:
type: object
description: Application the assignment refers to.
properties:
slug:
type: string
description: Short URL-safe identifier for the application.
link:
type: string
format: uri
description: Canonical URL for the application resource.
title:
type: string
description: Title of the application as submitted by the applicant.
category:
type: object
description: Category the application belongs to.
properties:
slug:
type: string
description: Short URL-safe identifier for the category.
link:
type: string
format: uri
description: Canonical URL for the category resource.
name:
type: object
description: >-
Map keyed by locale code (for example `en_GB`, `fr_FR`). Keys
are drawn from the languages enabled on the account. Values are
the translated string.
additionalProperties:
type: string
chapter:
type: object
description: Chapter the category belongs to.
properties:
slug:
type: string
description: Short URL-safe identifier for the chapter.
link:
type: string
format: uri
description: Canonical URL for the chapter resource.
name:
type: object
description: >-
Map keyed by locale code (for example `en_GB`, `fr_FR`). Keys
are drawn from the languages enabled on the account. Values are
the translated string.
additionalProperties:
type: string
comments:
type:
- object
- 'null'
description: >-
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.
properties:
judging:
type: array
description: Comments left by the reviewer during scoring.
items:
type: object
properties:
slug:
type: string
description: Short URL-safe identifier for the comment.
comment:
type: string
description: >-
Comment body as an HTML fragment.
May contain block-level tags such as ``. Empty string
when the user saved a comment with no content.
created_at:
type: string
format: date-time
description: Time the comment was created.
updated_at:
type: string
format: date-time
description: Time the comment was last updated.
user:
type: object
description: User who left the comment.
properties:
slug:
type: string
description: Short URL-safe identifier for the user.
link:
type: string
format: uri
description: Canonical URL for the user resource.
name:
type: string
description: Full display name of the user.
first_name:
type: string
description: Given name of the user.
last_name:
type: string
description: Family name of the user.
abstention:
type: array
description: >-
Comments left when the reviewer marked the application as
abstained.
items:
type: object
properties:
slug:
type: string
description: Short URL-safe identifier for the comment.
comment:
type: string
description: >-
Comment body as an HTML fragment.
May contain block-level tags such as `
`. Empty string
when the user saved a comment with no content.
created_at:
type: string
format: date-time
description: Time the comment was created.
updated_at:
type: string
format: date-time
description: Time the comment was last updated.
user:
type: object
description: User who left the comment.
properties:
slug:
type: string
description: Short URL-safe identifier for the user.
link:
type: string
format: uri
description: Canonical URL for the user resource.
name:
type: string
description: Full display name of the user.
first_name:
type: string
description: Given name of the user.
last_name:
type: string
description: Family name of the user.
conflict:
type: array
description: Comments left when the reviewer flagged a conflict of interest.
items:
type: object
properties:
slug:
type: string
description: Short URL-safe identifier for the comment.
comment:
type: string
description: >-
Comment body as an HTML fragment.
May contain block-level tags such as `
`. Empty string
when the user saved a comment with no content.
created_at:
type: string
format: date-time
description: Time the comment was created.
updated_at:
type: string
format: date-time
description: Time the comment was last updated.
user:
type: object
description: User who left the comment.
properties:
slug:
type: string
description: Short URL-safe identifier for the user.
link:
type: string
format: uri
description: Canonical URL for the user resource.
name:
type: string
description: Full display name of the user.
first_name:
type: string
description: Given name of the user.
last_name:
type: string
description: Family name of the user.
criteria:
type: array
description: Comments grouped by score-set criterion.
items:
type: object
properties:
name:
type: string
description: >-
Display name of the criterion, rendered in the default
locale for the account (single string, not a locale map).
comments:
type: array
description: Comments left against this criterion.
items:
type: object
properties:
slug:
type: string
description: Short URL-safe identifier for the comment.
comment:
type: string
description: >-
Comment body as an HTML fragment.
May contain block-level tags such as `
`. Empty
string when the user saved a comment with no
content.
created_at:
type: string
format: date-time
description: Time the comment was created.
updated_at:
type: string
format: date-time
description: Time the comment was last updated.
user:
type: object
description: User who left the comment.
properties:
slug:
type: string
description: Short URL-safe identifier for the user.
link:
type: string
format: uri
description: Canonical URL for the user resource.
name:
type: string
description: Full display name of the user.
first_name:
type: string
description: Given name of the user.
last_name:
type: string
description: Family name of the user.
created:
type: string
format: date-time
description: Time the assignment was created.
form:
type: string
description: Slug of the form attached to the application.
method:
type: string
description: >-
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:
type: array
description: Panels the assignment is associated with.
items:
type: object
properties:
slug:
type: string
description: Short URL-safe identifier for the panel.
link:
type: string
format: uri
description: Canonical URL for the panel resource.
name:
type: object
description: >-
Map keyed by locale code (for example `en_GB`, `fr_FR`). Keys
are drawn from the languages enabled on the account. Values
are the translated string.
additionalProperties:
type: string
reviewer:
type:
- object
- 'null'
description: |-
Reviewer assigned to score the application.
`null` for role-based assignments where `role` is populated instead.
properties:
slug:
type: string
description: Short URL-safe identifier for the reviewer.
link:
type: string
format: uri
description: Canonical URL for the reviewer resource.
name:
type: string
description: Full display name of the reviewer.
role:
type:
- object
- 'null'
description: >-
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.
properties:
slug:
type: string
description: Short URL-safe identifier for the role.
link:
type: string
format: uri
description: Canonical URL for the role resource.
name:
type: object
description: >-
Map keyed by locale code (for example `en_GB`, `fr_FR`). Keys
are drawn from the languages enabled on the account. Values are
the translated string.
additionalProperties:
type: string
rounds:
type: array
description: Rounds the assignment applies to.
items:
type: object
properties:
slug:
type: string
description: Short URL-safe identifier for the round.
link:
type: string
format: uri
description: Canonical URL for the round resource.
name:
type: object
description: >-
Map keyed by locale code (for example `en_GB`, `fr_FR`). Keys
are drawn from the languages enabled on the account. Values
are the translated string.
additionalProperties:
type: string
score:
type:
- object
- 'null'
description: >-
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:
```json
{
"criteria": [
{
"name": { "en_GB": "Originality" },
"value": 7,
"max_score": 10,
"final_score": "7/10",
"weight": 1
}
],
"total_score": {
"value": 7,
"max_score": 10,
"final_score": "7/10"
}
}
```
Voting mode:
```json
{ "total_votes": 0 }
```
VIP and top-pick modes follow their own conventions.
score_set:
type:
- object
- 'null'
description: Score set used to evaluate the application.
properties:
slug:
type: string
description: Short URL-safe identifier for the score set.
link:
type: string
format: uri
description: Canonical URL for the score set resource.
name:
type: object
description: >-
Map keyed by locale code (for example `en_GB`, `fr_FR`). Keys
are drawn from the languages enabled on the account. Values are
the translated string.
additionalProperties:
type: string
slug:
type: string
description: Short URL-safe identifier for the assignment.
status:
type: string
description: |-
Current state of the assignment.
Known values include `To be scored`, `In progress`, and `Complete`.
updated:
type: string
format: date-time
description: Time the assignment was last updated.
example:
application:
slug: AbCdEfGh
link: https://api.au.cr4ce.com/application/AbCdEfGh
title: Project title
category:
slug: WxYzAbCd
link: https://api.au.cr4ce.com/category/WxYzAbCd
name:
en_GB: Documentary
chapter:
slug: MnOpQrSt
link: https://api.au.cr4ce.com/chapter/MnOpQrSt
name:
en_GB: Film
comments:
judging: []
abstention: []
conflict: []
criteria:
- name: Originality
comments: []
- name: Execution
comments: []
created: '2025-01-15T09:00:00Z'
form: GhIjKlMn
method: Automatic (Panel)
panels:
- slug: OpQrStUv
link: https://api.au.cr4ce.com/panel/OpQrStUv
name:
en_GB: Panel A
reviewer:
slug: EfGhIjKl
link: https://api.au.cr4ce.com/judge/EfGhIjKl
name: Jane Doe
role: null
rounds:
- slug: QrStUvWx
link: https://api.au.cr4ce.com/round/QrStUvWx
name:
en_GB: Judging
score: null
score_set:
slug: UvWxYzAb
link: https://api.au.cr4ce.com/score-set/UvWxYzAb
name:
en_GB: Scoring rubric
slug: AbCdEfGhEfGhIjKlUvWxYzAbA
status: To be scored
updated: '2025-06-20T14:30:00Z'
BadRequest:
allOf:
- $ref: '#/components/schemas/BaseProblem'
- type: object
properties:
status_code:
type: integer
minimum: 400
maximum: 400
Unauthorized:
allOf:
- $ref: '#/components/schemas/BaseProblem'
- type: object
properties:
status_code:
type: integer
minimum: 401
maximum: 401
Forbidden:
allOf:
- $ref: '#/components/schemas/BaseProblem'
- type: object
properties:
status_code:
type: integer
minimum: 403
maximum: 403
TooManyRequests:
allOf:
- $ref: '#/components/schemas/BaseProblem'
- type: object
properties:
status_code:
type: integer
minimum: 429
maximum: 429
BaseProblem:
description: Standard error envelope shared by every error response on this API.
type: object
properties:
message:
type: string
status_code:
type: integer
minimum: 400
maximum: 599
responses:
BadRequest:
description: >-
Request was rejected before the endpoint could process it. Common
causes: invalid `Accept` header, unsupported `x-api-language` code,
empty request body on `POST` / `PUT`, invalid JSON in the request body,
or an invalid slug format in a path parameter.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
application/xml:
schema:
$ref: '#/components/schemas/BadRequest'
Unauthorized:
description: Missing `x-api-key` header.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthorized'
application/xml:
schema:
$ref: '#/components/schemas/Unauthorized'
Forbidden:
description: |-
Authenticated request denied. Common causes: invalid or unknown
API key, suspended account, or `api` feature not enabled for
the account.
headers:
X-RateLimit-Limit:
$ref: '#/components/headers/X-RateLimit-Limit'
X-RateLimit-Remaining:
$ref: '#/components/headers/X-RateLimit-Remaining'
X-RateLimit-Reset:
$ref: '#/components/headers/X-RateLimit-Reset'
content:
application/json:
schema:
$ref: '#/components/schemas/Forbidden'
application/xml:
schema:
$ref: '#/components/schemas/Forbidden'
TooManyRequests:
description: Rate limit of 60 requests per minute exceeded.
headers:
Retry-After:
$ref: '#/components/headers/Retry-After'
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequests'
application/xml:
schema:
$ref: '#/components/schemas/TooManyRequests'
ServiceUnavailable:
description: Service is temporarily unavailable due to regional maintenance.
content:
application/json:
schema:
type: object
properties:
status:
type: string
description: Human-readable maintenance status.
example:
status: Maintenance in progress
application/xml:
schema:
type: object
properties:
status:
type: string
description: Human-readable maintenance status.
example:
status: Maintenance in progress
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: x-api-key
description: |-
API key used to authenticate and authorise every request.
Include it in the `x-api-key` header.
````