GOOD Grants Action tasks API

openapi: 3.2.0
info:
  title: Good Grants Action tasks 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: 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.'
paths:
  /action-task:
    post:
      summary: Create action task
      operationId: PostReviewTaskV23
      tags:
      - Action tasks
      parameters:
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/X-Api-Language'
      responses:
        '200':
          description: Action task created.
          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/ReviewTask'
            application/xml:
              schema:
                $ref: '#/components/schemas/ReviewTask'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      requestBody:
        $ref: '#/components/requestBodies/ReviewTaskCreate'
      description: Create an action task.
    get:
      summary: List action tasks
      operationId: GetReviewTaskCollectionV23
      tags:
      - Action tasks
      parameters:
      - $ref: '#/components/parameters/reviewTaskActionAtFilter'
      - $ref: '#/components/parameters/reviewTaskCreatedAtFilter'
      - $ref: '#/components/parameters/reviewTaskUpdatedAtFilter'
      - $ref: '#/components/parameters/decisionFilter'
      - $ref: '#/components/parameters/reviewStageFilter'
      - $ref: '#/components/parameters/reviewerFilter'
      - $ref: '#/components/parameters/seasonFilter'
      - $ref: '#/components/parameters/deletedFilter'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/X-Api-Language'
      responses:
        '200':
          description: Paginated list of action tasks.
          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/ReviewTaskList'
            application/xml:
              schema:
                $ref: '#/components/schemas/ReviewTaskList'
        '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'
      description: List action tasks.
  /action-task/{token}:
    parameters:
    - $ref: '#/components/parameters/token'
    get:
      summary: Get action task
      operationId: GetReviewTaskV23
      tags:
      - Action tasks
      parameters:
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/X-Api-Language'
      responses:
        '200':
          description: Action task 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/ReviewTask'
            application/xml:
              schema:
                $ref: '#/components/schemas/ReviewTask'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      description: Get the action task identified by the specified token.
    delete:
      summary: Delete action task
      operationId: DeleteReviewTaskV23
      tags:
      - Action tasks
      parameters:
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/X-Api-Language'
      responses:
        '204':
          description: No content.
          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'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      description: Delete the action task identified by the specified token.
