Contracts
Create a contract
Creates a contract on the authenticated team and returns it. A contract number already used on the team answers conflict without creating anything.
posthttps://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.
Headers
The dated API version this request is written against. Responses keep that version's shape after newer versions ship.
One of:
Body
application/jsonContract title.
Data classification of the contract. Values above the token's classification ceiling are forbidden.
One of:
Team that will own the contract. Defaults to, and must be, the authenticated team.
Contract number.
Identifier of an agency, from GET /v1/agencies.
Identifier of an agency, from GET /v1/agencies.
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.
Base award amount in US dollars.
Amount obligated by the agency in US dollars.
Current contract value in US dollars.
Ceiling contract value in US dollars.
Response
201 · application/jsonA contract award the team tracks. Amounts are null when the token's user cannot read sensitive contract details.
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.
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.
The body is missing a required field, has one this endpoint doesn't accept, or a field has the wrong type. The message names the field.
Invalid request body: Missing key at ["title"]
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 record doesn't exist, belongs to another team, or is above the key's classification.
The requested resource was not found.
A record like this already exists. Use it instead of creating another.
The request conflicts with an existing resource.
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 write 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.