GET api/Users

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of User

Name	Type	Additional information
UserID	string	None.
UserNum	integer	None.
FullName	string	None.
UserName	string	None.
FirstName	string	None.
LastName	string	None.
Country	string	None.
CountryID	integer	None.
CountryCode	string	None.
CountryCode3	string	None.
Address	string	None.
Address2	string	None.
City	string	None.
State	string	None.
Zip	string	None.
Latitude	decimal number	None.
Longitude	decimal number	None.
UserEmail	string	None.
DOB	date	None.
Gender	string	None.
ClientID	integer	None.
ClientName	string	None.
ServiceProviderID	string	None.
ServiceProvider	string	None.
RoleId	string	None.
RoleName	string	None.
LastLoginDate	string	None.
IsApproved	boolean	None.
IsLockedOut	boolean	None.
PasswordQuestion	string	None.
ImageTitle	string	None.
Image	Collection of byte	None.
ContentType	string	None.
CallAvailabilityStatus	string	None.
CallAvailabilityStatusChanged	date	None.
CanReceiveSMS	boolean	None.
EnableTwoDayReminder	boolean	None.
EnableThreeHourReminder	boolean	None.
BackgroundCheckApproval	boolean	None.
Website	string	None.
DisplayUserNum	string	None.
IsLSPUser	boolean	None.
IsVolatiaAdmin	boolean	None.
IsClientAdmin	boolean	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "UserID": "sample string 1",
    "UserNum": 2,
    "FullName": "sample string 3",
    "UserName": "sample string 4",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "Country": "sample string 7",
    "CountryID": 8,
    "CountryCode": "sample string 9",
    "CountryCode3": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "City": "sample string 13",
    "State": "sample string 14",
    "Zip": "sample string 15",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "UserEmail": "sample string 16",
    "DOB": "2025-09-03T14:11:21.992813+00:00",
    "Gender": "sample string 17",
    "ClientID": 1,
    "ClientName": "sample string 18",
    "ServiceProviderID": "sample string 19",
    "ServiceProvider": "sample string 20",
    "RoleId": "sample string 21",
    "RoleName": "sample string 22",
    "LastLoginDate": "sample string 23",
    "IsApproved": true,
    "IsLockedOut": true,
    "PasswordQuestion": "sample string 26",
    "ImageTitle": "sample string 27",
    "Image": "QEA=",
    "ContentType": "sample string 28",
    "CallAvailabilityStatus": "sample string 29",
    "CallAvailabilityStatusChanged": "2025-09-03T14:11:21.992813+00:00",
    "CanReceiveSMS": true,
    "EnableTwoDayReminder": true,
    "EnableThreeHourReminder": true,
    "BackgroundCheckApproval": true,
    "Website": "sample string 33",
    "DisplayUserNum": "100002",
    "IsLSPUser": false,
    "IsVolatiaAdmin": false,
    "IsClientAdmin": false
  },
  {
    "UserID": "sample string 1",
    "UserNum": 2,
    "FullName": "sample string 3",
    "UserName": "sample string 4",
    "FirstName": "sample string 5",
    "LastName": "sample string 6",
    "Country": "sample string 7",
    "CountryID": 8,
    "CountryCode": "sample string 9",
    "CountryCode3": "sample string 10",
    "Address": "sample string 11",
    "Address2": "sample string 12",
    "City": "sample string 13",
    "State": "sample string 14",
    "Zip": "sample string 15",
    "Latitude": 1.1,
    "Longitude": 1.1,
    "UserEmail": "sample string 16",
    "DOB": "2025-09-03T14:11:21.992813+00:00",
    "Gender": "sample string 17",
    "ClientID": 1,
    "ClientName": "sample string 18",
    "ServiceProviderID": "sample string 19",
    "ServiceProvider": "sample string 20",
    "RoleId": "sample string 21",
    "RoleName": "sample string 22",
    "LastLoginDate": "sample string 23",
    "IsApproved": true,
    "IsLockedOut": true,
    "PasswordQuestion": "sample string 26",
    "ImageTitle": "sample string 27",
    "Image": "QEA=",
    "ContentType": "sample string 28",
    "CallAvailabilityStatus": "sample string 29",
    "CallAvailabilityStatusChanged": "2025-09-03T14:11:21.992813+00:00",
    "CanReceiveSMS": true,
    "EnableTwoDayReminder": true,
    "EnableThreeHourReminder": true,
    "BackgroundCheckApproval": true,
    "Website": "sample string 33",
    "DisplayUserNum": "100002",
    "IsLSPUser": false,
    "IsVolatiaAdmin": false,
    "IsClientAdmin": false
  }
]

