API docs by Redocly

Bonterra API Endpoints (v1.0)

Download OpenAPI specification:

A Bonterra API Gateway that routes requests to internal Bonterra APIs

Grants

Grant related operations

List grant opportunities

Retrieves a list of grant opportunities

Authorizations:
authorizer-lambdaapi_key
query Parameters
fetchType
string
Enum: "templates" "reviewers"

Filter by opportunity type

limit
string
offset
integer

Responses

Response Schema: application/json
Array
id
required
string

Unique identifier for the opportunity

name
required
string

Name of the opportunity

description
string

Description of the opportunity

organizationId
required
string

ID of the organization offering the opportunity

amount
number

Grant amount

currency
string

Currency of the grant amount

startDate
string <date>

Start date for applications

endDate
string <date>

End date for applications

status
required
string
Enum: "draft" "open" "closed" "awarded" "completed"

Current status of the opportunity

type
string
Enum: "general" "project" "research" "emergency"

Type of opportunity

requirements
Array of strings

List of requirements

eligibility
Array of strings

List of eligibility criteria

Array of objects (GrantCriteria)

List of review criteria

Array of objects

List of assigned reviewers

createdAt
string <date-time>

When the opportunity was created

updatedAt
string <date-time>

When the opportunity was last updated

object

Additional opportunity metadata

Response samples

Content type
application/json
[
  • {
    }
]

Create grant opportunity

Creates a new grant opportunity

Authorizations:
authorizer-lambdaapi_key
Request Body schema: application/json
required
id
required
string

Unique identifier for the opportunity

name
required
string

Name of the opportunity

description
string

Description of the opportunity

organizationId
required
string

ID of the organization offering the opportunity

amount
number

Grant amount

currency
string

Currency of the grant amount

startDate
string <date>

Start date for applications

endDate
string <date>

End date for applications

status
required
string
Enum: "draft" "open" "closed" "awarded" "completed"

Current status of the opportunity

type
string
Enum: "general" "project" "research" "emergency"

Type of opportunity

requirements
Array of strings

List of requirements

eligibility
Array of strings

List of eligibility criteria

Array of objects (GrantCriteria)

List of review criteria

Array of objects

List of assigned reviewers

createdAt
string <date-time>

When the opportunity was created

updatedAt
string <date-time>

When the opportunity was last updated

object

Additional opportunity metadata

Responses

Response Schema: application/json
id
required
string

Unique identifier for the opportunity

name
required
string

Name of the opportunity

description
string

Description of the opportunity

organizationId
required
string

ID of the organization offering the opportunity

amount
number

Grant amount

currency
string

Currency of the grant amount

startDate
string <date>

Start date for applications

endDate
string <date>

End date for applications

status
required
string
Enum: "draft" "open" "closed" "awarded" "completed"

Current status of the opportunity

type
string
Enum: "general" "project" "research" "emergency"

Type of opportunity

requirements
Array of strings

List of requirements

eligibility
Array of strings

List of eligibility criteria

Array of objects (GrantCriteria)

List of review criteria

Array of objects

List of assigned reviewers

createdAt
string <date-time>

When the opportunity was created

updatedAt
string <date-time>

When the opportunity was last updated

object

Additional opportunity metadata

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "organizationId": "string",
  • "amount": 0,
  • "currency": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "status": "draft",
  • "type": "general",
  • "requirements": [
    ],
  • "eligibility": [
    ],
  • "criteria": [
    ],
  • "reviewers": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "organizationId": "string",
  • "amount": 0,
  • "currency": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "status": "draft",
  • "type": "general",
  • "requirements": [
    ],
  • "eligibility": [
    ],
  • "criteria": [
    ],
  • "reviewers": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "metadata": { }
}

Get grant opportunity

Retrieves a specific grant opportunity by ID

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string

ID of the opportunity

Responses

Response Schema: application/json
id
required
string

Unique identifier for the opportunity

name
required
string

Name of the opportunity

description
string

Description of the opportunity

organizationId
required
string

ID of the organization offering the opportunity

amount
number

Grant amount

currency
string

Currency of the grant amount

startDate
string <date>

Start date for applications

endDate
string <date>

End date for applications

