Skip to content

Get matter

Request

Retrieve a matter by its identifier

Path
matterIdinteger, (int32)required

The system identifier for the matter

Example:1056
const matterId = '1056';
const resp = await fetch(
  `https://api-sandbox.lawvu.com/v2/matters/${matterId}`,
  {method: 'GET'}
);

const data = await resp.text();
console.log(data);

Responses

OK

Bodyapplication/json
idinteger or null, (int32)read-only

The system identifier for the matter

Example:1056
namestring or null

The user defined name of the matter

When simple ticketing is enabled for the organization then the Name is going to be optional and will default to simple ticketing rules, otherwise is required.

Example:"My matter"
displayIdstring or nullread-only

A system generated identifier of the matter. Also known as "LawVu ID" or "Matter Number"

Example:"LV0001-0001"
typeobject or null(MatterTypeReference)read-only

The type of the matter

ownerobject or null(UserReference)

The user assigned as the owner of the matter

managerobject or null(MatterManager)

The user managing the matter or the intake queue for an organization.

Only one of User and IntakeQueue can be assigned to a matter at a time.

externalIdstring or null

A unique user defined identifier that can be used to reference another system

Example:"external-01"
fieldsobject or null

The collection of fields associated with the matter

Example:
{
  "my_text_field": "my text value",
  "my_decimal_field": 78659.84,
  "my_boolean_field": true,
  "my_date_field": "2025-05-06",
  "my_option_field": {
    "label": "Option 1",
    "value": "option_1"
  },
  "my_multioption_field": [
    { … },
    { … }
  ],
  "my_user_field": {
    "email": "api.developer@lawvu.com",
    "firstName": "Api",
    "id": "f0f1e06e-3005-4093-af7f-1934d55617e1",
    "lastName": "Developer",
    "organization": { … },
    "organizationId": 8134
  }
}
restrictedboolean or null

Is the matter only available to members

An indicator where the matter requires membership to access

Default:false
Example:false
statusstring or null(MatterStatus)

The current status of the matter

Enum:"Draft""Scoping""Review""Active""TasksLate""MilestonesLate""TasksAndMilestonesLate""AwaitingManagerAcceptance""AwaitingOwnerAcceptance""Complete"
Example:"Active"
teamAssignedobject or null(TeamReference)

The team which this matter is assigned to

createdobject or null(AuditableUserReference)read-only

The user who created the matter and when

Response
{
  "id": 1056,
  "name": "My matter",
  "displayId": "LV0001-0001",
  "type": {
    "id": 7492,
    "name": "NDA"
  },
  "owner": {
    "email": "api.developer@lawvu.com",
    "firstName": "Api",
    "id": "f0f1e06e-3005-4093-af7f-1934d55617e1",
    "lastName": "Developer",
    "organization": { … },
    "organizationId": 8134
  },
  "manager": {
    "intakeQueue": { … },
    "user": { … }
  },
  "externalId": "external-01",
  "fields": {
    "my_text_field": "my text value",
    "my_decimal_field": 78659.84,
    "my_boolean_field": true,
    "my_date_field": "2025-05-06",
    "my_option_field": { … },
    "my_multioption_field": [ … ],
    "my_user_field": { … }
  },
  "restricted": false,
  "status": "Active",
  "teamAssigned": {
    "id": 469,
    "name": "Legal - Commercial"
  },
  "created": {
    "dateUtc": "2024-12-25T00:00:00Z",
    "user": { … },
    "userName": "api.developer@lawvu.com"
  }
}