Get Documents
Beta. The Documents API is in beta and its contract may change.
Returns a list of Document objects. The response carries document metadata and the parse state of each document, but never the file itself and never the parsed values: read data_status to decide which documents are worth fetching in full, then call Get Document By Id for those.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Query Parameters
The ID of document records to fetch
"01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"
The ID of the employees whose documents to fetch
"01931edf-04b6-7391-8a5c-93ac4b395316,01931edf-04c8-7649-a470-d85f6161bd1a"
The third-party API ID of the matching object.
"3235005483341316245"
The document types to fetch. Multiple values should be comma separated without spaces.
"W4"
The parse states to fetch. Multiple values should be comma separated without spaces. Use AVAILABLE to fetch only documents whose parsed values are ready.
"AVAILABLE"
Whether to include the original data Bindbee fetched from the third-party to produce these models.
false
Whether to include custom fields in the response.
false
Number of results to return per page. Maximum size is 200.
1 <= x <= 200The pagination cursor value.
If provided, only objects synced by Bindbee after this date time will be returned. Format: DateTime (ISO 8601)
"2024-02-21T21:22:12.993Z"
Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces. You can also specify required fields in [] for each relation name.
"manager[first_name,last_name]"
Response
Successful Response