status
required
string
Enum: "draft" "open" "closed" "awarded" "completed"

Current status of the opportunity

type
string
Enum: "general" "project" "research" "emergency"

Type of opportunity

requirements
Array of strings

List of requirements

eligibility
Array of strings

List of eligibility criteria

Array of objects (GrantCriteria)

List of review criteria

Array of objects

List of assigned reviewers

createdAt
string <date-time>

When the opportunity was created

updatedAt
string <date-time>

When the opportunity was last updated

object

Additional opportunity metadata

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "organizationId": "string",
  • "amount": 0,
  • "currency": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "status": "draft",
  • "type": "general",
  • "requirements": [
    ],
  • "eligibility": [
    ],
  • "criteria": [
    ],
  • "reviewers": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "metadata": { }
}

Update grant opportunity

Updates an existing grant opportunity

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string

ID of the opportunity

Request Body schema: application/json
required
id
required
string

Unique identifier for the opportunity

name
required
string

Name of the opportunity

description
string

Description of the opportunity

organizationId
required
string

ID of the organization offering the opportunity

amount
number

Grant amount

currency
string

Currency of the grant amount

startDate
string <date>

Start date for applications

endDate
string <date>

End date for applications

status
required
string
Enum: "draft" "open" "closed" "awarded" "completed"

Current status of the opportunity

type
string
Enum: "general" "project" "research" "emergency"

Type of opportunity

requirements
Array of strings

List of requirements

eligibility
Array of strings

List of eligibility criteria

Array of objects (GrantCriteria)

List of review criteria

Array of objects

List of assigned reviewers

createdAt
string <date-time>

When the opportunity was created

updatedAt
string <date-time>

When the opportunity was last updated

object

Additional opportunity metadata

Responses

Response Schema: application/json
id
required
string

Unique identifier for the opportunity

name
required
string

Name of the opportunity

description
string

Description of the opportunity

organizationId
required
string

ID of the organization offering the opportunity

amount
number

Grant amount

currency
string

Currency of the grant amount

startDate
string <date>

Start date for applications

endDate
string <date>

End date for applications

status
required
string
Enum: "draft" "open" "closed" "awarded" "completed"

Current status of the opportunity

type
string
Enum: "general" "project" "research" "emergency"

Type of opportunity

requirements
Array of strings

List of requirements

eligibility
Array of strings

List of eligibility criteria

Array of objects (GrantCriteria)

List of review criteria

Array of objects

List of assigned reviewers

createdAt
string <date-time>

When the opportunity was created

updatedAt
string <date-time>

When the opportunity was last updated

object

Additional opportunity metadata

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "organizationId": "string",
  • "amount": 0,
  • "currency": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "status": "draft",
  • "type": "general",
  • "requirements": [
    ],
  • "eligibility": [
    ],
  • "criteria": [
    ],
  • "reviewers": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "metadata": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "organizationId": "string",
  • "amount": 0,
  • "currency": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "status": "draft",
  • "type": "general",
  • "requirements": [
    ],
  • "eligibility": [
    ],
  • "criteria": [
    ],
  • "reviewers": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "metadata": { }
}

Clone grant opportunity

Creates a copy of an existing grant opportunity

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string

ID of the opportunity to clone

Request Body schema: application/json
optional
name
string

Name for the cloned opportunity

status
string
Default: "draft"
Enum: "draft" "open"

Initial status for the cloned opportunity

Responses

Response Schema: application/json
id
required
string

Unique identifier for the opportunity

name
required
string

Name of the opportunity

description
string

Description of the opportunity

organizationId
required
string

ID of the organization offering the opportunity

amount
number

Grant amount

currency
string

Currency of the grant amount

startDate
string <date>

Start date for applications

endDate
string <date>

End date for applications

status
required
string
Enum: "draft" "open" "closed" "awarded" "completed"

Current status of the opportunity

type
string
Enum: "general" "project" "research" "emergency"

Type of opportunity

requirements
Array of strings

List of requirements

eligibility
Array of strings

List of eligibility criteria

Array of objects (GrantCriteria)

List of review criteria

Array of objects

List of assigned reviewers

createdAt
string <date-time>

When the opportunity was created

updatedAt
string <date-time>

When the opportunity was last updated

object

Additional opportunity metadata

Request samples

Content type
application/json
{
  • "name": "string",
  • "status": "draft"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "organizationId": "string",
  • "amount": 0,
  • "currency": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "status": "draft",
  • "type": "general",
  • "requirements": [
    ],
  • "eligibility": [
    ],
  • "criteria": [
    ],
  • "reviewers": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "metadata": { }
}

Get opportunity criteria

Retrieves review criteria for a grant opportunity

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string

ID of the opportunity

Responses

Response Schema: application/json
Array
id
required
string

Unique identifier for the criteria

name
required
string

Name of the criteria

description
string

Description of the criteria

weight
required
number [ 0 .. 100 ]

Weight of the criteria in the overall score

type
string
Enum: "numeric" "text" "boolean" "scale"

Type of criteria

Array of objects

Available options for the criteria (if applicable)

minScore
number

Minimum score for this criteria

maxScore
number

Maximum score for this criteria

createdAt
string <date-time>

When the criteria was created

updatedAt
string <date-time>

When the criteria was last updated

object

Additional criteria metadata

Response samples

Content type
application/json
[
  • {
    }
]

Extract criteria

Extract criteria

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string

ID of the opportunity

Request Body schema: application/json
required
opportunity_id
string

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "opportunity_id": "string"
}

Response samples

Content type
application/json
{ }

Update opportunity criteria

Updates review criteria for a grant opportunity

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string

ID of the opportunity

Request Body schema: application/json
required
Array
id
required
string

Unique identifier for the criteria

name
required
string

Name of the criteria

description
string

Description of the criteria

weight
required
number [ 0 .. 100 ]

Weight of the criteria in the overall score

type
string
Enum: "numeric" "text" "boolean" "scale"

Type of criteria

Array of objects

Available options for the criteria (if applicable)

minScore
number

Minimum score for this criteria

maxScore
number

Maximum score for this criteria

createdAt
string <date-time>

When the criteria was created

updatedAt
string <date-time>

When the criteria was last updated

object

Additional criteria metadata

Responses

Response Schema: application/json
Array
id
required
string

Unique identifier for the criteria

name
required
string

Name of the criteria

description
string

Description of the criteria

weight
required
number [ 0 .. 100 ]

Weight of the criteria in the overall score

type
string
Enum: "numeric" "text" "boolean" "scale"

Type of criteria

Array of objects

Available options for the criteria (if applicable)

minScore
number

Minimum score for this criteria

maxScore
number

Maximum score for this criteria

createdAt
string <date-time>

When the criteria was created

updatedAt
string <date-time>

When the criteria was last updated

object

Additional criteria metadata

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get opportunity reviewers

Retrieves reviewers for a grant opportunity

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string

ID of the opportunity

Responses

Response Schema: application/json
Array
userId
string

ID of the reviewer

role
string

Role of the reviewer

Response samples

Content type
application/json
[
  • {
    }
]

Add opportunity reviewers

Adds reviewers to a grant opportunity

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string

ID of the opportunity

Request Body schema: application/json
required
Array
userId
required
string

ID of the reviewer

role
required
string

Role of the reviewer

Responses

Response Schema: application/json
Array
userId
string

ID of the reviewer

role
string

Role of the reviewer

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Create grant review

Creates a new grant review

Authorizations:
authorizer-lambdaapi_key
Request Body schema: application/json
required
opportunityId
required
string

ID of the opportunity being reviewed

required
Array of objects
overallNotes
string

Overall review notes

Responses

Response Schema: application/json
id
string

ID of the created review

opportunityId
string

ID of the reviewed opportunity

reviewerId
string

ID of the reviewer

Array of objects
overallNotes
string

Overall review notes

createdAt
string <date-time>

When the review was created

Request samples

Content type
application/json
{
  • "opportunityId": "string",
  • "criteriaScores": [
    ],
  • "overallNotes": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "opportunityId": "string",
  • "reviewerId": "string",
  • "criteriaScores": [
    ],
  • "overallNotes": "string",
  • "createdAt": "2019-08-24T14:15:22Z"
}

List grant users

Retrieve a list of users associated with grants

Authorizations:
authorizer-lambdaapi_key
query Parameters
page
integer
Default: 1

