List a client's documents

Required scope: documents:read.

Returns metadata for the documents in a client's eFolder, newest first.

Filters: q searches document titles and filenames (not document text), category matches one or more categories exactly, exhibit returns only exhibited (or only unexhibited) documents, and date_from and date_to filter by document date, inclusive.

A document is listed even when its file is missing. variants shows which file versions (original and OCR) are on record, not that they are currently downloadable. relations lists case units that cite the document as a decision source and appears only when the key also has clients:read.

GET /api/v2/clients/{id}/documents
Bearer token scope documents:read

Path parameters

· 1
id string required

Client ID.

Query parameters

· 7
limit integer · min: 1· max: 100· default: 50

Maximum number of items to return, from 1 to 100.

cursor string · min length: 1· max length: 4096

The page.next_cursor value from the previous page. Use it with the same filters; cursors expire after 24 hours.

q string · min length: 1· max length: 200

Case-insensitive partial match on document title or filename. Document text is not searched.

category array of string · min items: 1· max items: 100

Only return documents in these categories (exact match). Repeat the parameter for several values.

exhibit string · enum

Only return documents that are exhibited (true) or not exhibited (false).

values

  • true
  • false
date_from string · date · pattern

Only return documents dated on or after this date.

date_to string · date · pattern

Only return documents dated on or before this date.

Responses