/api/applications/{applicationId}/maverick-notes

GET /api/applications/{applicationId}/maverick-notes

Get Maverick application notes

Fetches notes from the Maverick boarding application associated with this application. The application must have been submitted to Maverick (has a maverickApplicationId).

Requires readApplications permission.

Required Parameters

x-account-id header string

Account ID for the request

applicationId path string

The unique ID of the application

Try it out

Output:

Responses

Description

Notes retrieved successfully

{
  "notes": [
    {
      "id": 0,
      "note": "string",
      "createdOn": "string",
      "creator": {
        "id": 0
      }
    }
  ],
  "_meta": {}
}

Description

Bad request - application not submitted to Maverick

{
  "error": "Application has not been submitted to Maverick"
}

Description

Unauthorized - user not authenticated

{
  "error": "Unauthorized"
}

Description

Forbidden - user lacks readApplications permission

{
  "error": "readApplications permission is required"
}

Description

Application not found

{
  "error": "Application not found"
}

Description

Internal server error - failed to fetch from Maverick

{
  "error": "Failed to fetch notes from Maverick"
}

References

#/components/parameters/xAccountIdHeader

OpenAPI
TypeScript

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

Or the swagger.yaml spec this documentation was generated from: /applications/[applicationId]/maverick-notes/swagger.yaml