v50

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-2148120293.6 KB
Documents

List Documents

Beta: This endpoint is in beta and may change. Retrieve a list of company-wide documents.

get/employer/documents

Query parameters

entity_idsstring[]

The entity IDs to specify which entities' data to access. Provide exactly one entity ID per request; a maximum of one is accepted.

[
  "550e8400-e29b-41d4-a716-446655440000"
]
limitinteger

Number of documents to return (defaults to all)

offsetinteger

Index to start from (defaults to 0)

individual_idsstring[]

Comma-delimited list of stable Finch uuids for each individual. If empty, defaults to all individuals

typesstring[]

Comma-delimited list of document types to filter on. If empty, defaults to all types

Headers

Finch-API-Versionstring date required

Header used to specify the version for a given API request. Current version is 2020-09-17.

Response

OK