Companies
Create a company
Creates a company, UNCLASSIFIED unless a classification is given, in the authenticated team's Data Library and returns it. A name, UEI or CAGE code already used on the team answers conflict without creating anything.
posthttps://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.
Headers
The dated API version this request is written against. Responses keep that version's shape after newer versions ship.
One of:
Body
application/jsonShow 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.
Data classification of the company. Defaults to UNCLASSIFIED. Values above the token's classification ceiling are forbidden.
One of:
Legal name, unique within the team. At most 250 characters and not only whitespace.
How the company relates to the team.
One of:
Doing-business-as or trade name.
Website URL.
Free-text notes on the relationship with the team.
12-character SAM Unique Entity Identifier, unique within the team.
5-character CAGE code, unique within the team.
Response
201 · application/jsonA company in the team's Data Library.
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.
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 ["name"]
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.