Contracts
List contracts
Returns the contracts owned by the authenticated team, most recently updated first by default. Sub-teams' contracts are not included. Contracts above the token's classification ceiling, and contracts that are not yet verified, are left out. For example, GET /v1/contracts?limit=5 returns the five most recently updated.
gethttps://api.govdash.us/v1/contracts
Authorization
Your API key as a bearer token, for example Bearer gd_live_....
See Authentication for how to create a key.
Query parameters
Return the objects after this cursor: the previous page's pageInfo.endCursor, or any edge's cursor. Omit it to start at the first page.
Number of objects to return, from 1 to 100. Defaults to 20.
Sort field. Defaults to updated_at.
One of:
Sort direction. Keep the same sort and filters when following a cursor.
One of:
Only records updated at or after this time.
Headers
The dated API version this request is written against. Responses keep that version's shape after newer versions ship.
One of:
Response
200 · application/jsonOne page of a list.
The objects on this page, in list order.
Show child attributesHide child attributes
Show child attributesHide child attributes
Contract identifier.
Object type, always contract.
Team that owns the contract.
When the contract was last updated.
Contract title.
Canonical contract identifier, derived from the contract, task order and subcontract numbers the contract has.
Processing status of the contract.
One of:
Data classification of the contract.
One of:
Identifier of the awarding agency.
Identifier of the funding agency.
Identifier of the company that holds the contract.
Start of the period of performance.
End of the currently exercised period of performance.
End of the full period of performance, including all options.
Primary past performance, included in detail and write responses. Null when none is recorded. Use expand[]=past_performance.writeups on retrieval for write-up summaries.
Show child attributesHide child attributes
Show child attributesHide child attributes
When the write-up was last updated.
Base award amount in US dollars.
Amount obligated by the agency in US dollars.
Current contract value in US dollars: the base and all exercised options.
Ceiling contract value in US dollars: the value including all options.
Pass as cursor to fetch the objects after this one.
Where this page sits in the list.
Show child attributesHide child attributes
Whether more objects follow this page. Pass endCursor as cursor to fetch them.
Whether this page was fetched after a cursor.
The first edge's cursor. null when the page is empty.
The last edge's cursor. null when the page is empty.
Errors
Every error returns a stable error.code to branch on and an error.message that says what went wrong, like the examples below. See Errors for how to handle each one.
A query parameter is malformed, such as a changed or reused cursor.
The cursor is invalid. Pass an `endCursor` or edge `cursor` unchanged.
The key's service account doesn't have the permission this needs, or your team's access has ended.
You do not have permission to perform this action.
The request is well formed, but GovDash won't make this change. The message says why, when it can.
The request failed validation.
You sent too many requests. Wait the seconds in the retry-after header, then retry.
This access token exceeded its read rate limit.
Something went wrong on GovDash's side, usually a bug. Retry with backoff, and check before retrying a create.
An unexpected error occurred.
GovDash is briefly unavailable and didn't run the request. Retry after retry-after.
The service is temporarily unavailable. Try again later.