Skip to main content
GET
Returns a page of the matters you can read, in the order the Matters list in Wordsmith shows them. A matter groups the tasks of one piece of legal work, such as a deal or a dispute. List the tasks filed in a matter with matter_id on List tasks. Matters must be enabled for your organisation. Without them, this endpoint answers 404. query keeps the matters whose own text matches it, and the matters holding a task you can read whose text matches. A matter kept only for its tasks comes back with matched_through_tasks set to true. Without query, matched_through_tasks is null. archived is true for an archived matter, which the list returns only with include_archived. A matter’s status is not returned.

Authentication

Requires an API key, or an OAuth token with matters:read.

Query parameters

string
Only matters whose text, or whose tasks’ text, contains this.
boolean
default:"false"
Include archived matters.
string
The cursor from the previous page. Leave it out for the first page.
integer
default:"20"
Matters per page, from 1 to 100. Keep it, and the filters, the same for every page of a walk.

Response

Returns 200 with a page of matters. cursor is null on the last page. task_counts counts the matter’s tasks you can read: done of total. It is null when the counts could not be computed for this response. On a list with query, null counts also mean the search matched matters by their own text only, so matters kept only for their tasks may be missing; try again later. status_update.author is null when the author’s account no longer exists. Times are ISO 8601 in UTC. Pages are read from the live list, not a snapshot. A matter updated during a walk can move, so a walk can skip or repeat it.

Errors