GovDash
Menu

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

Authorizationstringheaderrequired

Your API key as a bearer token, for example Bearer gd_live_....

See Authentication for how to create a key.

Query parameters

cursorstringquery

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.

limitintegerquerydefault: 20

Number of objects to return, from 1 to 100. Defaults to 20.

sort_byenumquery

Sort field. Defaults to created_at.

One of:created_atupdated_at

sort_directionenumquery

Sort direction. Keep the same sort and filters when following a cursor.

One of:ascdesc

updated_sincestring (date-time)query

Only records updated at or after this time.

statusenumquery

Only documents in this processing status: processing, ready, action_required, failed, unsupported, deleting.

One of:processingreadyaction_requiredfailedunsupporteddeleting

Headers

govdash-versionenumheaderrequired

The dated API version this request is written against. Responses keep that version's shape after newer versions ship.

One of:2026-11-17

Response

200 · application/json

One page of a list.

edgesobject[]

The objects on this page, in list order.

Show child attributes
nodeobject
Show child attributes
idstring

Document identifier.

objectstring

Object type, always document.

namestring

Document display name.

classificationenum

Data classification of the document.

One of:UNCLASSIFIEDCUI

statusenum

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:processingreadyaction_requiredfailedunsupporteddeleting

created_atstring (date-time)

When the document was created.

updated_atstring (date-time)

When the document was last updated.

uploaded_byobject | null

User who uploaded the document.

Show child attributes
idstring

User identifier.

first_namestring | null

User first name.

last_namestring | null

User last name.

download_urlstring | null

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.

cursorstring

Pass as cursor to fetch the objects after this one.

pageInfoobject

Where this page sits in the list.

Show child attributes
hasNextPageboolean

Whether more objects follow this page. Pass endCursor as cursor to fetch them.

hasPreviousPageboolean

Whether this page was fetched after a cursor.

startCursorstring | null

The first edge's cursor. null when the page is empty.

endCursorstring | null

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.

400bad_request

A query parameter is malformed, such as a changed or reused cursor.

The cursor is invalid. Pass an `endCursor` or edge `cursor` unchanged.

401unauthorized

The API key is missing, mistyped, revoked, or expired.

The bearer token is missing or invalid.

403forbiddenclassification_out_of_scope

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.

404not_found

The record doesn't exist, belongs to another team, or is above the key's classification.

The requested resource was not found.

413payload_too_large

The request body is over 1 MB.

The request body must not exceed 1 MB.

422validation_failed

The request is well formed, but GovDash won't make this change. The message says why, when it can.

The request failed validation.

429rate_limited

You sent too many requests. Wait the seconds in the retry-after header, then retry.

This access token exceeded its read rate limit.

500internal_error

Something went wrong on GovDash's side, usually a bug. Retry with backoff, and check before retrying a create.

An unexpected error occurred.

503service_unavailable

GovDash is briefly unavailable and didn't run the request. Retry after retry-after.

The service is temporarily unavailable. Try again later.

get/v1/documents

List documents

Sends a real request to GovDash with the key you enter.

Query parameters
string

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.

integer

Number of objects to return, from 1 to 100. Defaults to 20.

enum

Sort field. Defaults to created_at.

enum

Sort direction. Keep the same sort and filters when following a cursor.

string (date-time)

Only records updated at or after this time.

enum

Only documents in this processing status: processing, ready, action_required, failed, unsupported, deleting.

Bearer

Kept in this tab only. Use a key you can revoke.

Request
Response
Send the request to see the response.