SavedGrant

List all saved grants

get/v1/saved_grants

Request

  • Base URL: https://api.instrumentl.com
  • URL: https://api.instrumentl.com/v1/saved_grants
  • Auth: HTTP basic

Query parameters

page_sizeinteger

Maximum number of results to return per page

cursorstring

Opaque cursor to fetch more results; must have been returned by a prior query to this endpoint.

project_idstring api_id nullable

Only show grants saved to the given project

grant_idstring api_id nullable

Only show saves of the given grant

funder_idstring api_id nullable

Only show saves of grants from the given funder

statuses[]string[]

Only show saves of grants with the given statuses

award_yearinteger nullable

Only show saves of grants within the given award fiscal year. Saved grants are included if the start or end date of the award is within the provided fiscal year.

submission_goal_gtestring date

Show only saved grants with a current submission goal on or after the given date.

submission_goal_ltestring date

Show only saved grants with a current submission goal on or before the given date.

submission_goal_submittedboolean

When false, show only saved grants with a current submission goal that has no submitted date; when true, only those with one that does. Combined with the date filters, the same goal must match all of them.

Response

saved_grants found

Changes

No recorded changes to this operation across all 1 revision of this API.