Skip to content

Get matters

GET
/matters

Get all matters the current user has access to in a workspace

Parameters

Query Parameters

from
integer

Starting index for pagination.

size
integer

Number of items to return.

archived
boolean

Filter matters by archived status.

userIds
string

Comma-separated user IDs to filter matters by participants.

Responses

200

List of matters

object
data
Array<object>
object
type
string
id
string
attributes
object
name

Name of the matter

string
description

Description of the matter

string
external-reference
object
id

External reference for the matter

string
source

Source of the external reference

string
tags

A list of label/value tags associated with the matter as an array of object .

Array<object>
object
label

The label of the tag (e.g., “priority”, “status”, “type”, “value”)

string
value

An optional value to the label of the tag (e.g., “high”, “open”, “ACC”, “$3,000”)

string
types

A list of matter type identifiers for this matter

Array<string>
jurisdictions
Array<string>
roles

A list of roles and users associated with the matter

If no OWNER is specified, the current user will be set as the matter owner

object
OWNER

Matter owner (limited to one user)

Array<string>
LEAD

Matter lead (limited to one user)

Array<string>
BUSINESS_1

Business Administrators of the matter

Array<string>
ADVOCATE_1

Advocates (or Barristers) of the matter

Array<string>
CONSULTANT_1

Consultants of the matter

Array<string>
LEGAL_1

Senior Lawyers of the matter

Array<string>
LEGAL_2

Junior Lawyers of the matter

Array<string>
LEGAL_3

Law Clerks or Paralegals of the matter

Array<string>
ADMINISTRATIVE_1

Senior Legal Assistants of the matter

Array<string>
ADMINISTRATIVE_2

Junior Legal Assistants of the matter

Array<string>
meta
object
total

Total number of matters

integer
100
showing

Total number of matters returned

integer
10
from

Current starting index for pagination

integer
0