Page number for pagination

limit
integer
Default: 10

Number of items per page

Responses

Response Schema: application/json
required
Array of objects (GrantUser)

List of grant users

required
object

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "pagination": {
    }
}

Get grant user by ID

Retrieve a specific grant user by ID

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>

ID of the grant user

Responses

Response Schema: application/json
id
required
string <uuid>

Unique identifier for the grant user

email
required
string <email>

Email address of the grant user

firstName
required
string

First name of the grant user

lastName
required
string

Last name of the grant user

role
required
string
Enum: "ADMIN" "REVIEWER" "APPLICANT"

Role of the grant user

createdAt
required
string <date-time>

Timestamp when the grant user was created

updatedAt
required
string <date-time>

Timestamp when the grant user was last updated

organizationId
string <uuid>

ID of the organization the grant user belongs to

status
string
Enum: "ACTIVE" "INACTIVE" "PENDING"

Current status of the grant user

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "role": "ADMIN",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  • "status": "ACTIVE"
}

Get application review

Get application review details

Authorizations:
authorizer-lambdaapi_key
query Parameters
opportunity
required
string
isReviewer
string

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Get application

Get application details

Authorizations:
authorizer-lambdaapi_key
query Parameters
opportunity
string

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Create application

Create a new application

Authorizations:
authorizer-lambdaapi_key

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Get application by ID

Get application details by ID

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Update application

Update application details

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Get application reviews

Get reviews for an application

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Get application review by ID

Get a specific review for an application

Authorizations:
authorizer-lambdaapi_key
path Parameters
reviewId
required
string
id
required
string

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Get criteria

Get criteria

Authorizations:
authorizer-lambdaapi_key

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Create criteria

Create new criteria

Authorizations:
authorizer-lambdaapi_key

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Get invite

Get invite

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>
query Parameters
organization_id
string <uuid>

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Post invite

Post invite

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>
Request Body schema: application/json
required
Array of objects (GrantInvite)

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "invites": [
    ]
}

Response samples

Content type
application/json
{ }

Get matches

Get matches

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Get clients

Get all clients

Authorizations:
authorizer-lambdaapi_key

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Create a new client

Create a new client

Authorizations:
authorizer-lambdaapi_key
Request Body schema: application/json
required
name
string

The name of the client

description
string

The description of the client

clientId
string

The client ID

Responses

Response Schema: application/json
object

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "clientId": "string"
}

Response samples

Content type
application/json
{ }

Create a new client association

Create a new client association

Authorizations:
authorizer-lambdaapi_key

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Update a client association

Update a client association

Authorizations:
authorizer-lambdaapi_key
path Parameters
userId
required
string

ID of the user to update

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Create a new concurrent API

Create a new concurrent API

Authorizations:
authorizer-lambdaapi_key

Responses

Response Schema: application/json
object

Response samples

Content type
application/json
{ }

Applications

Get attachments for a grant application

Get attachments for a grant application

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>

ID of the grant application

Responses

Response Schema: application/json
Array of objects

The attachments for the grant application

Response samples

Content type
application/json
{
  • "attachments": [
    ]
}

Save attachment metadata for grant application

Save metadata for an uploaded attachment file. This endpoint should be called after successfully uploading a file using the upload endpoint.

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>

ID of the grant application

Request Body schema: application/json
required
s3Key
required
string

The S3 key returned from the file upload endpoint

fileName
required
string

Original name of the uploaded file

fieldId
required
integer

ID of the form field this attachment belongs to

Responses

Response Schema: application/json
id
string <uuid>

ID of the created attachment record

field_id
integer

ID of the form field this attachment belongs to

fileName
string

Original name of the uploaded file

s3_key
string

The S3 key of the uploaded file

Request samples

Content type
application/json
{
  • "s3Key": "string",
  • "fileName": "string",
  • "fieldId": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "field_id": 0,
  • "fileName": "string",
  • "s3_key": "string"
}

Upload attachment file for grant application

Upload an attachment file for a grant application. This endpoint handles the direct file upload to S3.

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>

ID of the grant application

Request Body schema: multipart/form-data
required
file
string <binary>

The attachment file to upload

