Sign in

v1

latestOpenAPI 3.0.02026-08-063014193.1 MB
Matters

Return the data for all Matters

Outlines the parameters, optional and required, used when requesting the data for all Matters

get/matters.json

Query parameters

billableboolean

Filter Matter records to those which are billable.

client_idinteger

The unique identifier for a single Contact. The keyword null is not valid for this field. The list will be filtered to include only the Matter records with the matching property.

close_date[]'>DATE' | '>=DATE' | '=DATE' | '<=DATE' | '<DATE'

Filter Matter records by the close date. The date should be provided in the format YYYY-MM-DD.

e.g. ?close_date==2020-01-01, ?close_date=<=2021-12-31

You can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending [] to the parameter name.

e.g. ?close_date[]=>=2020-01-01&close_date[]=<=2021-12-31

Note that, when providing multiple values for this filter, only Matter records that meet all filter conditions will be returned.

created_sincestring date-time

Filter Matter records to those having the created_at field after a specific time. (Expects an ISO-8601 timestamp).

currency_idinteger

Filter Matter records to those of a specific currency.

custom_field_ids[]integer

Filter Matter's custom_field_values to only include values for the given custom field unique identifiers.

custom_field_values'=' | '<' | '>' | '<=' | '>='

Filter records to only those with the given custom field(s) set. The value is compared using the operator provided, or, if the value type only supports one operator, the supported operator is used. In the latter case, no check for operator is performed on the input string. The key for the custom field value filter is the custom_field.id. e.g. custom_field_values[12345] If an operator is used for a type that does not support it, an 400 Bad Request is returned.

Supported operators:

  • checkbox, contact, matter, picklist : =

e.g. ?custom_field_values[1]=42

  • currency, date, time, numeric : =, <, >, <=, >=

e.g. ?custom_field_values[1]=>=105.4

  • email, text_area, text_line, url : =

e.g. ?custom_field_values[1]=url_encoded

Multiple conditions for the same custom field:

If you want to use more than one operator to filter a custom field, you can do so by passing in an array of values. e.g. ?custom_field_values[1]=[<=50, >=45]

evergreen_retainer_filterboolean

Filter Matter records by whether evergreen trust auto-generation is enabled.

fieldsstring

The fields to be returned. See response samples for what fields are available. For more information see the fields section.

grant_idinteger

The unique identifier for a single Grant. Use the keyword null to match those without a Matter. The list will be filtered to include only the Matter records with the matching property.

group_idinteger

The unique identifier for a single Group. The keyword null is not valid for this field. The list will be filtered to include only the Matter records with the matching property.

ids[]integer

Filter Matter records to those having the specified unique identifiers.

limitinteger

A limit on the number of Matter records to be returned. Limit can range between 1 and 200. Default: 200.

notification_event_subscriber_user_idinteger

The unique identifier for a single NotificationEventSubscriber. Use the keyword null to match those without a Matter. The list will be filtered to include only the Matter records with the matching property.

open_date[]'>DATE' | '>=DATE' | '=DATE' | '<=DATE' | '<DATE'

Filter Matter records by the open date. The date should be provided in the format YYYY-MM-DD.

e.g. ?open_date==2020-01-01, ?open_date=<=2021-12-31

You can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending [] to the parameter name.

e.g. ?open_date[]=>=2020-01-01&open_date[]=<=2021-12-31

Note that, when providing multiple values for this filter, only Matter records that meet all filter conditions will be returned.

order'display_number(asc)' | 'display_number(desc)' | 'custom_number(asc)' | 'custom_number(desc)' | 'id(asc)' | 'id(desc)' | 'client.name(asc)' | 'client.name(desc)' | 'clients(asc)' | 'clients(desc)' | 'open_date(asc)' | 'open_date(desc)' | 'practice_area.name(asc)' | 'practice_area.name(desc)' | 'matter_stage.name(asc)' | 'matter_stage.name(desc)' | 'responsible_attorney.name(asc)' | 'responsible_attorney.name(desc)' | 'close_date(asc)' | 'close_date(desc)' | 'pending_date(asc)' | 'pending_date(desc)' | 'updated_at(asc)' | 'updated_at(desc)' | 'created_at(asc)' | 'created_at(desc)' | 'statute_of_limitations.due_at(asc)' | 'statute_of_limitations.due_at(desc)' | 'originating_attorney.name(asc)' | 'originating_attorney.name(desc)' | 'grants(asc)' | 'grants(desc)' | 'matter_stage_updated_at(asc)' | 'matter_stage_updated_at(desc)'

Orders the Matter records by the given field. Default: id(asc).

originating_attorney_idinteger

The unique identifier for a single User. Use the keyword null to match those without a Matter. The list will be filtered to include only the Matter records with the matching property.

page_tokenstring

A token specifying which page to return.

pending_date[]'>DATE' | '>=DATE' | '=DATE' | '<=DATE' | '<DATE'

Filter Matter records by the pending date. The date should be provided in the format YYYY-MM-DD.

e.g. ?pending_date==2020-01-01, ?pending_date=<=2021-12-31

You can provide more than one value to narrow the results of this filter. You can do so by passing several individual values and appending [] to the parameter name.

e.g. ?pending_date[]=>=2020-01-01&pending_date[]=<=2021-12-31

Note that, when providing multiple values for this filter, only Matter records that meet all filter conditions will be returned.

practice_area_idinteger

The unique identifier for a single PracticeArea. The keyword null is not valid for this field. The list will be filtered to include only the Matter records with the matching property.

querystring

Wildcard search for display_number, number or description matching a given string, as well as the first_name, last_name or name of the associated client.

responsible_attorney_idinteger

The unique identifier for a single User. Use the keyword null to match those without a Matter. The list will be filtered to include only the Matter records with the matching property.

responsible_staff_idinteger

The unique identifier for a single User. Use the keyword null to match those without a Matter. The list will be filtered to include only the Matter records with the matching property.

status'open' | 'closed' | 'pending'

Filter Matter records to those with a given status. It accepts comma-separated statuses, e.g. open,pending.

subscriber_user_idinteger

The unique identifier for a single NotificationEventSubscriber. Use the keyword null to match those without a Matter. The list will be filtered to include only the Matter records with the matching property.

updated_sincestring date-time

Filter Matter records to those having the updated_at field after a specific time. (Expects an ISO-8601 timestamp).

Headers

X-API-VERSIONstring

The API minor version. Default: latest version.

Response

Ok