Api Home > User > GetUserList

GET api/V3/User/GetUserList?userFilter={userFilter}&filterByAnalyst={filterByAnalyst}&groupsOnly={groupsOnly}&maxNumberOfResults={maxNumberOfResults}&fetchAll={fetchAll} Returns a list of users with minimal properties.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userFilter

A text string used to filter users.

string

Default value is

filterByAnalyst

Boolean used to filter by Analysts only, Default = false

boolean

Default value is False

groupsOnly

Boolean used to filter by Groups only, Default = false

boolean

Default value is False

maxNumberOfResults

integer

Default value is 10

fetchAll

boolean

Default value is False

Body Parameters

None.

Response Information

Resource Description

Collection of ConsoleUserMinimal
NameDescriptionTypeAdditional information
Id

globally unique identifier

None.

Name

string

None.

Email

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Id": "c3084f66-c20b-4369-9803-06daa96cbc10",
    "Name": "sample string 2",
    "Email": "sample string 3"
  },
  {
    "Id": "c3084f66-c20b-4369-9803-06daa96cbc10",
    "Name": "sample string 2",
    "Email": "sample string 3"
  }
]

application/xml, text/xml

Sample:
<ArrayOfConsoleUserMinimal xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cireson.ServiceManager.Library">
  <ConsoleUserMinimal>
    <Email>sample string 3</Email>
    <Id>c3084f66-c20b-4369-9803-06daa96cbc10</Id>
    <Name>sample string 2</Name>
  </ConsoleUserMinimal>
  <ConsoleUserMinimal>
    <Email>sample string 3</Email>
    <Id>c3084f66-c20b-4369-9803-06daa96cbc10</Id>
    <Name>sample string 2</Name>
  </ConsoleUserMinimal>
</ArrayOfConsoleUserMinimal>