Companies
List companies
Returns the companies in the authenticated team's Data Library, ordered by name by default. Sub-teams' companies are not included. Companies above the token's classification ceiling are left out. For example, GET /v1/companies?limit=5 returns the first five companies.
gethttps://api.govdash.us/v1/companies
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 name.
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 companies whose legal name contains this text, ignoring case.
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
Company identifier.
Object type, always company.
Data classification of the company.
One of:
Legal name, unique within the team.
Doing-business-as or trade name.
How the company relates to the team.
One of:
Free-text notes on the relationship with the team.
Website URL.
SAM Unique Entity Identifier.
CAGE code.
DUNS number.
When the company was last updated.
Primary address. null when none is recorded.
Show child attributesHide child attributes
First line of the street address.
Second line of the street address.
City.
State or region name.
State or region code, such as VA.
Postal or ZIP code.
Country name.
Country code, such as US.
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.