Library

List documents

Lists a matter's Discovery documents, newest first by sent or document date (undated documents last). Attachments are left out unless you ask for them. Documents the caller isn't allowed to see never appear.

GET/api/v1/matters/{matter_id}/documents

Authorization

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your Sentinel API key. See Authentication.

Path parameters

matter_idstringpathrequired≤ 64 characters

The matter's ID, from List matters.

Query parameters

limitintegerquerydefault: 501–200

Documents per page.

cursorstringquery

The next_cursor from the previous page.

custodianstringquery1–200 characters

Only documents whose custodian name contains this text (case-insensitive).

sent_afterstring (date)query

Only documents sent or dated on or after this day (YYYY-MM-DD, UTC). Undated documents are filtered by their upload date.

sent_beforestring (date)query

Only documents sent or dated on or before this day, inclusive (YYYY-MM-DD, UTC). Undated documents are filtered by their upload date.

include_attachmentsbooleanquerydefault: false

Include email attachments as their own rows.

Response

200 · A page of documents.

dataDocument[]required

Fields

idstringrequired

matter_idstringrequired

file_namestringrequired

document_typestring | nullrequired

For example email, attachment or file.

mime_typestring | nullrequired

file_sizeinteger | nullrequired

Bytes.

page_countinteger | nullrequired

custodianstring | nullrequired

parent_document_idstring | nullrequired

For an attachment, the email it belongs to.

bates_numberstring | nullrequired

emailobject | nullrequired

Email envelope, when the document is an email.

Fields

subjectstring | null

senderstring | null

recipientsstring[] | null

sent_atstring (date-time) | null

document_datestring (date-time) | nullrequired

uploaded_atstring (date-time) | nullrequired

paginationPaginationrequired

Fields

limitintegerrequired

has_morebooleanrequired

next_cursorstring | nullrequired

Pass as cursor to get the next page. Null on the last page.

Errors

Status	Type	When
`400`	`invalid_request`	Invalid parameters.
`401`	`authentication_required`	Missing, invalid, revoked or expired API key.
`403`	`permission_denied`	The key's role can't use the API.
`404`	`not_found`	No such matter, or the caller can't access it.
`429`	`rate_limited`	More than 120 requests in a minute from one key. Retry after the `Retry-After` header's seconds.

See Errors and Rate limits.