1. v3
  2. Users
  3. GET - 3/users/{userid}

Definition

GET - 3/users/{userId}

Required roles: AccountAdministrator,ApiAdministrator

Request information

userId

Type integer
Additional info
Required

Response information


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type UserApiModel
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2026-09-10T03:18:46.3333Z",
    "IsFiltered": true
  },
  "Data": {
    "UserId": 1,
    "Email": "sample string 2",
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "Company": "sample string 5",
    "Department": "sample string 6",
    "Address1": "sample string 7",
    "Address2": "sample string 8",
    "City": "sample string 9",
    "PostalCode": "sample string 10",
    "State": "sample string 11",
    "CountryId": "sample string 12",
    "PhoneNumber": "sample string 13",
    "Roles": [
      {
        "Id": 1,
        "Name": "sample string 2"
      },
      {
        "Id": 1,
        "Name": "sample string 2"
      }
    ],
    "Rights": {
      "CreateSurveys": true,
      "LaunchSurveys": true,
      "AnalyzeSurveys": true,
      "AccessAllSurveys": true,
      "AccessAllContactLists": true,
      "ManageContacts": true,
      "DistributeSMS": true,
      "DistributePanels": true,
      "ManageThemes": true,
      "EditAppearance": true,
      "ManageNotifications": true
    },
    "SurveyAccess": [
      {
        "SurveyId": "sample string 1",
        "HasReadPermission": true,
        "HasWritePermission": true,
        "IsNotificationEnabled": true
      },
      {
        "SurveyId": "sample string 1",
        "HasReadPermission": true,
        "HasWritePermission": true,
        "IsNotificationEnabled": true
      }
    ],
    "IsLocked": true,
    "LastLoginDate": "sample string 15",
    "AccountId": "sample string 16",
    "AccountTypeId": 1,
    "LanguageCode": "sample string 17",
    "TimeZoneId": 64,
    "DateFormat": "sample string 18",
    "Use12hTimeFormat": true,
    "DecimalSymbol": "sample string 19",
    "AllowUserChangeEmailAddress": true,
    "IsSSOEnabled": true,
    "PasswordAuthenticationAllowed": true,
    "UserName": "sample string 20",
    "TitleId": 64,
    "Province": "sample string 21",
    "SubscribedToNewLetters": true,
    "SubscribedToProductNotifications": true,
    "TotpVerifyMethodId": 64,
    "ActiveSince": "sample string 22"
  }
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data z:Id="i2">
    <AccountId>sample string 16</AccountId>
    <AccountTypeId>1</AccountTypeId>
    <ActiveSince>sample string 22</ActiveSince>
    <Address1>sample string 7</Address1>
    <Address2>sample string 8</Address2>
    <AllowUserChangeEmailAddress>true</AllowUserChangeEmailAddress>
    <City>sample string 9</City>
    <Company>sample string 5</Company>
    <CountryId>sample string 12</CountryId>
    <DateFormat>sample string 18</DateFormat>
    <DecimalSymbol>sample string 19</DecimalSymbol>
    <Department>sample string 6</Department>
    <Email>sample string 2</Email>
    <FirstName>sample string 3</FirstName>
    <IsLocked>true</IsLocked>
    <IsSSOEnabled>true</IsSSOEnabled>
    <LanguageCode>sample string 17</LanguageCode>
    <LastLoginDate>sample string 15</LastLoginDate>
    <LastName>sample string 4</LastName>
    <PasswordAuthenticationAllowed>true</PasswordAuthenticationAllowed>
    <PhoneNumber>sample string 13</PhoneNumber>
    <PostalCode>sample string 10</PostalCode>
    <Province>sample string 21</Province>
    <Rights>
      <AccessAllContactLists>true</AccessAllContactLists>
      <AccessAllSurveys>true</AccessAllSurveys>
      <AnalyzeSurveys>true</AnalyzeSurveys>
      <CreateSurveys>true</CreateSurveys>
      <DistributePanels>true</DistributePanels>
      <DistributeSMS>true</DistributeSMS>
      <EditAppearance>true</EditAppearance>
      <LaunchSurveys>true</LaunchSurveys>
      <ManageContacts>true</ManageContacts>
      <ManageNotifications>true</ManageNotifications>
      <ManageThemes>true</ManageThemes>
    </Rights>
    <Roles>
      <UserRoleApiModel>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </UserRoleApiModel>
      <UserRoleApiModel>
        <Id>1</Id>
        <Name>sample string 2</Name>
      </UserRoleApiModel>
    </Roles>
    <State>sample string 11</State>
    <SubscribedToNewLetters>true</SubscribedToNewLetters>
    <SubscribedToProductNotifications>true</SubscribedToProductNotifications>
    <SurveyAccess>
      <SurveyAccessApiModel>
        <HasReadPermission>true</HasReadPermission>
        <HasWritePermission>true</HasWritePermission>
        <IsNotificationEnabled>true</IsNotificationEnabled>
        <SurveyId>sample string 1</SurveyId>
      </SurveyAccessApiModel>
      <SurveyAccessApiModel>
        <HasReadPermission>true</HasReadPermission>
        <HasWritePermission>true</HasWritePermission>
        <IsNotificationEnabled>true</IsNotificationEnabled>
        <SurveyId>sample string 1</SurveyId>
      </SurveyAccessApiModel>
    </SurveyAccess>
    <TimeZoneId>64</TimeZoneId>
    <TitleId>64</TitleId>
    <TotpVerifyMethodId>64</TotpVerifyMethodId>
    <Use12hTimeFormat>true</Use12hTimeFormat>
    <UserId>1</UserId>
    <UserName>sample string 20</UserName>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2026-09-10T04:18:46.3333+01:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>