LawVu Account (1.0)

Download OpenAPI specification:Download

Apis for account related resources (authentication, profiles, organisation details etc)

Organisations

Get departments

Returns an array of departments for the given organisation

Request

path Parameters

organisationId

required

integer <int32>

Format - int32. The organisation to get departments

Responses

200

Success

get/v1/organisations/{organisationId}/departments

Response samples

200

null

Get organisations

Returns an array of organisations the current user is linked to

Responses

200

Success

get/v1/organisations

Response samples

200

null

Get regions

Returns an array of regions for the given organisation

Request

path Parameters

organisationId

required

integer <int32>

Format - int32. The organisation to get regions

Responses

200

Success

get/v1/organisations/{organisationId}/regions

Response samples

200

null

Get clients

Returns an array of clients the current user is linked to

Responses

200

Success

get/v1/organisations/clients

Response samples

200

[
  {
    "id": 1,
    "name": "My organisation",
    "type": "ServiceProvider",
    "permissions": []
  },
  {
    "id": 4,
    "name": "Client 1 organisation",
    "type": "Customer",
    "permissions": []
  }
]

Get financial settings

Returns the organisation financial settings the current user is linked to

Responses

200

Success

get/v1/organisations/financialsettings

Response samples

200

{
  "id": 1,
  "yearEndDay": 31,
  "yearEndMonth": 3,
  "accountsPayableContacts": null,
  "currency": "NZD",
  "currencyName": "New Zealand Dollar",
  "currencySymbol": "$"
}

Emails

Get an email thread

Search for an email thread by the identifier.

Request

query Parameters

client	string or null The email client (Gmail, Outlook)
threadIdentifier	string or null The Id of the thread

Responses

200

Success

get/v1/emails/threads

Response samples

200

null

Save email thread

Creates / Updates an email thread, and child email messages.

Request

Request Body schema:
application/json-patch+json

The email thread to create

threadIdentifier required	string
track	boolean
client required	string Options: Outlook Gmail Enum: "Outlook" "Gmail"
matterId	integer or null <int32>
fileId	integer or null <int32>
contractId	integer or null <int32>

Responses

200

Success

post/v1/emails/threads

Request samples

Payload

{"threadIdentifier": "string",
"track": true,
"client": "Outlook",
"matterId": 0,
"fileId": 0,
"contractId": 0
}

Response samples

200

null

Create email draft

Creates a draft email in LawVu

Request

Request Body schema:
application/json-patch+json

Draft details

sourceId	string or null
authorEmailAddress	string or null Deprecated
expectedFromAddress	string or null
matterId	integer <int32>
mode	string Options: Message File Enum: "Message" "File"
	Array of objects or null (MessageDraftRecipient)

Responses

200

Success

post/v1/emails/drafts

Request samples

Payload

{"sourceId": "string",
"authorEmailAddress": "string",
"expectedFromAddress": "string",
"matterId": 0,
"mode": "Message",
"recipients": [{"userId": "string"
}
]
}

Response samples

200

null

Delete email draft

Deletes a draft email

Request

path Parameters

draftId

required

integer <int32>

Format - int32. The id of the draft email

Responses

200

Success

delete/v1/emails/drafts/{draftId}

Update email draft

Updates a message draft

Request

path Parameters

draftId

required

integer <int32>

Format - int32. The id of the draft email

Request Body schema:
application/json-patch+json

The message draft update

matterId	integer <int32>
mode	string Options: Message File Enum: "Message" "File"
	Array of objects or null (MessageDraftRecipient)

Responses

200

Success

put/v1/emails/drafts/{draftId}

Request samples

Payload

{"matterId": 0,
"mode": "Message",
"recipients": [{"userId": "string"
}
]
}

Get email threads

Gets paged email threads ordered by last modified date

Request

query Parameters

client	string or null The email client (Gmail, Outlook)
pageSize	integer <int32> Default: 25 Format - int32. The number of threads to return Default: 25
cursor	integer or null <int32> Format - int32. The Id of the thread to skip to

Responses

200

Success

get/v1/emails/threads/page

Response samples

200

null

Auth

Get token

Get a token to access the rest of the LawVu APIs

Request

Request Body schema: application/x-www-form-urlencoded

grant_type	string
client_id	string
client_secret	string
username	string
password	string
refresh_token	string
code	string
redirect_uri	string
SSOId	string
SAMLResponse	string
region_hint	string Enum: "Default" "APAC" "US" "EU" "CAN" "USGOV"

Responses

200