components:
  schemas:
    Forbidden:
      allOf:
      - $ref: '#/components/schemas/BaseProblem'
      - type: object
        properties:
          status_code:
            type: integer
            minimum: 403
            maximum: 403
    NotFound:
      allOf:
      - $ref: '#/components/schemas/BaseProblem'
      - type: object
        properties:
          status_code:
            type: integer
            minimum: 404
            maximum: 404
    BadRequest:
      allOf:
      - $ref: '#/components/schemas/BaseProblem'
      - type: object
        properties:
          status_code:
            type: integer
            minimum: 400
            maximum: 400
    TooManyRequests:
      allOf:
      - $ref: '#/components/schemas/BaseProblem'
      - type: object
        properties:
          status_code:
            type: integer
            minimum: 429
            maximum: 429
    UnprocessableEntity:
      allOf:
      - $ref: '#/components/schemas/BaseProblem'
      - type: object
        properties:
          status_code:
            type: integer
            minimum: 422
            maximum: 422
          errors:
            type: object
            description: Map of request field to the list of validation messages, present only on field-level validation failures.
            additionalProperties:
              type: array
              items:
                type: string
    ReviewTask:
      title: Action task
      description: Single action task, an application paired with an action stage, listing the reviewers responsible for actioning it.
      type: object
      properties:
        action_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Date and time when the action task was actioned, `null` if not yet actioned.
        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: Translated name of the category, keyed by locale code.
              additionalProperties:
                type: string
        created:
          type: string
          format: date-time
          description: Date and time when the action task was created.
        decision:
          type:
          - string
          - 'null'
          description: Decision recorded against the action task, `null` if none recorded.
        application:
          type: object
          description: Application the action task relates 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.
        action_stage:
          type: object
          description: Action stage the task belongs to.
          properties:
            slug:
              type: string
              description: Short URL-safe identifier for the action stage.
            link:
              type: string
              format: uri
              description: Canonical URL for the action stage resource.
            name:
              type: object
              description: Translated name of the action stage, keyed by locale code.
              additionalProperties:
                type: string
        reviewer:
          type: array
          description: Reviewers responsible for actioning the action task.
          items:
            type: object
            properties:
              name:
                type: string
                description: Display name of the reviewer.
              email:
                type: string
                format: email
                description: Email address of the reviewer.
        season:
          type: object
          description: Season the application belongs to.
          properties:
            slug:
              type: string
              description: Short URL-safe identifier for the season.
            link:
              type: string
              format: uri
              description: Canonical URL for the season resource.
            name:
              type: object
              description: Translated name of the season, keyed by locale code.
              additionalProperties:
                type: string
        token:
          type: string
          description: Token uniquely identifying the action task.
        updated:
          type: string
          format: date-time
          description: Date and time when the action task was last updated.
      example:
        action_at: null
        category:
          slug: CdEfGhIj
          link: https://api.au.cr4ce.com/category/CdEfGhIj
          name:
            en_GB: Photography
        created: '2026-01-15T09:00:00Z'
        decision: null
        application:
          slug: AbCdEfGh
          link: https://api.au.cr4ce.com/application/AbCdEfGh
          title: Sustainable Cities Initiative
        action_stage:
          slug: EfGhIjKl
          link: https://api.au.cr4ce.com/action-stage/EfGhIjKl
          name:
            en_GB: First round
        reviewer:
        - name: Jane Smith
          email: jane.smith@example.com
        season:
          slug: QrStUvWx
          link: https://api.au.cr4ce.com/season/QrStUvWx
          name:
            en_GB: '2025'
        token: REDACTED
        updated: '2026-01-15T09:00:00Z'
    Pagination:
      type: object
      title: Pagination
      properties:
        current_page:
          type: integer
          description: Number of the page returned by this response, starting at `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, starting at `1`, or `null` when the requested page is beyond the last page.
        last_page:
          type: integer
          description: 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 when the current page is the last page.
        path:
          type: string
          description: Canonical URL of the endpoint, without query parameters.
        per_page:
          type: integer
          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 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, or `null` when the requested page is beyond the last page.
        total:
          type: integer
          description: Total number of records across all pages.
    BaseProblem:
      description: Standard error envelope for all API error responses.
      type: object
      properties:
        message:
          type: string
        status_code:
          type: integer
          minimum: 400
          maximum: 599
    ReviewTaskList:
      title: Action task list
      description: Paginated list of action tasks.
      allOf:
      - $ref: '#/components/schemas/Pagination'
      - type: object
        properties:
          data:
            type: array
            description: Action tasks for the current page.
            items:
              $ref: '#/components/schemas/ReviewTask'
      example:
        current_page: 1
        data:
        - action_at: null
          category:
            slug: CdEfGhIj
            link: https://api.au.cr4ce.com/category/CdEfGhIj
            name:
              en_GB: Photography
          created: '2026-01-15T09:00:00Z'
          decision: null
          application:
            slug: AbCdEfGh
            link: https://api.au.cr4ce.com/application/AbCdEfGh
            title: Sustainable Cities Initiative
          action_stage:
            slug: EfGhIjKl
            link: https://api.au.cr4ce.com/action-stage/EfGhIjKl
            name:
              en_GB: First round
          reviewer:
          - name: Jane Smith
            email: jane.smith@example.com
          season:
            slug: QrStUvWx
            link: https://api.au.cr4ce.com/season/QrStUvWx
            name:
              en_GB: '2025'
          token: REDACTED
          updated: '2026-01-15T09:00:00Z'
        first_page_url: https://api.au.cr4ce.com/action-task?page=1
        from: 1
        last_page: 1
        last_page_url: https://api.au.cr4ce.com/action-task?page=1
        next_page_url: ''
        path: https://api.au.cr4ce.com/action-task
        per_page: 10
        prev_page_url: ''
        to: 1
        total: 1
    Unauthorized:
      allOf:
      - $ref: '#/components/schemas/BaseProblem'
      - type: object
        properties:
          status_code:
            type: integer
            minimum: 401
            maximum: 401
  responses:
    NotFound:
      description: Resource identified by the path slug does not exist. Returned when the slug is well-formed but no record matches it.
      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/NotFound'
        application/xml:
          schema:
            $ref: '#/components/schemas/NotFound'
    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
    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'
    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'
    UnprocessableEntity:
      description: 'Request was syntactically valid but could not be processed.


        Returned in two scenarios:


        - **Field-level validation failure** — one or more request fields violated the endpoint''s validation rules. The body includes an `errors` map keyed by field name with one or more validation messages each.

        - **Resource-state precondition failure** — the request fields were all valid, but the target resource was in a state that does not permit the requested operation. The body carries only `message` and `status_code`; no `errors` map.'
      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/UnprocessableEntity'
        application/xml:
          schema:
            $ref: '#/components/schemas/UnprocessableEntity'
    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'
    Forbidden:
      description: 'Authenticated request denied. Common causes: invalid or unknown

        API key, suspended account, `api` feature not enabled for

        the account, or a read-only API key used for a request that

        is not a `GET`.'
      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'
  parameters:
    reviewerFilter:
      name: reviewer
      in: query
      required: false
      description: Filter by reviewer name or email.
      schema:
        type: string
    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
    token:
      name: token
      in: path
      description: Token string.
      required: true
      schema:
        type: string
        pattern: ^[A-Za-z0-9]{16}$|^[A-Za-z0-9]{32}$
    reviewTaskCreatedAtFilter:
      name: created_at
      in: query
      required: false
      description: 'Filter by creation timestamp.

        Supported values:

        * `[before]=YYYY-MM-DDTHH:MM:SSZ`

        * `[after]=YYYY-MM-DDTHH:MM:SSZ`

        * `[on]=YYYY-MM-DDTHH:MM:SSZ`

        * `[between]=[YYYY-MM-DDTHH:MM:SSZ,YYYY-MM-DDTHH:MM:SSZ]`'
      schema:
        type: string
    decisionFilter:
      name: decision
      in: query
      required: false
      description: Filter by decision name.
      schema:
        type: string
    reviewStageFilter:
      name: action_stage
      in: query
      required: false
      description: Filter by action stage slug.
      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
    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
    seasonFilter:
      name: season
      in: query
      required: false
      description: 'Filter by season slug.

        Use `all` to show all seasons.'
      schema:
        type: string
    reviewTaskActionAtFilter:
      name: action_at
      in: query
      required: false
      description: 'Filter by action timestamp.

        Supported values:

        * `[before]=YYYY-MM-DDTHH:MM:SSZ`

        * `[after]=YYYY-MM-DDTHH:MM:SSZ`

        * `[on]=YYYY-MM-DDTHH:MM:SSZ`

        * `[between]=[YYYY-MM-DDTHH:MM:SSZ,YYYY-MM-DDTHH:MM:SSZ]`'
      schema:
        type: string
    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: integer
        minimum: 1
        maximum: 100
        default: 10
    reviewTaskUpdatedAtFilter:
      name: updated_at
      in: query
      required: false
      description: 'Filter by update timestamp.

        Supported values:

        * `[before]=YYYY-MM-DDTHH:MM:SSZ`

        * `[after]=YYYY-MM-DDTHH:MM:SSZ`

        * `[on]=YYYY-MM-DDTHH:MM:SSZ`

        * `[between]=[YYYY-MM-DDTHH:MM:SSZ,YYYY-MM-DDTHH:MM:SSZ]`'
      schema:
        type: string
    page:
      name: page
      in: query
      required: false
      description: Specify the page number to return.
      schema:
        type: integer
        minimum: 1
        default: 1
  requestBodies:
    ReviewTaskCreate:
      description: Action task creation payload.
      content:
        application/json:
          schema:
            type: object
            additionalProperties: false
            required:
            - action_stage
            - application
            properties:
              action_stage:
                type: string
                pattern: ^[A-Za-z]{8}$
                description: 'Slug of the action stage.

                  Action stages reviewed by referees cannot be used to create action tasks.'
              application:
                type: string
                pattern: ^[A-Za-z]{8}$
                description: Slug of the application.
          examples:
            default:
              summary: Create an action task for an application at an action stage
              value:
                action_stage: AbCdEfGh
                application: PqRsTuVw
      required: true
  headers:
    X-RateLimit-Remaining:
      description: Number of requests remaining in the current rate limit window.
      schema:
        type: integer
        example: 58
    X-RateLimit-Limit:
      description: Maximum number of requests allowed per minute.
      schema:
        type: integer
        example: 60
    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
    ETag:
      description: Entity tag for the selected representation.
      schema:
        type: string
  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.'