# Search users

Returns a list of users based on the filter criteria

Endpoint: GET /v1/users
Version: 1.0

## Query parameters:

  - `filter.search` (string)
    Search text (applies to: name & email address)

  - `filter.permission` (string)
    Options:CreateMattersContractCreator
    Enum: "CreateMatters", "ContractCreator"

  - `filter.activeandinvitedusersonly` (boolean)
    Only users that are active or invited

  - `filter.primaryorganisationid` (integer)

  - `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

## Response 200 fields (text/plain):

  - `id` (string,null)

  - `userName` (string,null)

  - `firstName` (string,null)

  - `lastName` (string,null)

  - `organisationName` (string,null)

  - `organisationPictureCacheId` (integer,null)

  - `directPhone` (string,null)

  - `mobilePhone` (string,null)

  - `email` (string,null)

  - `hasPicture` (boolean)

  - `pictureCacheId` (integer)

  - `invitationSentUtc` (string,null)

  - `userFullName` (string,null)

  - `userInitials` (string,null)

  - `isRemoved` (boolean)

  - `isDisabled` (boolean)

  - `hourlyRate` (number,null)

  - `liveMattersCount` (integer)