Documents
List documents
Returns the documents in the authenticated team's Data Library, most recently created first by default. Sub-teams' documents are not included. Documents the token's user cannot read, or above the token's classification ceiling, are left out. For example, GET /v1/documents?limit=5 returns the five most recently created documents.
gethttps://api.govdash.us/v1/documents
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 created_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 documents in this processing status: processing, ready, action_required, failed, unsupported, deleting.
One of:
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
Document identifier.
Object type, always document.
Document display name.
Data classification of the document.
One of:
Processing status: processing while GovDash reads the file, ready once it is usable, action_required when it needs a person to act in GovDash, failed, unsupported for files GovDash skips, or deleting.
One of:
When the document was created.
When the document was last updated.
User who uploaded the document.
Show child attributesHide child attributes
User identifier.
User first name.
User last name.
Signed link to download the file, valid for about an hour. null until the document is ready, and for documents linked from SharePoint and documents with no stored file. Present only with expand[]=download_url. Treat it as a secret.
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 record doesn't exist, belongs to another team, or is above the key's classification.
The requested resource was not found.
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.