GOOD Grants Forms API

openapi: 3.2.0
info:
  title: Good Grants Forms 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: 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 organised 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.'
paths:
  /form:
    get:
      summary: List forms
      operationId: GetFormCollectionV23
      tags:
      - Forms
      parameters:
      - $ref: '#/components/parameters/formTypeFilter'
      - $ref: '#/components/parameters/seasonFilter'
      - $ref: '#/components/parameters/archivedFilter'
      - $ref: '#/components/parameters/deletedFilter'
      - $ref: '#/components/parameters/page'
      - $ref: '#/components/parameters/perPage'
      - $ref: '#/components/parameters/formOrder'
      - $ref: '#/components/parameters/sortDirection'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/X-Api-Language'
      responses:
        '200':
          description: Paginated list of forms.
          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/FormList'
            application/xml:
              schema:
                $ref: '#/components/schemas/FormList'
        '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 forms.
  /form/{form_slug}:
    get:
      summary: Get form
      operationId: GetFormV23
      tags:
      - Forms
      parameters:
      - $ref: '#/components/parameters/formSlug'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/X-Api-Language'
      responses:
        '200':
          description: Form 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/Form'
            application/xml:
              schema:
                $ref: '#/components/schemas/Form'
        '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 form identified by the specified slug.
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
    FormList:
      allOf:
      - $ref: '#/components/schemas/Pagination'
      - type: object
        properties:
          data:
            type: array
            items:
              $ref: '#/components/schemas/Form'
      example:
        current_page: 1
        data:
        - callToAction:
            en_GB: ''
          chapter_option: all
          content_block: null
          created: '2026-03-16T08:48:37Z'
          name:
            en_GB: Non-default form (copy)
          season:
            slug: wboyrBmo
            link: https://api.au.cr4ce.com/season/wboyrBmo
            name:
              en_GB: '2026'
          slug: dRRJnXKl
          type: application
          updated: '2026-03-16T08:48:37Z'
        - callToAction:
            en_GB: ''
          chapter_option: all
          content_block: null
          created: '2025-12-23T14:41:16Z'
          name:
            en_GB: grant report form QA
          season:
            slug: wboyrBmo
            link: https://api.au.cr4ce.com/season/wboyrBmo
            name:
              en_GB: '2026'
          slug: rkkkkjle
          type: report
          updated: '2025-12-23T14:41:16Z'
        first_page_url: https://api.au.cr4ce.com/form?per_page=10&page=1
        from: 1
        last_page: 2
        last_page_url: https://api.au.cr4ce.com/form?per_page=10&page=2
        next_page_url: https://api.au.cr4ce.com/form?per_page=10&page=2
        path: https://api.au.cr4ce.com/form
        per_page: 10
        prev_page_url: ''
        to: 10
        total: 20
    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
    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
    Form:
      title: Form
      description: Form used to collect applications within a season.
      type: object
      properties:
        callToAction:
          type: object
          description: Translated call to action of the form, keyed by locale code.
          additionalProperties:
            type: string
        chapter_option:
          type: string
          description: 'How chapters are applied to the form.

            * `all` - Available to every chapter.

            * `select` - Available to selected chapters only.'
          enum:
          - all
          - select
        content_block:
          type:
          - object
          - 'null'
          description: Content block displayed with the form, or null if none is assigned.
          properties:
            slug:
              type: string
              description: URL-safe identifier of the content block.
            link:
              type: string
              format: uri
              description: Canonical URL for the content block resource.
            name:
              type: object
              description: Translated name of the content block, keyed by locale code.
              additionalProperties:
                type: string
        created:
          type: string
          format: date-time
          description: Date and time when the form was created.
        name:
          type: object
          description: Translated name of the form, keyed by locale code.
          additionalProperties:
            type: string
        season:
          type:
          - object
          - 'null'
          description: Season the form belongs to, or null if not assigned.
          properties:
            slug:
              type: string
              description: URL-safe identifier of 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
        slug:
          type: string
          description: URL-safe identifier of the form.
        type:
          type: string
          description: 'Type of the form.

            * `application` - Collects applications.

            * `report` - Collects grant reports.'
          enum:
          - application
          - report
        updated:
          type: string
          format: date-time
          description: Date and time when the form was last updated.
      example:
        callToAction:
          en_GB: ''
        chapter_option: select
        content_block: null
        created: '2024-09-30T10:11:17Z'
        name:
          en_GB: Cycling grants
        season:
          slug: wboyrBmo
          link: https://api.au.cr4ce.com/season/wboyrBmo
          name:
            en_GB: '2026'
        slug: WvmnJgjV
        type: application
        updated: '2025-10-16T08:00:39Z'
    Unauthorized:
      allOf:
      - $ref: '#/components/schemas/BaseProblem'
      - type: object
        properties:
          status_code:
            type: integer
            minimum: 401
            maximum: 401
  parameters:
    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
    formSlug:
      name: form_slug
      in: path
      required: true
      description: Slug of the form.
      schema:
        type: string
        pattern: ^[A-Za-z]{8}$
    formTypeFilter:
      name: form_type
      in: query
      required: false
      description: Filter by form type.
      schema:
        type: string
        enum:
        - application
        - report
    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
    formOrder:
      name: order
      in: query
      required: false
      description: Column name to order by. An unrecognised value falls back to the default sort by `created`.
      schema:
        type: string
        enum:
        - callToAction
        - chapter_option
        - content_block
        - created
        - name
        - season
        - slug
        - type
        - updated
    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
    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
    archivedFilter:
      name: archived
      in: query
      required: false
      description: 'Filter by archive mode.

        * `only` - Show only archived resources.

        * `all` - Include archived resources.

        * `none` - Exclude archived resources.'
      schema:
        type: string
        enum:
        - only
        - all
        - none
    page:
      name: page
      in: query
      required: false
      description: Specify the page number to return.
      schema:
        type: integer
        minimum: 1
        default: 1
  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'
    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'
  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.'