application/xml, text/xml

Sample:

<ArrayOfUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIClassLibrary.DataAccess">
  <User>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <BackgroundCheckApproval>true</BackgroundCheckApproval>
    <CallAvailabilityStatus>sample string 29</CallAvailabilityStatus>
    <CallAvailabilityStatusChanged>2025-09-03T14:11:21.992813+00:00</CallAvailabilityStatusChanged>
    <CanReceiveSMS>true</CanReceiveSMS>
    <City>sample string 13</City>
    <ClientID>1</ClientID>
    <ClientName>sample string 18</ClientName>
    <ContentType>sample string 28</ContentType>
    <Country>sample string 7</Country>
    <CountryCode>sample string 9</CountryCode>
    <CountryCode3>sample string 10</CountryCode3>
    <CountryID>8</CountryID>
    <DOB>2025-09-03T14:11:21.992813+00:00</DOB>
    <EnableThreeHourReminder>true</EnableThreeHourReminder>
    <EnableTwoDayReminder>true</EnableTwoDayReminder>
    <FirstName>sample string 5</FirstName>
    <FullName>sample string 3</FullName>
    <Gender>sample string 17</Gender>
    <Image>QEA=</Image>
    <ImageTitle>sample string 27</ImageTitle>
    <IsApproved>true</IsApproved>
    <IsLockedOut>true</IsLockedOut>
    <LastLoginDate>sample string 23</LastLoginDate>
    <LastName>sample string 6</LastName>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <PasswordQuestion>sample string 26</PasswordQuestion>
    <RoleId>sample string 21</RoleId>
    <RoleName>sample string 22</RoleName>
    <ServiceProvider>sample string 20</ServiceProvider>
    <ServiceProviderID>sample string 19</ServiceProviderID>
    <State>sample string 14</State>
    <UserEmail>sample string 16</UserEmail>
    <UserID>sample string 1</UserID>
    <UserName>sample string 4</UserName>
    <UserNum>2</UserNum>
    <Website>sample string 33</Website>
    <Zip>sample string 15</Zip>
  </User>
  <User>
    <Address>sample string 11</Address>
    <Address2>sample string 12</Address2>
    <BackgroundCheckApproval>true</BackgroundCheckApproval>
    <CallAvailabilityStatus>sample string 29</CallAvailabilityStatus>
    <CallAvailabilityStatusChanged>2025-09-03T14:11:21.992813+00:00</CallAvailabilityStatusChanged>
    <CanReceiveSMS>true</CanReceiveSMS>
    <City>sample string 13</City>
    <ClientID>1</ClientID>
    <ClientName>sample string 18</ClientName>
    <ContentType>sample string 28</ContentType>
    <Country>sample string 7</Country>
    <CountryCode>sample string 9</CountryCode>
    <CountryCode3>sample string 10</CountryCode3>
    <CountryID>8</CountryID>
    <DOB>2025-09-03T14:11:21.992813+00:00</DOB>
    <EnableThreeHourReminder>true</EnableThreeHourReminder>
    <EnableTwoDayReminder>true</EnableTwoDayReminder>
    <FirstName>sample string 5</FirstName>
    <FullName>sample string 3</FullName>
    <Gender>sample string 17</Gender>
    <Image>QEA=</Image>
    <ImageTitle>sample string 27</ImageTitle>
    <IsApproved>true</IsApproved>
    <IsLockedOut>true</IsLockedOut>
    <LastLoginDate>sample string 23</LastLoginDate>
    <LastName>sample string 6</LastName>
    <Latitude>1.1</Latitude>
    <Longitude>1.1</Longitude>
    <PasswordQuestion>sample string 26</PasswordQuestion>
    <RoleId>sample string 21</RoleId>
    <RoleName>sample string 22</RoleName>
    <ServiceProvider>sample string 20</ServiceProvider>
    <ServiceProviderID>sample string 19</ServiceProviderID>
    <State>sample string 14</State>
    <UserEmail>sample string 16</UserEmail>
    <UserID>sample string 1</UserID>
    <UserName>sample string 4</UserName>
    <UserNum>2</UserNum>
    <Website>sample string 33</Website>
    <Zip>sample string 15</Zip>
  </User>
</ArrayOfUser>