Who is this article for?
👤Developers who leverage the LawVu API to build business integrations. For more information on the LawVu API, please visit our Developer Centre.
API V2 Beta
Field API names are used by V2 endpoints, which are still in beta.
For details on how to join the beta and for V1 deprecation timelines, see our API V2 Endpoints FAQ.
What is a field API name?
The field API name is used to uniquely identify a LawVu field when creating, reading or updating matters or contracts using an integration.
Example 1: Creating a matter
Example 2: Updating a contract’s field values
How can I find out the correct API name for a field?
Option 1: In LawVu settings
If you have the Organization Admin role, follow these steps:
Go to Settings / Field Management / Field Library to see a list of all matter and contract fields.
Find and select the field you're working with:
Click the curly brace { } icon in the top-right corner:
From the menu, click 'Copy API name':
The API name will be copied to your clipboard for easy use in your integration.
Option 2. Using the LawVu API
You can also programmatically retrieve the full field library via API to identify API names for each field.
To do this, you may use the Get fields API endpoint.
Can I change a field’s API name?
Yes. This is useful if the meaning of a field changes, or in situations where you need to align field names between development and UAT or Production environments, ensuring your integration works the same everywhere.
As a user with the “Organization Admin” role, go to Settings / Field Management / Field Library to see a list of all matter and contract fields.
Click the field you’re working with.
Click the curly brace icon at the top-right corner:
Click 'Edit API name' from the context menu:
Adjust the API name as required before saving: