Skip to content

Get contract

Request

Retrieve a contract by its identifier

Path
contractIdinteger, (int32)required

The system identifier for the contract

Example:5348
const contractId = '5348';
const resp = await fetch(
  `https://api-sandbox.lawvu.com/v2/contracts/${contractId}`,
  {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 contract

Example:5348
namestring or null

The user defined name of the contract

Example:"My contract"
documentobject or null(FileReference)read-only

The contract document

typeobject or null(ContractTypeReference)read-only

The type of the contract

ownerobject or null(UserReference)

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": [
    { … },
    { … }
  ],
  "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 contract only available to members.

An indicator where the contract requires membership to access

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

The current status of the contract

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

The team which this contract is assigned to

createdobject or null(AuditableUserReference)read-only

The user who created the contract and when

Response
{
  "id": 5348,
  "name": "My contract",
  "document": {
    "id": 9456,
    "name": "Standard NDA.docx",
    "version": 3
  },
  "type": {
    "id": 1234,
    "name": "Contractor Agreement"
  },
  "owner": {
    "email": "api.developer@lawvu.com",
    "firstName": "Api",
    "id": "f0f1e06e-3005-4093-af7f-1934d55617e1",
    "lastName": "Developer",
    "organization": { … },
    "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"
  }
}