Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Please use your Access Token

Headers

Finch-API-Version
string<date>
default:2020-09-17
required

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

Pattern: ([12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01]))

Query Parameters

entity_ids
string<uuid>[]

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

Required array length: 1 element
Example:
limit
integer

Number of documents to return (defaults to all)

offset
integer

Index to start from (defaults to 0)

individual_ids
string[]

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

types
enum<string>[]

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

Available options:
w4_2020,
w4_2005

Response

OK

paging
Paging · object
required
documents
object[]
required