Agencies
Create an agency
Creates an agency in the authenticated team's Data Library and returns it. A name already used on the team answers conflict without creating anything.
posthttps://api.govdash.us/v1/agencies
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/jsonAgency name, unique within the team. At most 250 characters and not only whitespace.
Data classification of the agency. Values above the token's classification ceiling are forbidden.
One of:
Team that will own the agency. Defaults to, and must be, the authenticated team.
Response
201 · application/jsonAn agency in the team's Data Library.
Agency identifier.
Object type, always agency.
Agency name, unique within the team.
Acronym of the government entity the agency is linked to, such as DOE.
Data classification of the agency.
One of:
When the agency was last updated.
Where a state or local agency sits. null for federal agencies and agencies not linked to a government entity.
Show child attributesHide child attributes
State code of a state or local agency, such as VA.
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.