Responses

Response Schema: application/json
s3Key
string

The S3 key of the uploaded file

Response samples

Content type
application/json
{
  • "s3Key": "string"
}

Get pre-signed URL for attachment files

Get a pre-signed URL to access either:

  1. A grant application attachment (requires application access)
  2. An organization's payee check image (requires Bonterra Staff access)
Authorizations:
authorizer-lambdaapi_key
path Parameters
id
string <uuid>

ID of the grant application (required for application attachments)

attachmentId
string <uuid>

ID of the attachment (required for application attachments)

Responses

Response Schema: application/json
signedUrl
string

The pre-signed URL to access the file

Response samples

Content type
application/json
{
  • "signedUrl": "string"
}

Delete an attachment file

Delete a grant application attachment

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>

ID of the grant application (required for application attachments)

attachmentId
required
string <uuid>

ID of the attachment (required for application attachments)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": "string",
  • "details": { },
  • "timestamp": "2019-08-24T14:15:22Z"
}

Attachments

Get attachments for a grant application

Get attachments for a grant application

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>

ID of the grant application

Responses

Response Schema: application/json
Array of objects

The attachments for the grant application

Response samples

Content type
application/json
{
  • "attachments": [
    ]
}

Save attachment metadata for grant application

Save metadata for an uploaded attachment file. This endpoint should be called after successfully uploading a file using the upload endpoint.

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>

ID of the grant application

Request Body schema: application/json
required
s3Key
required
string

The S3 key returned from the file upload endpoint

fileName
required
string

Original name of the uploaded file

fieldId
required
integer

ID of the form field this attachment belongs to

Responses

Response Schema: application/json
id
string <uuid>

ID of the created attachment record

field_id
integer

ID of the form field this attachment belongs to

fileName
string

Original name of the uploaded file

s3_key
string

The S3 key of the uploaded file

Request samples

Content type
application/json
{
  • "s3Key": "string",
  • "fileName": "string",
  • "fieldId": 0
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "field_id": 0,
  • "fileName": "string",
  • "s3_key": "string"
}

Upload attachment file for grant application

Upload an attachment file for a grant application. This endpoint handles the direct file upload to S3.

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>

ID of the grant application

Request Body schema: multipart/form-data
required
file
string <binary>

The attachment file to upload

Responses

Response Schema: application/json
s3Key
string

The S3 key of the uploaded file

Response samples

Content type
application/json
{
  • "s3Key": "string"
}

Get pre-signed URL for attachment files

Get a pre-signed URL to access either:

  1. A grant application attachment (requires application access)
  2. An organization's payee check image (requires Bonterra Staff access)
Authorizations:
authorizer-lambdaapi_key
path Parameters
id
string <uuid>

ID of the grant application (required for application attachments)

attachmentId
string <uuid>

ID of the attachment (required for application attachments)

Responses

Response Schema: application/json
signedUrl
string

The pre-signed URL to access the file

Response samples

Content type
application/json
{
  • "signedUrl": "string"
}

Delete an attachment file

Delete a grant application attachment

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>

ID of the grant application (required for application attachments)

attachmentId
required
string <uuid>

ID of the attachment (required for application attachments)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": "string",
  • "details": { },
  • "timestamp": "2019-08-24T14:15:22Z"
}

Organizations

Get pre-signed URL for attachment files

Get a pre-signed URL to access either:

  1. A grant application attachment (requires application access)
  2. An organization's payee check image (requires Bonterra Staff access)
Authorizations:
authorizer-lambdaapi_key
path Parameters
id
string <uuid>

ID of the grant application (required for application attachments)

attachmentId
string <uuid>

ID of the attachment (required for application attachments)

Responses

Response Schema: application/json
signedUrl
string

The pre-signed URL to access the file

Response samples

Content type
application/json
{
  • "signedUrl": "string"
}

Delete an attachment file

Delete a grant application attachment

Authorizations:
authorizer-lambdaapi_key
path Parameters
id
required
string <uuid>

ID of the grant application (required for application attachments)

attachmentId
required
string <uuid>

ID of the attachment (required for application attachments)

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "code": "string",
  • "details": { },
  • "timestamp": "2019-08-24T14:15:22Z"
}