Success

post/v1/auth/token

Request samples

Payload

application/x-www-form-urlencoded

grant_type=string&client_id=string&client_secret=string&username=string&password=string&refresh_token=string&code=string&redirect_uri=string&SSOId=string&SAMLResponse=string&region_hint=Default

Response samples

200

null

Users

Search users

Returns a list of users based on the filter criteria

Request

query Parameters

filter.search	string or null Search text (applies to: name & email address)
filter.permission	string or null Options: CreateMatters ContractCreator Enum: "CreateMatters" "ContractCreator"
filter.activeandinvitedusersonly	boolean Only users that are active or invited
filter.primaryorganisationid	integer or null <int32> Format - int32.
filter.activeusersonly	boolean Only users that are active
filter.uselitequery	boolean Use a lite query When enabled the response will return only partial information about the user: UserId, FirstName, LastName, UserFullName and OrganisationName

Responses

200

Success

get/v1/users

Response samples

200

[
  {
    "id": "925ecaea-7d88-4b19-bcee-fd1c8164ddc2",
    "userName": null,
    "firstName": "Example",
    "lastName": "User",
    "organisationName": null,
    "organisationPictureCacheId": null,
    "directPhone": null,
    "mobilePhone": null,
    "email": "exampleuser@noemail.com",
    "hasPicture": false,
    "pictureCacheId": 0,
    "invitationSentUtc": null,
    "userFullName": "Example User",
    "userInitials": "EU",
    "isRemoved": false,
    "isDisabled": false,
    "hourlyRate": null,
    "liveMattersCount": 277
  }
]

Get user profile

Returns the profile of a specific user.

Request

path Parameters

id

required

string or null

User Id (e.g. e1bf0987-8844-49ab-a6b6-10562b58e230)

Responses

200

Success

get/v1/users/{id}/profile

Response samples

200

{
  "id": "123-456-789",
  "firstName": "Joey",
  "lastName": "Tribiani",
  "email": "emailaddress@gmail.com",
  "mobilePhone": "987654321",
  "directPhone": "24680",
  "jobTitle": "Worker",
  "departmentId": 4,
  "specialityIds": [
    1,
    2,
    3
  ],
  "biography": "Biography",
  "hourlyRate": 9.99,
  "linkedInUrl": "url",
  "organisationId": 5,
  "organisationName": "The Workplace",
  "organisationType": "Customer",
  "role": "Administrator",
  "departmentName": "Department",
  "hasPicture": true,
  "pictureCacheId": 78,
  "invitationSentUtc": "2024-02-22T07:42:35.0000000+00:00",
  "status": "LockedOut"
}

Teams

Get teams

Request

query Parameters

allowAssigment

boolean

Default: false

Only return teams that allow work assignment

Default: False

Responses

200

Success

get/v1/teams

Response samples

200

[
  {
    "id": 1,
    "name": "Team 1"
  },
  {
    "id": 2,
    "name": "Team 2"
  }
]

Features

Get feature

Retrieves a feature by feature code based on the current authorised users organisation context

Request

path Parameters

featureCode

required

string or null

The code of the feature

Responses

200

Success

get/v1/features/{featureCode}

Response samples

200

null

WebhookSubscriptions

Create a subscription

Create a webhook subscription to receive notifications on events occuring in LawVu

Request

Request Body schema:
application/json-patch+json

Details of the webhook subscription to create

topics required	Array of strings (WebhookTopicArray) Items Enum: "matter.created" "matter.updated" "contract.created" "contract.updated" "matter.status.updated" "contract.status.updated" "matter.file.created" "contract.file.created" "matter.file.updated" "contract.file.updated" "contract.document.updated" "matter.statusmessage.created" "contract.statusmessage.created" "matter.tag.created" "contract.keydate.created" "contract.keydate.updated"
subscriptionUrl required	string <uri> <= 2048 characters The publicly accessible URL of the endpoint which will be notified
clientState	string or null <= 128 characters A custom string which will be included with each notification to help identify the notification came from LawVu

Responses

201

The ID of the created subscription

post/v1/webhooks/subscriptions

Request samples

Payload

{"topics": ["matter.created",
"matter.updated",
"matter.status.updated"
],
"subscriptionUrl": "https://myapplication.com/incomingwebhooks",
"clientState": "supersecretstring"
}

Response samples

201

null

Get all subscriptions

Retrieve all existing webhook subscriptions

Responses

200

Success

get/v1/webhooks/subscriptions

Response samples

200

