List company documents

post

https://api.safetyculture.io/companies/v1/documents

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

Lists company documents for a company based on applied filters. You can filter by archived status, document type, approval status, and expiry status. Results support sorting and pagination.

Requirements

"Companies: Manage" permission or be a key contact for the company
An authenticated API request. See Authentication.

Body Params

company_id

string

required

Required. The ID of the contractor company.

filter

object

sort_field

string

enum

The field to sort by.

sort_direction

string

enum

Defaults to SORT_DIRECTION_UNSPECIFIED

The sort order.

Allowed:

page_size

int32

The number of results to return in a single request.

page_token

string

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

object

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Requirements

200A successful response.

defaultAn unexpected error response.