Opportunities
List opportunities
Returns the opportunities owned by the authenticated team, most recently updated first by default. Sub-teams' opportunities are not included. Opportunities above the token's classification ceiling are left out. For example, GET /v1/opportunities?limit=5 returns the five most recently updated.
gethttps://api.govdash.us/v1/opportunities
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.
Only opportunities in these capture phases. Repeat the parameter for more than one phase.
Only opportunities from this agency.
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
Opportunity identifier.
Object type, always opportunity.
Team that owns the opportunity.
When the opportunity was created.
When the opportunity was last updated.
Opportunity name.
Opportunity description.
Show child attributesHide child attributes
Phase identifier.
Phase name.
Solicitation number.
Identifier of the issuing agency.
Estimated contract value in US dollars.
Response due date.
When the notice was posted.
Link to the opportunity at its source.
Data classification of the opportunity.
One of:
Custom field values set on the opportunity. Present only with expand[]=custom_fields.
Show child attributesHide child attributes
Custom field identifier.
Custom field name.
Custom field type, which determines the shape of value.
One of:
Value set on the opportunity.
Capture team members. Present only with expand[]=members.
Show child attributesHide child attributes
Member assignment identifier.
Show child attributesHide child attributes
Member role identifier.
Member role name.
Team user assigned to the role.
Show child attributesHide child attributes
User identifier.
User first name.
User last name.
User email address.
Identifier of the key person assigned to the role.
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.