Get Matter List

Retrieves a list of matters based on the provided query string

GET https://my.mattero.com.au/public/api/v1/matters

Parameters

Name Location Type Description
search Query string:optional General search to filter matters by
sortBy Query string:optional The property name to sort by
sortDirection Query string:optional The direction to sort the results by, expected values are [Ascending | Descending]
pageIndex Query number:optional The index of the page to resolve, page numbers start at 0
pageSize Query number:optional The maximum number of results to include on a single page, must be between or equal to 1 and 250.
pageIndexForId Query number:optional The resolves the page index for the entity with the associated id
lawyerId Query string:optional The id of the lawyer associated with the matter.
clientId Query string:optional The id of the client associated with the matter.
referredById Query string:optional The id of the referrer associated with the matter.
practiceAreas Query string[]:optional The practice area id's to filter matters by.
status Query string:optional The status associated with the matter, expected values are [Open | Closed].
openDateStart Query Date:optional The start of the range that matters were open/created in.
openDateEnd Query Date:optional The end of the range that matters were open/created in.
modifiedDateStart Query DateTime:optional The start of the range that matters were modified in.
modifiedDateEnd Query DateTime:optional The end of the range that matters were modified in.
relatedMattersFilterUser Query string:optional Contact Id of roles associated to the filtered matters.
costingMethod Query string:optional The method used to calucate costs associated with the matter, expected values are [Time | Fixed | CostTemplate].
trustAccountIds Query string[]:optional The trust id's to filter matters by.
trustAccounts Query string[]:optional The trust name's to filter matters by.

Response

{
  "totalRecords": 1,
  "pageIndex": 0,
  "records": [
      {
        "id": "97-A",
        "number": "74",
        "title": "Test Matter",
        "lastActivity": "2022-07-19T15:19:56.669978+10:00",
        "dateOpen": "2022-05-16",
        "status": "Open",
        "practiceAreaName": "Administration",
        "stageName": "Pending",
        "client": {
            "id": "97-A",
            "name": "Microsoft"
        },
        "lawyer": {
            "id": "381-A",
            "name": "Green, James"
        },
        "customFields": {
            "brand": "Nissan",
            "color": "Red"
        },
        "userChangeTimestamp": "2022-07-19T15:19:56.669978+10:00",
        "estimatedFee": 20000.00,
        "referredBy": {
            "id": "88-A",
            "name": "Summers, Jeffrey"
        },
        "trustAccountId": "771-A",
        "trustAccount": "Berkleys Super Trust Fund",
        "matterTrustBalance": 15800.00
      }
  ]
}

MatterListResponse object

Name Type Description
totalRecords integer The total records found on the server that match the query parameters.
pageIndex integer The index of the page found.
records Matter[] An array of matters found in the request.

Matter object

Name Type Description
id string The unique identifier associated with a Matter.
number string The number associated with the matter.
title string The chosen title or name of the matter.
lastActivity DateTime The last date and time work was done against the matter.
dateOpen Date The date the matter was opened or created.
status string The status of the matter.
practiceAreaName string The name of the practice area associated with the matter.
stageName string The name of the practice area stage associated with the matter.
client EntityReference The client connected to the matter.
lawyer EntityReference The associated Lawyer working on the matter.
customFields Dictionary Custom fields associated with the matter.
userChangeTimestamp DateTime The last date and time a matter was updated directly from a user.
estimatedFee number The estimated fee for the matter.
referredBy EntityReference The associated contact that referred the client.
trustAccountId string The associated trust identifier.
trustAccount string The associated trust name.
roles ContactWithRole[] The roles for the contacts associated with the matter.
matterTrustBalance number The trust balance of the matter.

EntityReference object

Name Type Description
id string The unique identifier of the entity.
name string The name associated with the entity.

ContactWithRole object

Name Type Description
roleName string The name of the role.
fieldId string Associated identifier of the field.
contactId string Identifier of the contact.
contactName string Name for the contact.
mandatory boolean Specifices whether this contact role is mandatory.

Status Codes

Code Summary Description
200 Ok The request was successful with a body in the response.
400 Bad Request The request failed validation checks.
401 Unauthorized Failed authentication check.
403 Forbidden Failed authorization check.