GET api/users/list?pageNumber={pageNumber}&pageSize={pageSize}&profileCode={profileCode}&applicationBranchOfficeID={applicationBranchOfficeID}

Request Information

URI Parameters

Name	Type	Additional information
pageNumber	integer	Required
pageSize	integer	Required
profileCode	string	Required
applicationBranchOfficeID	integer	Required

Body Parameters

None.

Response Information

Resource Description

PagedListOfUserData

Name	Type	Additional information
ListOfEntities	Collection of UserData	None.
TotalItems	integer	None.
PageSize	integer	None.
TotalPages	integer	None.
CurrentPage	integer	None.
IsLastPage	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ListOfEntities": [
    {
      "ID": "f0fcfa75-c40a-4846-81f7-95d359c26ce7",
      "Username": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "DisplayName": "sample string 4",
      "Email": "sample string 5",
      "IsSuperAdmin": true,
      "Commision": 1.0,
      "Disabled": true,
      "DisabledApp": true,
      "Password": "sample string 6",
      "PasswordTemporal": true,
      "LastLogin": "2025-08-02T19:12:57.6972306+00:00",
      "ExtraData": {
        "sample string 1": {
          "Type": 0,
          "Name": "sample string 1",
          "Value": "sample string 2",
          "Required": true
        },
        "sample string 2": {
          "Type": 0,
          "Name": "sample string 1",
          "Value": "sample string 2",
          "Required": true
        },
        "ChangePriceInSale": {
          "Type": 2,
          "Name": "ChangePriceInSale",
          "Value": "NO_CHANGE",
          "Required": false
        }
      },
      "UserProfileList": [
        {
          "AppID": "81f5d461-f44c-49f1-8794-35820b8868b5",
          "ApplicationBranchOfficeID": 1,
          "UserID": "a6895afc-2aca-4f98-a8fc-6bcfed30d958",
          "SystemProfileID": 1,
          "SystemProfileName": "sample string 1",
          "ProfileCodeAsEnum": 0,
          "ID": 1
        },
        {
          "AppID": "81f5d461-f44c-49f1-8794-35820b8868b5",
          "ApplicationBranchOfficeID": 1,
          "UserID": "a6895afc-2aca-4f98-a8fc-6bcfed30d958",
          "SystemProfileID": 1,
          "SystemProfileName": "sample string 1",
          "ProfileCodeAsEnum": 0,
          "ID": 1
        }
      ],
      "ModifiedOn": "2025-08-02T19:12:57.6972306+00:00",
      "Deleted": true,
      "EnabledChangePriceInSale": true,
      "ChangePriceInSale": 0
    },
    {
      "ID": "f0fcfa75-c40a-4846-81f7-95d359c26ce7",
      "Username": "sample string 1",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "DisplayName": "sample string 4",
      "Email": "sample string 5",
      "IsSuperAdmin": true,
      "Commision": 1.0,
      "Disabled": true,
      "DisabledApp": true,
      "Password": "sample string 6",
      "PasswordTemporal": true,
      "LastLogin": "2025-08-02T19:12:57.6972306+00:00",
      "ExtraData": {
        "sample string 1": {
          "Type": 0,
          "Name": "sample string 1",
          "Value": "sample string 2",
          "Required": true
        },
        "sample string 2": {
          "Type": 0,
          "Name": "sample string 1",
          "Value": "sample string 2",
          "Required": true
        },
        "ChangePriceInSale": {
          "Type": 2,
          "Name": "ChangePriceInSale",
          "Value": "NO_CHANGE",
          "Required": false
        }
      },
      "UserProfileList": [
        {
          "AppID": "81f5d461-f44c-49f1-8794-35820b8868b5",
          "ApplicationBranchOfficeID": 1,
          "UserID": "a6895afc-2aca-4f98-a8fc-6bcfed30d958",
          "SystemProfileID": 1,
          "SystemProfileName": "sample string 1",
          "ProfileCodeAsEnum": 0,
          "ID": 1
        },
        {
          "AppID": "81f5d461-f44c-49f1-8794-35820b8868b5",
          "ApplicationBranchOfficeID": 1,
          "UserID": "a6895afc-2aca-4f98-a8fc-6bcfed30d958",
          "SystemProfileID": 1,
          "SystemProfileName": "sample string 1",
          "ProfileCodeAsEnum": 0,
          "ID": 1
        }
      ],
      "ModifiedOn": "2025-08-02T19:12:57.6972306+00:00",
      "Deleted": true,
      "EnabledChangePriceInSale": true,
      "ChangePriceInSale": 0
    }
  ],
  "TotalItems": 1,
  "PageSize": 1,
  "TotalPages": 1,
  "CurrentPage": 1,
  "IsLastPage": true
}

text/xml

Sample:

<PagedListOfUserData_P0N_S4YHh xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StackBase.Common.Data">
  <CurrentPage>1</CurrentPage>
  <ListOfEntities>
    <UserData>
      <ChangePriceInSale>NO_CHANGE</ChangePriceInSale>
      <Commision>1</Commision>
      <Deleted>true</Deleted>
      <Disabled>true</Disabled>
      <DisabledApp>true</DisabledApp>
      <DisplayName>sample string 4</DisplayName>
      <Email>sample string 5</Email>
      <ExtraData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringPropertyDatal3xPxu36>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>
            <Name>sample string 1</Name>
            <Required>true</Required>
            <Type>INT</Type>
            <Value>sample string 2</Value>
          </d4p1:Value>
        </d4p1:KeyValueOfstringPropertyDatal3xPxu36>
        <d4p1:KeyValueOfstringPropertyDatal3xPxu36>
          <d4p1:Key>sample string 2</d4p1:Key>
          <d4p1:Value>
            <Name>sample string 1</Name>
            <Required>true</Required>
            <Type>INT</Type>
            <Value>sample string 2</Value>
          </d4p1:Value>
        </d4p1:KeyValueOfstringPropertyDatal3xPxu36>
        <d4p1:KeyValueOfstringPropertyDatal3xPxu36>
          <d4p1:Key>ChangePriceInSale</d4p1:Key>
          <d4p1:Value>
            <Name>ChangePriceInSale</Name>
            <Required>false</Required>
            <Type>STRING</Type>
            <Value>NO_CHANGE</Value>
          </d4p1:Value>
        </d4p1:KeyValueOfstringPropertyDatal3xPxu36>
      </ExtraData>
      <FirstName>sample string 2</FirstName>
      <ID>f0fcfa75-c40a-4846-81f7-95d359c26ce7</ID>
      <IsSuperAdmin>true</IsSuperAdmin>
      <LastLogin>2025-08-02T19:12:57.6972306+00:00</LastLogin>
      <LastName>sample string 3</LastName>
      <ModifiedOn>2025-08-02T19:12:57.6972306+00:00</ModifiedOn>
      <Password>sample string 6</Password>
      <PasswordTemporal>true</PasswordTemporal>
      <UserProfileList>
        <UserProfileData>
          <ID>1</ID>
          <AppID>81f5d461-f44c-49f1-8794-35820b8868b5</AppID>
          <ApplicationBranchOfficeID>1</ApplicationBranchOfficeID>
          <ProfileCodeAsEnum>ALL</ProfileCodeAsEnum>
          <SystemProfileID>1</SystemProfileID>
          <SystemProfileName>sample string 1</SystemProfileName>
          <UserID>a6895afc-2aca-4f98-a8fc-6bcfed30d958</UserID>
        </UserProfileData>
        <UserProfileData>
          <ID>1</ID>
          <AppID>81f5d461-f44c-49f1-8794-35820b8868b5</AppID>
          <ApplicationBranchOfficeID>1</ApplicationBranchOfficeID>
          <ProfileCodeAsEnum>ALL</ProfileCodeAsEnum>
          <SystemProfileID>1</SystemProfileID>
          <SystemProfileName>sample string 1</SystemProfileName>
          <UserID>a6895afc-2aca-4f98-a8fc-6bcfed30d958</UserID>
        </UserProfileData>
      </UserProfileList>
      <Username>sample string 1</Username>
    </UserData>
    <UserData>
      <ChangePriceInSale>NO_CHANGE</ChangePriceInSale>
      <Commision>1</Commision>
      <Deleted>true</Deleted>
      <Disabled>true</Disabled>
      <DisabledApp>true</DisabledApp>
      <DisplayName>sample string 4</DisplayName>
      <Email>sample string 5</Email>
      <ExtraData xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringPropertyDatal3xPxu36>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>
            <Name>sample string 1</Name>
            <Required>true</Required>
            <Type>INT</Type>
            <Value>sample string 2</Value>
          </d4p1:Value>
        </d4p1:KeyValueOfstringPropertyDatal3xPxu36>
        <d4p1:KeyValueOfstringPropertyDatal3xPxu36>
          <d4p1:Key>sample string 2</d4p1:Key>
          <d4p1:Value>
            <Name>sample string 1</Name>
            <Required>true</Required>
            <Type>INT</Type>
            <Value>sample string 2</Value>
          </d4p1:Value>
        </d4p1:KeyValueOfstringPropertyDatal3xPxu36>
        <d4p1:KeyValueOfstringPropertyDatal3xPxu36>
          <d4p1:Key>ChangePriceInSale</d4p1:Key>
          <d4p1:Value>
            <Name>ChangePriceInSale</Name>
            <Required>false</Required>
            <Type>STRING</Type>
            <Value>NO_CHANGE</Value>
          </d4p1:Value>
        </d4p1:KeyValueOfstringPropertyDatal3xPxu36>
      </ExtraData>
      <FirstName>sample string 2</FirstName>
      <ID>f0fcfa75-c40a-4846-81f7-95d359c26ce7</ID>
      <IsSuperAdmin>true</IsSuperAdmin>
      <LastLogin>2025-08-02T19:12:57.6972306+00:00</LastLogin>
      <LastName>sample string 3</LastName>
      <ModifiedOn>2025-08-02T19:12:57.6972306+00:00</ModifiedOn>
      <Password>sample string 6</Password>
      <PasswordTemporal>true</PasswordTemporal>
      <UserProfileList>
        <UserProfileData>
          <ID>1</ID>
          <AppID>81f5d461-f44c-49f1-8794-35820b8868b5</AppID>
          <ApplicationBranchOfficeID>1</ApplicationBranchOfficeID>
          <ProfileCodeAsEnum>ALL</ProfileCodeAsEnum>
          <SystemProfileID>1</SystemProfileID>
          <SystemProfileName>sample string 1</SystemProfileName>
          <UserID>a6895afc-2aca-4f98-a8fc-6bcfed30d958</UserID>
        </UserProfileData>
        <UserProfileData>
          <ID>1</ID>
          <AppID>81f5d461-f44c-49f1-8794-35820b8868b5</AppID>
          <ApplicationBranchOfficeID>1</ApplicationBranchOfficeID>
          <ProfileCodeAsEnum>ALL</ProfileCodeAsEnum>
          <SystemProfileID>1</SystemProfileID>
          <SystemProfileName>sample string 1</SystemProfileName>
          <UserID>a6895afc-2aca-4f98-a8fc-6bcfed30d958</UserID>
        </UserProfileData>
      </UserProfileList>
      <Username>sample string 1</Username>
    </UserData>
  </ListOfEntities>
  <PageSize>1</PageSize>
  <TotalItems>1</TotalItems>
</PagedListOfUserData_P0N_S4YHh>