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

Get fields

Request

Retrieve a list of available fields

Query
$skipinteger(int32)

Specifies the number of items to skip

Default 0
$topinteger(int32)

Specifies the maximum number of items to return

Default 25
No request payload

Responses

OK

Bodyapplication/json
itemsArray of objects(Field)

The collection of items

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

Get field options

Request

Retrieve a list of available options for a field.

Supported field types: MultiOption, Option

Path
fieldIdstringrequired

The API name for the field

Example: my_field
Query
$skipinteger(int32)

Specifies the number of items to skip

Default 0
$topinteger(int32)

Specifies the maximum number of items to return

Default 25
No request payload

Responses

OK

Bodyapplication/json
itemsArray of objects(FieldOption)

The collection of items

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

Add an option to a field

Request

Add a an option for a field.

Supported field types: MultiOption, Option

Path
fieldIdstringrequired

The API name for the field

Example: my_field
Bodyapplication/json
labelstringrequired

The user defined label of the field option

Example: "Option A"
propertiesobject or null

Additional properties based on the type of field option. See examples for more details.

application/json
{
  "label": "Option 1"
}

Responses

Created

Headers
Locationstring

Location to retrieve the created resource

Bodyapplication/json
valuestring

The system generated value for the field option

Example: "option_1"
Response
application/json
{
  "value": "option_1"
}

Files

Operations

Matters

Operations