v2

latestOpenAPI 3.0.12026-07-262352981007.0 KB

Matters

Get matters

Returns a list of matters. To return leads, set the isLead search option to true.

get/matters

Query parameters

Offsetinteger

Limitinteger

Searchstring

Example:Bob

Filter matters by specified search term. This field is wide reaching, it is used to search by clients, othersides, description and matter numbers.

MatterTypeIdstring

Example:009f778f-83df-454a-b344-768a862a7e55

Filter by matter type identifier.

ContactIdstring

Example:7fdbdd5b-0f5e-4095-af9e-ae5b055325c7

Filter by the contact identifier.

Statusstring[]

Filter by current status of the matter.

Possible values: Open, Pending, Closed, Deleted or Cancelled.

IsLeadboolean

Example:true

Boolean flag to return 'Leads'. This is false by default.

A Lead is a potential matter that has not yet been converted to a full matter. The data structure of a lead is similar to a matter, but with some small variances.

Typestring

Example:Leads

Type of matter to search for. This is set to Matters by default.

A Lead is a potential matter that has not yet been converted to a full matter. The data structure of a lead is similar to a matter, but with some small variances.

Possible values: "Matters", "Leads", "Matters,Leads".

UpdatedSinceinteger

Example:637873555398585000

Filter by matters updated since a specified time (.net ticks representation of the UTC datetime). Cannot be used in conjunction with LastUpdated.

This field will not be supported in future, please use LastUpdated instead.

LastUpdatedstring date-time

Example:2022-04-23T14:00:00Z

Filter by last updated date of matter. Cannot be used in conjunction with UpdatedSince.

Sortstring

Available fields: status, lastUpdated

Fieldsstring

Available fields: items, tags

Response

When request is successful. Returns a paged collection of 'Matter' objects.

idstring nullable

hrefstring nullable

relationstring nullable

methodstring nullable

offsetinteger nullable

limitinteger nullable

sizeinteger

Example response

{
  "value": [
    {
      "id": "b471682e-fa17-4e46-b7fe-9b2b8fdcb3c2",
      "externalSystemId": "EXT01",
      "versionId": "637771038395217729",
      "number": "FUS-124",
      "title": "AM-0323-0005 - Smith - Sale - Jones",
      "description": "This is a brief description for the matter",
      "status": "Open",
      "clientCode": "Client A",
      "openedDate": "2022-04-23T14:00:00Z",
      "closedDate": "2022-04-23T14:00:00Z",
      "leadOpenedDate": "2022-04-23T14:00:00Z",
      "leadClosedDate": "2022-04-23T14:00:00Z",
      "leadClosedReason": "No longer interested",
      "branchProviderId": "Smokeball",
      "tags": [
        {
          "id": "a15086f5-4da7-4271-8fea-b24d479ced2b",
          "type": "Staff",
          "color": "Light Blue"
        }
      ]
    }
  ]
}