Sign in

v1

latestOpenAPI 3.1.02026-07-263911,4691.1 MB
Companies

List company documents

Lists documents for a company based on applied filters, with support for sorting and pagination.

post/companies/v1/documents

Request body

company_idstring required

Required. The ID of the contractor company.

sort_field'DOCUMENT_SORT_FIELD_CREATED_AT' | 'DOCUMENT_SORT_FIELD_MODIFIED_AT' | 'DOCUMENT_SORT_FIELD_TITLE' | 'DOCUMENT_SORT_FIELD_FILE_NAME' | 'DOCUMENT_SORT_FIELD_TYPE' | 'DOCUMENT_SORT_FIELD_ISSUE_DATE' | 'DOCUMENT_SORT_FIELD_EXPIRATION_DATE' | 'DOCUMENT_SORT_FIELD_EXPIRY_STATUS'
sort_direction'SORT_DIRECTION_UNSPECIFIED' | 'SORT_DIRECTION_ASC' | 'SORT_DIRECTION_DESC'
page_sizeinteger

The number of results to return in a single request.

page_tokenstring

If present, will fetch the next page of results. This must be the value of next_page_token from the response.

Response

A successful response.

next_page_tokenstring

The next page token.

total_countinteger

The total number of documents that match the filter (in the current archived scope — active or archived, whichever was requested).

total_archived_countinteger

The total number of archived documents that match the same filters as this request, regardless of which archived scope was requested. Used by clients to populate a "Show archived (N)" badge without firing a second request, so the count always respects the user's active filters.