GET api/Account/GetUsers?pageIndex={pageIndex}&pageSize={pageSize}

Gets the list of users. The role of administrator or operator is required. An operator can access according to the customer module access settings. Pagination is supported.

Request Information

URI Parameters

Name	Description	Type	Additional information
pageIndex	Optional page index (default is 0).	integer	None.
pageSize	Optional page size (default is 200).	integer	None.

Body Parameters

None.

Response Information

Resource Description

HttpStatusCode 200 OK or 400 BadRequest with Message.

GetUsersResult

Name	Description	Type	Additional information
PagedUsers	A page with Users.	RequestorUser	None.

Response Formats

application/json, text/json

Sample:

{
  "PagedUsers": {
    "PageIndex": 0,
    "PageSize": 200,
    "TotalItems": 2,
    "TotalPages": 1,
    "Items": [
      {
        "UserProviderKey": "7cc6a73c-3103-44bb-ba62-b48e4151c82d",
        "UserName": "john.doe",
        "Email": "john.doe@domain.com",
        "FirstName": "John",
        "LastName": "Doe",
        "MiddleName": null,
        "DisplayName": "John Doe",
        "NoteBesideName": null,
        "FullName": "John Doe",
        "IsApproved": true,
        "IsEndUser": true,
        "IsSmartUser": false,
        "IsOperator": false,
        "IsSuperOperator": false,
        "IsAdministrator": false,
        "TimeZoneId": "Central Europe Standard Time",
        "ExternalAccount": false,
        "EmailAccount": false,
        "Customer": null,
        "CustomerId": null,
        "Customers": null,
        "Phones": [
          "+420 732 389 583"
        ],
        "AdditionalInformation": "Everything else",
        "OperatorGroupIds": null,
        "InternalGroupIds": null,
        "Color": null,
        "Initials": null,
        "PhotoLastUpdatedUtc": null,
        "CustomUserFieldsHash": 0,
        "FieldData": null,
        "LastUpdatedUtc": null,
        "Language": 0,
        "Anonymized": false,
        "Tags": [
          {
            "Id": 1,
            "Name": "Sample tag",
            "Static": true,
            "Color": "#ffffff",
            "Type": 2
          },
          {
            "Id": 2,
            "Name": "Sample 2",
            "Static": true,
            "Color": "#fafafa",
            "Type": 2
          }
        ],
        "ExternalId": null,
        "ManagerKey": null,
        "Company": null,
        "Department": null,
        "Division": null,
        "EmployeeId": null,
        "SecondaryEmails": [
          "john.doe@mymail.com"
        ]
      },
      {
        "UserProviderKey": "c2ad64b5-ea4e-42c6-9138-eee51c091ae8",
        "UserName": "jane.doe",
        "Email": "jane.doe@domain.com",
        "FirstName": "Jane",
        "LastName": "Doe",
        "MiddleName": null,
        "DisplayName": "Jane Doe",
        "NoteBesideName": null,
        "FullName": "Jane Doe",
        "IsApproved": true,
        "IsEndUser": true,
        "IsSmartUser": false,
        "IsOperator": false,
        "IsSuperOperator": false,
        "IsAdministrator": false,
        "TimeZoneId": "Central Europe Standard Time",
        "ExternalAccount": false,
        "EmailAccount": false,
        "Customer": null,
        "CustomerId": null,
        "Customers": null,
        "Phones": [
          "+420 732 389 584"
        ],
        "AdditionalInformation": "Something else",
        "OperatorGroupIds": null,
        "InternalGroupIds": null,
        "Color": null,
        "Initials": null,
        "PhotoLastUpdatedUtc": null,
        "CustomUserFieldsHash": 0,
        "FieldData": null,
        "LastUpdatedUtc": null,
        "Language": 0,
        "Anonymized": false,
        "Tags": null,
        "ExternalId": null,
        "ManagerKey": null,
        "Company": null,
        "Department": null,
        "Division": null,
        "EmployeeId": null,
        "SecondaryEmails": [
          "jane.doe@mymail.com"
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:

<GetUsersResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <PagedUsers>
    <Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
      <d3p1:RequestorUser>
        <d3p1:AdditionalInformation>Everything else</d3p1:AdditionalInformation>
        <d3p1:Anonymized>false</d3p1:Anonymized>
        <d3p1:Color i:nil="true" />
        <d3p1:Company i:nil="true" />
        <d3p1:CustomUserFieldsHash>0</d3p1:CustomUserFieldsHash>
        <d3p1:Customer i:nil="true" />
        <d3p1:CustomerId i:nil="true" />
        <d3p1:Customers i:nil="true" />
        <d3p1:Department i:nil="true" />
        <d3p1:DisplayName>John Doe</d3p1:DisplayName>
        <d3p1:Division i:nil="true" />
        <d3p1:Email>john.doe@domain.com</d3p1:Email>
        <d3p1:EmailAccount>false</d3p1:EmailAccount>
        <d3p1:EmployeeId i:nil="true" />
        <d3p1:ExternalAccount>false</d3p1:ExternalAccount>
        <d3p1:ExternalId i:nil="true" />
        <d3p1:FieldData i:nil="true" />
        <d3p1:FirstName>John</d3p1:FirstName>
        <d3p1:FullName>John Doe</d3p1:FullName>
        <d3p1:Initials i:nil="true" />
        <d3p1:InternalGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d3p1:IsAdministrator>false</d3p1:IsAdministrator>
        <d3p1:IsApproved>true</d3p1:IsApproved>
        <d3p1:IsEndUser>true</d3p1:IsEndUser>
        <d3p1:IsOperator>false</d3p1:IsOperator>
        <d3p1:IsSmartUser>false</d3p1:IsSmartUser>
        <d3p1:IsSuperOperator>false</d3p1:IsSuperOperator>
        <d3p1:Language>en</d3p1:Language>
        <d3p1:LastName>Doe</d3p1:LastName>
        <d3p1:LastUpdatedUtc i:nil="true" />
        <d3p1:ManagerKey i:nil="true" />
        <d3p1:MiddleName i:nil="true" />
        <d3p1:NoteBesideName i:nil="true" />
        <d3p1:OperatorGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d3p1:Phones xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>+420 732 389 583</d5p1:string>
        </d3p1:Phones>
        <d3p1:PhotoLastUpdatedUtc i:nil="true" />
        <d3p1:SecondaryEmails xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>john.doe@mymail.com</d5p1:string>
        </d3p1:SecondaryEmails>
        <d3p1:Tags>
          <d3p1:TagData>
            <d3p1:Color>#ffffff</d3p1:Color>
            <d3p1:Id>1</d3p1:Id>
            <d3p1:Name>Sample tag</d3p1:Name>
            <d3p1:Static>true</d3p1:Static>
            <d3p1:Type>UserAndCompany</d3p1:Type>
          </d3p1:TagData>
          <d3p1:TagData>
            <d3p1:Color>#fafafa</d3p1:Color>
            <d3p1:Id>2</d3p1:Id>
            <d3p1:Name>Sample 2</d3p1:Name>
            <d3p1:Static>true</d3p1:Static>
            <d3p1:Type>UserAndCompany</d3p1:Type>
          </d3p1:TagData>
        </d3p1:Tags>
        <d3p1:TimeZoneId>Central Europe Standard Time</d3p1:TimeZoneId>
        <d3p1:UserName>john.doe</d3p1:UserName>
        <d3p1:UserProviderKey>7cc6a73c-3103-44bb-ba62-b48e4151c82d</d3p1:UserProviderKey>
      </d3p1:RequestorUser>
      <d3p1:RequestorUser>
        <d3p1:AdditionalInformation>Something else</d3p1:AdditionalInformation>
        <d3p1:Anonymized>false</d3p1:Anonymized>
        <d3p1:Color i:nil="true" />
        <d3p1:Company i:nil="true" />
        <d3p1:CustomUserFieldsHash>0</d3p1:CustomUserFieldsHash>
        <d3p1:Customer i:nil="true" />
        <d3p1:CustomerId i:nil="true" />
        <d3p1:Customers i:nil="true" />
        <d3p1:Department i:nil="true" />
        <d3p1:DisplayName>Jane Doe</d3p1:DisplayName>
        <d3p1:Division i:nil="true" />
        <d3p1:Email>jane.doe@domain.com</d3p1:Email>
        <d3p1:EmailAccount>false</d3p1:EmailAccount>
        <d3p1:EmployeeId i:nil="true" />
        <d3p1:ExternalAccount>false</d3p1:ExternalAccount>
        <d3p1:ExternalId i:nil="true" />
        <d3p1:FieldData i:nil="true" />
        <d3p1:FirstName>Jane</d3p1:FirstName>
        <d3p1:FullName>Jane Doe</d3p1:FullName>
        <d3p1:Initials i:nil="true" />
        <d3p1:InternalGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d3p1:IsAdministrator>false</d3p1:IsAdministrator>
        <d3p1:IsApproved>true</d3p1:IsApproved>
        <d3p1:IsEndUser>true</d3p1:IsEndUser>
        <d3p1:IsOperator>false</d3p1:IsOperator>
        <d3p1:IsSmartUser>false</d3p1:IsSmartUser>
        <d3p1:IsSuperOperator>false</d3p1:IsSuperOperator>
        <d3p1:Language>en</d3p1:Language>
        <d3p1:LastName>Doe</d3p1:LastName>
        <d3p1:LastUpdatedUtc i:nil="true" />
        <d3p1:ManagerKey i:nil="true" />
        <d3p1:MiddleName i:nil="true" />
        <d3p1:NoteBesideName i:nil="true" />
        <d3p1:OperatorGroupIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" />
        <d3p1:Phones xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>+420 732 389 584</d5p1:string>
        </d3p1:Phones>
        <d3p1:PhotoLastUpdatedUtc i:nil="true" />
        <d3p1:SecondaryEmails xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>jane.doe@mymail.com</d5p1:string>
        </d3p1:SecondaryEmails>
        <d3p1:Tags i:nil="true" />
        <d3p1:TimeZoneId>Central Europe Standard Time</d3p1:TimeZoneId>
        <d3p1:UserName>jane.doe</d3p1:UserName>
        <d3p1:UserProviderKey>c2ad64b5-ea4e-42c6-9138-eee51c091ae8</d3p1:UserProviderKey>
      </d3p1:RequestorUser>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>200</PageSize>
    <TotalItems>2</TotalItems>
    <TotalPages>1</TotalPages>
  </PagedUsers>
</GetUsersResult>