[
  {
    "id": 1,
    "topics": [
      "matter.created",
      "matter.updated",
      "matter.status.updated"
    ],
    "subscriptionUrl": "https://myapplication.com/incomingwebhooks",
    "clientState": "supersecretstring",
    "status": "failed",
    "createdDateUtc": "2022-10-11T11:54:04.0000000+00:00",
    "createdBy": "461fffa2-950f-4961-b313-09fef67d419c",
    "modifiedDateUtc": "2022-12-19T11:54:04.0000000+00:00",
    "modifiedBy": "461fffa2-950f-4961-b313-09fef67d419c"
  },
  {
    "id": 2,
    "topics": [
      "contract.created"
    ],
    "subscriptionUrl": "https://myapplication.com/incomingwebhooks/example",
    "clientState": "my client state",
    "status": "active",
    "createdDateUtc": "2022-10-15T11:54:04.0000000+00:00",
    "createdBy": "461fffa2-950f-4961-b313-09fef67d419c",
    "modifiedDateUtc": "2022-12-21T11:54:04.0000000+00:00",
    "modifiedBy": "461fffa2-950f-4961-b313-09fef67d419c"
  }
]

Get a subscription

Retrieve an existing webhook subscription

Request

path Parameters

id

required

integer <int32>

Format - int32. The ID of the subscription

Responses

200

Success

get/v1/webhooks/subscriptions/{id}

Response samples

200

{
  "id": 1,
  "topics": [
    "matter.created",
    "matter.updated",
    "matter.status.updated"
  ],
  "subscriptionUrl": "https://myapplication.com/incomingwebhooks",
  "clientState": "my client state",
  "status": "active",
  "createdDateUtc": "2022-10-11T11:54:04.0000000+00:00",
  "createdBy": "461fffa2-950f-4961-b313-09fef67d419c",
  "modifiedDateUtc": "2022-12-19T11:54:04.0000000+00:00",
  "modifiedBy": "461fffa2-950f-4961-b313-09fef67d419c"
}

Delete a subscription

Deleting a webhook subscription will stop notifications for that subscription

Request

path Parameters

id

required

integer <int32>

Format - int32. The ID of the subscription

Responses

204

Success

delete/v1/webhooks/subscriptions/{id}

Recents

Get recent items

Request

query Parameters

take	integer <int32> Default: 5 Format - int32. The maximum number of recent items to return Default: 5

Responses

200

Success

get/v1/my/recents

Response samples

200

[
  {
    "type": "file",
    "id": 414236,
    "title": "NDA contract for John Doe - V2.pdf",
    "description": "LV1762-00001 - Advice on Matter",
    "lastActivityDate": "2023-11-07T01:51:41.0000000+00:00",
    "matterId": 164476,
    "contractId": null,
    "contentType": "application/pdf",
    "documentId": "LV1762-0000004.1",
    "ownerId": "",
    "managerId": "",
    "contractStatus": null,
    "matterCategoryName": null
  },
  {
    "type": "matter",
    "id": 164476,
    "title": "Advice on Matter",
    "description": "LV1762-00001",
    "lastActivityDate": "2023-11-07T01:51:39.0000000+00:00",
    "matterId": null,
    "contractId": null,
    "contentType": "",
    "documentId": null,
    "ownerId": "GUID",
    "managerId": null,
    "contractStatus": null,
    "matterCategoryName": "Advice"
  },
  {
    "type": "contract",
    "id": 78173,
    "title": "NDA for Contract",
    "description": "Contract ID: 78173",
    "lastActivityDate": "2023-11-06T09:16:25.0000000+00:00",
    "matterId": null,
    "contractId": null,
    "contentType": "",
    "documentId": null,
    "ownerId": "GUID",
    "managerId": "",
    "contractStatus": "Negotiating",
    "matterCategoryName": null
  }
]

LawVu Account (1.0)

Organisations

Get departments

path Parameters

Get organisations

Get regions

path Parameters

Get clients

Get financial settings

Emails

Get an email thread

query Parameters

Save email thread

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Create email draft

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Delete email draft

path Parameters

Update email draft

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Get email threads

query Parameters

Auth

Get token

Request Body schema: application/x-www-form-urlencoded

Users

Search users

query Parameters

Get user profile

path Parameters

Teams

Get teams

query Parameters

Features

Get feature

path Parameters

WebhookSubscriptions

Create a subscription

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Get all subscriptions

Get a subscription

path Parameters

Delete a subscription

path Parameters

Recents

Get recent items

query Parameters

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json