What can I use the Good Grants API for?
The Good Grants API can be used for a number of purposes to help you manage your program. Below you'll find a list of options available to you. To learn more, see our comprehensive API documents.
Attachment
List attachments | Returns a list of attachments. |
Get attachment | Returns an attachment by its token. The response consists of all attachment fields. Files include a download link. |
Update attachment | Update an existing attachment. |
Delete attachment | Delete an existing attachment. |
Category
List categories | Returns a list of categories. |
Get category | Returns a category by its slug. The response consists of all category fields. Images include a download link. |
Create category | Create a new category. |
Update category | Update an existing category. |
Delete category | Delete an existing category. |
Upload category file | Upload a category image. |
Application
List applications | Returns a list of applications. |
Get application | Returns an application by its slug. The response consists of all application fields including files, attachments, and contributors. Files include a download link. |
Create application | Create a new application. |
Update application | Update an existing application. |
Delete application | Delete an existing application. |
Upload application file | Upload a file to an application file field. |
Upload application attachment | Upload an attachment to an application by its tab. |
Tag application | Add tags to an existing application. |
Untag application | Remove tags from an existing application. |
Field
List fields | Returns a list of fields. |
File
Get file info | Returns files information by its token. |
Funds
List funds | Returns a list of funds. |
Get fund | Returns a fund by its slug. |
Create fund | Create a new fund. |
Update fund | Update currency, budget or name/description of an existing fund. |
Delete fund | Delete an existing fund. |
List allocations | Returns a list of allocations. |
Get allocation | Return an allocation by its slug. |
Create allocation | Create an allocation using an existing application and fund. |
Update allocation | Update an existing allocation. |
Delete allocation | Delete an existing allocation. |
Season
List seasons | Returns a list of seasons. |
Get season | Returns a season by its slug. The response consists of all season fields. |
User
List users | Returns a list of users. |
Get user by email | Returns a user by its email. The response consists of all user fields including files. Files include a download link. |
Get user by slug | Returns a user by its slug. The response consists of all user fields including files. Files include a download link. |
Create user | Create a new user. |
Update user |
Update an existing user. |
Delete user |
Delete an existing user |
Upload user file |
Upload a file to a user file field. |
Get auth token |
Returns an auth token for a given user. The response consists of a token that allows the user to log into the app using SSO. |