Skip to content

LawVu Fields (1.0)

Apis for field resources

Download OpenAPI description
LawVu Fields.openapi.json
LawVu Fields.openapi.yaml
Languages
Servers
Sandbox API

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

Production API

https://api.lawvu.com/field-apis/

Fields

Operations

Get fields

Request

Query
filtering.fieldstring

Field to filter by (optional)

filtering.operatorstring

Operator used for filtering (optional)

Enum"eq""neq""lt""lte""gt""gte""startswith""endswith""contains""doesnotcon"
filtering.valuestring

Value to filter by (optional)

sorting.directionstring

Set the sorting direction

Enum"asc""desc"
sorting.fieldstring

Set the sorting fields

takeinteger(int32)

The maximum number of fields to return

Default: 50

Default 50
skipinteger(int32)

Default: 0

Default 0
searchstring
Default ""
fieldCategorystring

Options:

  • Custom
  • Lawvu
Enum"Custom""Lawvu"
No request payload

Responses

Success

Body
dataArray of objects or null(FieldListItem)

Represents a single page of processed data.

totalinteger(int32)

The total number of records available.

Response
No response example

Get field schema

Request

Path
fieldIdinteger(int32)required

e.g. 1234

No request payload

Responses

Success

Body
idinteger(int32)
organisationIdinteger or null(int32)
isAlwaysRequiredboolean
entityColumnNamestring or null
namestring or null
descriptionstring or null
categorystring or null
lawvuTypestring

Options:

  • ShortText
  • LongText
  • Slider
  • Currency
  • Decimal
  • Checkbox
  • Date
  • Dropdown
  • Department
  • Region
  • BillingMethod
  • BillingIntention
  • Priority
  • ContractEntity
  • ConflictCheck
  • CheckboxList
  • RadioGroup
  • SectionHeader
  • ContractOwner
  • Restricted
  • List
  • Lookup
  • InvoiceRecipient
  • User
Enum"ShortText""LongText""Slider""Currency""Decimal""Checkbox""Date""Dropdown""Department""Region"
webMergeFieldNamestring or null
contractCountinteger(int32)
matterCountinteger(int32)
parametersobject(FieldDetailParameters)
Response
No response example

LookupFields

Operations