> ## Documentation Index
> Fetch the complete documentation index at: https://docs.awardforce.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: Award Force API
  version: '2.3'
  description: >
    The Award Force API enables you to programmatically manage awards,
    competitions, scholarships, and recognition programs.


    Use this API to:

    - Create and manage entries and submissions

    - Automate judging workflows and assignments

    - Process entry fees and payments

    - Generate 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: Assignments
    description: >-
      Use these operations to manage judging assignments for evaluating entries.

      Assignments connect judges (or roles) with entries and score sets to
      facilitate the review process.


      Assignments can be created individually or in bulk (asynchronous
      operations).

      Each assignment tracks completion status, scores, and panel membership.

      Assignments enable structured evaluation workflows with configurable score
      sets.
  - name: Attachments
    description: >-
      Use these operations to manage files uploaded to entries through
      attachment tabs.

      Attachments are distinct from field-based file uploads and allow for
      supplementary materials.


      Each attachment can have its own metadata and custom fields for
      categorization.

      Attachments remain associated with their entry throughout the entry
      lifecycle.
  - name: Categories
    description: >-
      Use these operations to manage competition categories or award divisions.

      Categories organize entries into logical groups and can be hierarchical
      with parent-child relationships.


      Each category can have its own entry form, chapter availability, entry
      limits, and custom labels.

      Categories support translated names and descriptions for multi-language
      programs.
  - name: Chapters
    description: >-
      Use these operations to manage geographic or organizational divisions
      within your programs.

      Chapters enable you to run regional competitions, manage local awards, or
      organize by business units.


      Entries 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 entries
      beyond the primary entrant.

      Contributors represent team members, collaborators, or co-authors on a
      submission.


      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 entry.
  - name: Documents
    description: >-
      Use these operations to generate and retrieve PDF documents and data
      exports.

      Documents can be created based on entry data, user data, 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 entrants or entries.
  - name: Entries
    description: >-
      Use these operations to manage entries (submissions) to your awards,
      competitions, or recognition programs.

      Entries are the core entity that flows through the entire lifecycle from
      submission to judging to winner selection.


      Entries can contain custom form fields, file uploads, contributors, and be
      organized by categories and chapters.

      Each entry goes through various statuses including draft, submitted, under
      review, and finalist stages.
  - name: Entries (realtime)
    description: >-
      Use these operations to perform granular updates on entries without
      replacing the entire resource.

      These endpoints enable real-time updates to specific entry properties such
      as:

      title, category assignment, chapter assignment, individual field values,
      file uploads, tags, and recusal status.


      These operations are optimized for interactive programs that need to
      update entries incrementally.
  - name: Fields
    description: >-
      Use these operations to manage custom form fields used to collect data
      throughout your programs.

      Fields can be attached to entries, 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 Award Force
      interface.
  - name: Files
    description: >-
      Use these operations to retrieve information about uploaded files.

      Files provide metadata and download links for content 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: Leaderboard
    description: >-
      Use these operations to retrieve ranking results and scores for entries.

      The leaderboard shows how entries rank based on score sets, with support
      for filtering by category, chapter, and tags.


      Results can be filtered to show specific subsets of the competition.

      Note: The leaderboard is read-only and reflects calculated results from
      the judging process.
  - name: Orders
    description: >-
      Use these operations to manage payment transactions for entry fees and
      other charges.

      Orders represent financial transactions processed through your program.


      Each order contains line items, tracks payment status, and can operate in
      test or live mode.

      Orders are associated with seasons and can be queried for financial
      reporting.
  - name: Review tasks
    description: >-
      Use these operations to manage individual review and evaluation
      activities.

      Review tasks represent specific actions that judges or administrators need
      to complete during the evaluation process.


      Tasks track timestamps, decisions, and judge associations.

      Review tasks integrate with the broader judging workflow and status
      tracking.
  - name: Rounds
    description: >-
      Use these operations to retrieve round information for your programs.

      Rounds represent phases within a season, such as entry rounds, judging
      rounds, or finalist 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
      Award Force interface.
  - name: Score sets
    description: >-
      Use these operations to retrieve score set configurations and evaluation
      criteria.

      Score sets define the questions, scales, and calculation methods used to
      evaluate entries.


      Score sets can operate in different modes including judging, ranking, and
      decision-making.

      Note: Score sets are read-only via the API and must be configured through
      the Award Force interface.
  - name: Seasons
    description: >-
      Use these operations to retrieve information about seasons (program
      cycles).

      A season represents a time-bound program instance, such as "2026 Awards"
      or "Q1 2026 Scholarship Round".


      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
      Award Force 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 Award Force interface.
  - name: Users
    description: >-
      Use these operations to manage user accounts in your organization.

      Users represent people who interact with your programs, including
      entrants, judges, 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
      seasons.
  - name: Webhooks
    description: >-
      Use these operations to manage webhook subscriptions for real-time event
      notifications.

      Webhooks notify your external systems when events occur in Award Force,
      such as entry submissions, status changes, or payment completions.


      Available events include: entry created, entry submitted, entry 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: judge
      in: query
      required: false
      description: Filter by judge 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 entry state.
        * `current` - Only current (non-archived) entries.
        * `archived` - Only archived entries.
        * `all` - Include both current and archived entries.
        * `only` - Equivalent to `archived`.
        * `none` - Exclude all entries.
      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: false
      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:
          - entry:
              slug: IjKlMnOp
              link: https://api.au.cr4ce.com/entry/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: <p>Strong composition.</p>
                  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: []
            judge:
              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 judging task for an entry, addressed to either a judge 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 judging outcome lives in
        `score`.


        Exactly one of `judge` and `role` is populated.
      properties:
        entry:
          type: object
          description: Entry the assignment refers to.
          properties:
            slug:
              type: string
              description: Short URL-safe identifier for the entry.
            link:
              type: string
              format: uri
              description: Canonical URL for the entry resource.
            title:
              type: string
              description: Title of the entry as submitted by the entrant.
        category:
          type: object
          description: Category the entry 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
            `judge` is absent), since role holders do not own per-assignment
            comment threads.
          properties:
            judging:
              type: array
              description: Comments left by the judge during evaluation.
              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 `<p>`. 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 judge marked the entry 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 `<p>`. 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 judge 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 `<p>`. 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 `<p>`. 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 entry.
        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
        judge:
          type:
            - object
            - 'null'
          description: |-
            Judge assigned to score the entry.

            `null` for role-based assignments where `role` is populated instead.
          properties:
            slug:
              type: string
              description: Short URL-safe identifier for the judge.
            link:
              type: string
              format: uri
              description: Canonical URL for the judge resource.
            name:
              type: string
              description: Full display name of the judge.
        role:
          type:
            - object
            - 'null'
          description: >-
            Role assigned to score the entry, used when the assignment is shared
            across all holders of a role rather than addressed to one judge.


            `null` for judge-specific assignments where `judge` 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 entry.
          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:
        entry:
          slug: AbCdEfGh
          link: https://api.au.cr4ce.com/entry/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
        judge:
          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.

````