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

Get contract

Request

Retrieve a contract by its identifier

Path
contractIdinteger(int32)required

The system identifier for the contract

Example: 5348
No request payload

Responses

OK

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

The system identifier for the contract

Example: 5348
namestring or null

The user defined name of the contract

Example: "My contract"
documentobject or nullread-only

The contract document

typeobject or nullread-only

The type of the contract

ownerobject or null

The user assigned as the owner of the contract

expirystring or null(date-time)

The expiry date of the contract. The date and time uses the ISO-8601 format and will be in the Local timezone of the organization

Example: "2024-12-25T00:00:00"
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 contract

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 contract only available to members.

An indicator where the contract requires membership to access

Default false
Example: false
statusstring or null

The current status of the contract

Enum"Draft""Negotiating""Approval""Signing""Executed""Expired""Void"
Example: "Active"
teamAssignedobject or null

The team which this contract is assigned to

createdobject or nullread-only

The user who created the contract and when

Response
application/json
{
  "id": 5348,
  "name": "My contract",
  "document": {
    "id": 9456,
    "name": "Standard NDA.docx",
    "version": 3
  },
  "type": {
    "id": 1234,
    "name": "NDA"
  },
  "owner": {
    "email": "api.developer@lawvu.com",
    "firstName": "Api",
    "id": "f0f1e06e-3005-4093-af7f-1934d55617e1",
    "lastName": "Developer",
    "organizationId": 8134
  },
  "expiry": "2024-12-25T00:00:00",
  "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 contract

Request

Updates a contracts details

Path
contractIdinteger(int32)required

The system identifier for the contract

Example: 5348
Bodyapplication/merge-patch+json
namestring or null

The user defined name of the contract

ownerobject or null

The user assigned as the owner of the contract

expirystring or null(date-time)

The expiry date of the contract. The date and time uses the ISO-8601 format and will be in the Local timezone of the organization

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 contract

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 contract only available to members.

An indicator where the contract requires membership to access

Example: false
statusstring or null

The current status of the contract

Enum"Draft""Negotiating""Approval""Signing""Executed""Expired""Void"
teamAssignedobject or null

The team which this contract is assigned to

application/merge-patch+json
{
  "name": "string",
  "owner": {
    "id": "f0f1e06e-3005-4093-af7f-1934d55617e1"
  },
  "expiry": "2019-08-24T14:15:22Z",
  "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 contract

Request

Creates a contract based on the provided contract type.

Bodyapplication/json
typeobjectrequired

The type of the contract

type.​idinteger(int32)

The system identifier for the contract type

Example: 1234
namestring or null

The user defined name of the contract

Example: "My contract"
ownerobject or null

The user assigned as the owner of the contract

documentobject or null

The contract document.

This is only optional if the contract type has a wizard

expirystring or null(date-time)

The expiry date of the contract. The date and time uses the ISO-8601 format and will be in the Local timezone of the organization

Example: "2024-12-25T00:00:00"
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 contract

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 contract only available to members.

An indicator where the contract requires membership to access

Default false
Example: false
teamAssignedobject or null

The team which this contract is assigned to

application/json
{
  "type": {
    "id": 1234
  },
  "name": "My contract",
  "owner": {
    "id": "f0f1e06e-3005-4093-af7f-1934d55617e1"
  },
  "document": {
    "id": 9456
  },
  "expiry": "2024-12-25T00:00:00",
  "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 contract

Bodyapplication/json
idinteger(int32)read-only

The system identifier for the contract

Example: 5348
Response
application/json
{
  "id": 5348
}

Get contract file

Request

Retrieve information about a file on a contract

Path
contractIdinteger(int32)required

The system identifier for the contract

Example: 5348
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 contract types

Request

Retrieve a list of contract types

No request payload

Responses

OK

Bodyapplication/json
itemsArray of objects(ContractType)

The collection of items

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

Fields

Operations

Files

Operations

Matters

Operations