Skip to content

Search users

Request

Returns a list of users based on the filter criteria

Query
filter.searchstring

Search text (applies to: name & email address)

filter.permissionstring

Options:

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

Only users that are active or invited

filter.primaryorganisationidinteger, (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

const resp = await fetch(
  `https://api-sandbox.lawvu.com/account-apis/v1/users`,
  {method: 'GET'}
);

const data = await resp.text();
console.log(data);

Responses

OK

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": "9b854542-be9c-4095-bfad-6d9bb79e3c07",
    "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
  }
]