GET api/Users

Fetch a list of users

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

ListResultOfUser

Name	Description	Type	Additional information
TotalCount		integer	None.
Items		Collection of User	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "Items": [
    {
      "Active": true,
      "Currency": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "Status": "sample string 5",
      "Email": "sample string 6",
      "Culture": "sample string 7",
      "OrgUnitId": 8,
      "PositionId": 9,
      "Street": "sample string 10",
      "Zip": "sample string 11",
      "City": "sample string 12",
      "CountryCode": "sample string 13",
      "Phone": "sample string 14",
      "Mobile": "sample string 15",
      "Fax": "sample string 16",
      "Nr": "sample string 17",
      "Type": "sample string 18",
      "RoleId": 19,
      "DateOfBirth": "2025-12-08T14:24:52.6131735+00:00",
      "HiredDate": "2025-12-08T14:24:52.6131735+00:00",
      "Note": "sample string 22",
      "TechnicalContact": true,
      "UICulture": "sample string 24",
      "UserGroupIds": [
        1,
        2
      ],
      "EscalateToManager": true,
      "AllowOwnerAccess": true,
      "AccessPermissions": [
        {
          "EntityId": 1,
          "EntityType": "sample string 2",
          "ReadAccess": true,
          "FullAccess": true,
          "Id": 5
        },
        {
          "EntityId": 1,
          "EntityType": "sample string 2",
          "ReadAccess": true,
          "FullAccess": true,
          "Id": 5
        }
      ],
      "ManagerUserId": 27,
      "CompanyId": 28,
      "Id": 29
    },
    {
      "Active": true,
      "Currency": "sample string 2",
      "FirstName": "sample string 3",
      "LastName": "sample string 4",
      "Status": "sample string 5",
      "Email": "sample string 6",
      "Culture": "sample string 7",
      "OrgUnitId": 8,
      "PositionId": 9,
      "Street": "sample string 10",
      "Zip": "sample string 11",
      "City": "sample string 12",
      "CountryCode": "sample string 13",
      "Phone": "sample string 14",
      "Mobile": "sample string 15",
      "Fax": "sample string 16",
      "Nr": "sample string 17",
      "Type": "sample string 18",
      "RoleId": 19,
      "DateOfBirth": "2025-12-08T14:24:52.6131735+00:00",
      "HiredDate": "2025-12-08T14:24:52.6131735+00:00",
      "Note": "sample string 22",
      "TechnicalContact": true,
      "UICulture": "sample string 24",
      "UserGroupIds": [
        1,
        2
      ],
      "EscalateToManager": true,
      "AllowOwnerAccess": true,
      "AccessPermissions": [
        {
          "EntityId": 1,
          "EntityType": "sample string 2",
          "ReadAccess": true,
          "FullAccess": true,
          "Id": 5
        },
        {
          "EntityId": 1,
          "EntityType": "sample string 2",
          "ReadAccess": true,
          "FullAccess": true,
          "Id": 5
        }
      ],
      "ManagerUserId": 27,
      "CompanyId": 28,
      "Id": 29
    }
  ]
}

application/xml, text/xml

Sample:

<ListResultOfUserHWVxl9UY xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlKeeper.ApiModel">
  <Items>
    <User>
      <Id>29</Id>
      <CompanyId>28</CompanyId>
      <AccessPermissions>
        <AccessPermission>
          <Id>5</Id>
          <EntityId>1</EntityId>
          <EntityType>sample string 2</EntityType>
          <FullAccess>true</FullAccess>
          <ReadAccess>true</ReadAccess>
        </AccessPermission>
        <AccessPermission>
          <Id>5</Id>
          <EntityId>1</EntityId>
          <EntityType>sample string 2</EntityType>
          <FullAccess>true</FullAccess>
          <ReadAccess>true</ReadAccess>
        </AccessPermission>
      </AccessPermissions>
      <Active>true</Active>
      <AllowOwnerAccess>true</AllowOwnerAccess>
      <City>sample string 12</City>
      <CountryCode>sample string 13</CountryCode>
      <Culture>sample string 7</Culture>
      <Currency>sample string 2</Currency>
      <DateOfBirth>2025-12-08T14:24:52.6131735+00:00</DateOfBirth>
      <Email>sample string 6</Email>
      <EscalateToManager>true</EscalateToManager>
      <Fax>sample string 16</Fax>
      <FirstName>sample string 3</FirstName>
      <HiredDate>2025-12-08T14:24:52.6131735+00:00</HiredDate>
      <LastName>sample string 4</LastName>
      <ManagerUserId>27</ManagerUserId>
      <Mobile>sample string 15</Mobile>
      <Note>sample string 22</Note>
      <Nr>sample string 17</Nr>
      <OrgUnitId>8</OrgUnitId>
      <Phone>sample string 14</Phone>
      <PositionId>9</PositionId>
      <RoleId>19</RoleId>
      <Status>sample string 5</Status>
      <Street>sample string 10</Street>
      <TechnicalContact>true</TechnicalContact>
      <Type>sample string 18</Type>
      <UICulture>sample string 24</UICulture>
      <UserGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </UserGroupIds>
      <Zip>sample string 11</Zip>
    </User>
    <User>
      <Id>29</Id>
      <CompanyId>28</CompanyId>
      <AccessPermissions>
        <AccessPermission>
          <Id>5</Id>
          <EntityId>1</EntityId>
          <EntityType>sample string 2</EntityType>
          <FullAccess>true</FullAccess>
          <ReadAccess>true</ReadAccess>
        </AccessPermission>
        <AccessPermission>
          <Id>5</Id>
          <EntityId>1</EntityId>
          <EntityType>sample string 2</EntityType>
          <FullAccess>true</FullAccess>
          <ReadAccess>true</ReadAccess>
        </AccessPermission>
      </AccessPermissions>
      <Active>true</Active>
      <AllowOwnerAccess>true</AllowOwnerAccess>
      <City>sample string 12</City>
      <CountryCode>sample string 13</CountryCode>
      <Culture>sample string 7</Culture>
      <Currency>sample string 2</Currency>
      <DateOfBirth>2025-12-08T14:24:52.6131735+00:00</DateOfBirth>
      <Email>sample string 6</Email>
      <EscalateToManager>true</EscalateToManager>
      <Fax>sample string 16</Fax>
      <FirstName>sample string 3</FirstName>
      <HiredDate>2025-12-08T14:24:52.6131735+00:00</HiredDate>
      <LastName>sample string 4</LastName>
      <ManagerUserId>27</ManagerUserId>
      <Mobile>sample string 15</Mobile>
      <Note>sample string 22</Note>
      <Nr>sample string 17</Nr>
      <OrgUnitId>8</OrgUnitId>
      <Phone>sample string 14</Phone>
      <PositionId>9</PositionId>
      <RoleId>19</RoleId>
      <Status>sample string 5</Status>
      <Street>sample string 10</Street>
      <TechnicalContact>true</TechnicalContact>
      <Type>sample string 18</Type>
      <UICulture>sample string 24</UICulture>
      <UserGroupIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </UserGroupIds>
      <Zip>sample string 11</Zip>
    </User>
  </Items>
  <TotalCount>1</TotalCount>
</ListResultOfUserHWVxl9UY>