Skip to content

LawVu API

The next generation of the LawVu API.

Download OpenAPI description
lawvuapi.openapi.json
lawvuapi.openapi.yaml
Overview
URL

https://developer.lawvu.com

LawVu Developer Support Team

developer@lawvu.com

Terms of Service

Languages
Servers
Sandbox API

https://api-sandbox.lawvu.com/

Production API

https://api.lawvu.com/

Contracts

Operations

Fields

Operations

Files

Operations

Matters

Operations

Get matter

Request

Retrieve a matter by its identifier

Path
matterIdinteger(int32)required

The system identifier for the matter

Example: 1056
No request payload

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 nullread-only

The type of the matter

ownerobject or null

The user assigned as the owner of the matter

managerobject or null

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":[{"label":"Option A","value":"option_a"},{"label":"Option D","value":"option_d"}],"my_user_field":{"email":"api.developer@lawvu.com","firstName":"Api","id":"f0f1e06e-3005-4093-af7f-1934d55617e1","lastName":"Developer","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

The current status of the matter

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

The team which this matter is assigned to

createdobject or nullread-only

The user who created the matter and when

Response
application/json
{
  "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",
    "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"
  }
}

Update matter

Request

Updates a matters details

Path
matterIdinteger(int32)required

The system identifier for the matter

Example: 1056
Bodyapplication/merge-patch+json
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.

ownerobject or null

The user assigned as the owner of the matter

managerobject or null

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

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":{"value":"option_1"},"my_multioption_field":[{"value":"option_a"},{"value":"option_d"}],"my_user_field":{"id":"f0f1e06e-3005-4093-af7f-1934d55617e1"}}
restrictedboolean or null

Is the matter only available to members

An indicator where the matter requires membership to access

Example: false
statusstring or null

The current status of the matter

Enum"Draft""Scoping""Review""Active""TasksLate""MilestonesLate""TasksAndMilestonesLate""AwaitingManagerAcceptance""AwaitingOwnerAcceptance""Complete"
teamAssignedobject or null

The team which this matter is assigned to

application/merge-patch+json
{
  "name": "string",
  "owner": {
    "id": "f0f1e06e-3005-4093-af7f-1934d55617e1"
  },
  "manager": {
    "intakeQueue": { … },
    "user": { … }
  },
  "externalId": "string",
  "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": "Draft",
  "teamAssigned": {
    "id": 469
  }
}

Responses

No Content

Response
No content

Create matter

Request

Creates a matter based on the provided matter type.

Bodyapplication/json
typeobjectrequired

The type of the matter

type.​idinteger(int32)

The system identifier for the matter type

Example: 7492
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"
ownerobject or null

The user assigned as the owner of the matter

managerobject or null

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.

During creation a default manager may be assigned when none is provided depending on the matter type configuration. More information can be found here.

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":{"value":"option_1"},"my_multioption_field":[{"value":"option_a"},{"value":"option_d"}],"my_user_field":{"id":"f0f1e06e-3005-4093-af7f-1934d55617e1"}}
restrictedboolean or null

Is the matter only available to members

An indicator where the matter requires membership to access

Default false
Example: false
teamAssignedobject or null

The team which this matter is assigned to

application/json
{
  "type": {
    "id": 7492
  },
  "name": "My matter",
  "owner": {
    "id": "f0f1e06e-3005-4093-af7f-1934d55617e1"
  },
  "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,
  "teamAssigned": {
    "id": 469
  }
}

Responses

Created

Headers
Locationstring

Location to retrieve the created matter

Bodyapplication/json
idinteger(int32)
Example: 1056
Response
application/json
{
  "id": 1056
}

Get matter file

Request

Retrieve information about a file on a matter

Path
matterIdinteger(int32)required

The system identifier for the matter

Example: 1056
fileIdinteger(int32)required

The system identifier for the file

Example: 9456
No request payload

Responses

OK

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

The system identifier for the file

Example: 9456
namestring or null

The user defined name of the file including extension

Example: "document.txt"
displayIdstring or null

A system generated identifier of the file. Also known as "Document ID"

Example: "LV0001-0000123.1"
folderobject or null

The folder where the file is located

Folder is null when the file is located at the root of the resource

contentTypestring or null

The content type of the file binary

Example: "text/plain"
resourceobject or null

The resouce where the file is located

restrictedboolean or null

Is the file access restricted

Default false
Example: false
sizeinteger or null(int64)

The size of the file binary in bytes

Example: 18139
versioninteger or null(int32)

The version number of the file

Example: 3
createdobject or nullread-only

The user who created the file and when

modifiedobject or nullread-only

The username who modified the file and when

Response
application/json
{
  "id": 9456,
  "name": "document.txt",
  "displayId": "LV0001-0000123.1",
  "folder": {
    "id": 786,
    "name": "Drafts"
  },
  "contentType": "text/plain",
  "resource": {
    "id": 78914,
    "type": "Contract"
  },
  "restricted": false,
  "size": 18139,
  "version": 3,
  "created": {
    "dateUtc": "2024-12-25T00:00:00Z",
    "user": { … },
    "userName": "api.developer@lawvu.com"
  },
  "modified": {
    "dateUtc": "2024-12-25T00:00:00Z",
    "userName": "api.developer@lawvu.com"
  }
}

Get matter types

Request

Retrieve a list of matter types

No request payload

Responses

OK

Bodyapplication/json
itemsArray of objects(MatterType)

The collection of items

Response
application/json
{
  "items": [
    { … }
  ]
}