LawVu Account (1.0)

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

Download OpenAPI description
LawVu Account.openapi.json
LawVu Account.openapi.yaml
Languages
Servers
Sandbox API
https://api-sandbox.lawvu.com/account-apis/
Production API
https://api.lawvu.com/account-apis/

Organisations

Operations

Emails

Operations

Auth

Operations

Users

Operations

Search users

Request

Returns a list of users based on the filter criteria

Query
filter.searchstring or null

Search text (applies to: name & email address)

filter.permissionstring or null

Options:

  • CreateMatters
  • ContractCreator
Enum"CreateMatters""ContractCreator"
filter.activeandinvitedusersonlyboolean

Only users that are active or invited

filter.primaryorganisationidinteger or null(int32)

Format - int32.

filter.activeusersonlyboolean

Only users that are active

filter.uselitequeryboolean

Use a lite query When enabled the response will return only partial information about the user: UserId, FirstName, LastName, UserFullName and OrganisationName

No request payload

Responses

Success

Body
Array [
idstring or null
userNamestring or null
firstNamestring or null
lastNamestring or null
organisationNamestring or null
organisationPictureCacheIdinteger or null(int32)
directPhonestring or null
mobilePhonestring or null
emailstring or null
hasPictureboolean
pictureCacheIdinteger(int32)
invitationSentUtcstring or null(date-time)
userFullNamestring or null
userInitialsstring or null
isRemovedboolean
isDisabledboolean
hourlyRatenumber or null(double)
liveMattersCountinteger(int32)
]
Response
[
  {
    "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

Request

Returns the profile of a specific user.

Path
idstring or nullrequired

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

No request payload

Responses

Success

Body
idstring or null
firstNamestring or null
lastNamestring or null
emailstring or null
mobilePhonestring or null
directPhonestring or null
jobTitlestring or null
departmentIdinteger or null(int32)
specialityIdsArray of integers or null(int32)
biographystring or null
hourlyRatenumber or null(double)
linkedInUrlstring or null
organisationIdinteger(int32)
organisationNamestring or null
organisationTypestring

Options:

  • ServiceProvider
  • Customer
Enum"ServiceProvider""Customer"
rolestring

Options:

  • Administrator
  • InhouseLegal
  • Contributor
  • Standard
  • External
  • MatterManager
Enum"Administrator""InhouseLegal""Contributor""Standard""External""MatterManager"
departmentNamestring or null
hasPictureboolean
pictureCacheIdinteger(int32)
invitationSentUtcstring or null(date-time)
statusstring

Options:

  • Disabled
  • Listed
  • Active
  • Invited
  • LockedOut
Enum"Disabled""Listed""Active""Invited""LockedOut"
Response
{
  "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

Operations

Features

Operations

WebhookSubscriptions

Operations

Recents

Operations