GOOD Grants Grant reports API

openapi: 3.2.0
info:
  title: Good Grants Grant reports 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: Grant reports
  description: 'Use these operations to manage grant reports and post-award compliance documentation.

    Grant reports track progress reporting requirements and outcomes for awarded grants.


    Reports capture applicant information, application details, custom form fields, and status tracking.'
paths: {}
webhooks:
  grant-report-created:
    post:
      summary: Grant report created
      operationId: GrantReportCreatedWebhookV23
      x-products:
      - Good Grants
      tags:
      - Grant reports
      parameters:
      - $ref: '#/components/parameters/Signature'
      security: []
      requestBody:
        $ref: '#/components/requestBodies/GrantReportWebhook'
      responses:
        '200':
          description: Return any 2xx status code to acknowledge receipt of the event.
  grant-report-submitted:
    post:
      summary: Grant report submitted
      operationId: GrantReportSubmittedWebhookV23
      x-products:
      - Good Grants
      tags:
      - Grant reports
      parameters:
      - $ref: '#/components/parameters/Signature'
      security: []
      requestBody:
        $ref: '#/components/requestBodies/GrantReportWebhook'
      responses:
        '200':
          description: Return any 2xx status code to acknowledge receipt of the event.
components:
  parameters:
    Signature:
      name: Signature
      in: header
      required: true
      description: 'HMAC SHA256 signature of the request body. Generated using the webhook''s signing key and the raw JSON payload.


        Generate the same value in your endpoint and compare it with this header to validate the webhook payload.'
      schema:
        type: string
        example: a1b2c3d4e5f67890abcdef1234567890abcdef1234567890abcdef1234567890
  requestBodies:
    GrantReportWebhook:
      description: Payload delivered for grant report-related events.
      required: true
      content:
        application/json:
          schema:
            type: object
            allOf:
            - type: object
              properties:
                applicant:
                  type: object
                  description: Applicant information.
                application:
                  type: string
                  description: Application slug.
                application_fields:
                  type: array
                  description: Custom form field values for the grant report.
                status:
                  type: string
                  description: Grant report status.
                updated:
                  type: string
                  format: date-time
                  description: Timestamp when the grant report was last updated.
            - type: object
              properties:
                event:
                  type: string
                  description: Human-readable name of the event that triggered the webhook.
                  example: Grant report created
                timestamp:
                  type: string
                  format: date-time
                  description: ISO 8601 formatted datetime indicating when the event occurred.
                  example: '2020-01-01T00:00:00Z'
                trigger:
                  type: string
                  description: Machine-readable event key that fired the webhook.
                  example: grant_report_created
                source:
                  type: string
                  description: Origin of the change that triggered the event.
                  enum:
                  - ui
                  - api
                  default: ui
            example:
              applicant:
                slug: BwXxQawR
                link: https://api.au.cr4ce.com/user/BwXxQawR
                name: Jane Smith
                first_name: Jane
                last_name: Smith
              application: DeqEWpwO
              application_fields:
              - slug: IjKlMnOp
                link: https://api.au.cr4ce.com/field/IjKlMnOp
                label:
                  en_GB: <p>Outcomes achieved</p>
                title:
                  en_GB: Outcomes achieved
                value: Reached 120 beneficiaries across two regions.
              status: submitted
              updated: '2026-06-18T07:25:20Z'
              event: Grant report created
              timestamp: '2026-08-14T09:30:00Z'
              trigger: grant_report_created
              source: ui
  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.'