1. v3
  2. Users
  3. GET - 3/users

Definition

GET - 3/users?role={role}&right={right}

Get all users for the account.

Required roles: Users (read)

Request information

role

Type integer
Additional info
Optional
right

Type string
Additional info
Optional

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 Collection of UserListApiModel
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

Note about API metadata
The API uses the same metadata structure for all endpoints, but not every field applies to every endpoint. Fields such as paging details (for example Limit, Offset and TotalRowCount) and IsFiltered are only returned by endpoints that support them. Fields that do not apply are not included in the actual response.
Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2026-11-13T20:04:48.631319Z",
    "IsFiltered": true
  },
  "Data": [
    {
      "UserId": 1,
      "Email": "sample string 2",
      "UserName": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "Company": "sample string 6",
      "Department": "sample string 7",
      "PhoneNumber": "sample string 8",
      "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
      },
      "SurveyAccessIds": [
        "sample string 1",
        "sample string 2"
      ],
      "IsLocked": true,
      "VerificationDate": "2026-11-13T20:04:48.631319Z",
      "LastActivityDate": "2026-11-13T20:04:48.631319Z",
      "PasswordChangeRequired": true,
      "MultiFactorAuthenticationRequired": true,
      "MultiFactorVerifyMethodId": true,
      "IsUserAdmin": true,
      "AccountId": "sample string 11",
      "AccountTypeId": 1,
      "LanguageCode": "sample string 12",
      "AllowUserChangeEmailAddress": true,
      "IsSSOEnabled": true,
      "PasswordAuthenticationAllowed": true
    },
    {
      "UserId": 1,
      "Email": "sample string 2",
      "UserName": "sample string 3",
      "FirstName": "sample string 4",
      "LastName": "sample string 5",
      "Company": "sample string 6",
      "Department": "sample string 7",
      "PhoneNumber": "sample string 8",
      "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
      },
      "SurveyAccessIds": [
        "sample string 1",
        "sample string 2"
      ],
      "IsLocked": true,
      "VerificationDate": "2026-11-13T20:04:48.631319Z",
      "LastActivityDate": "2026-11-13T20:04:48.631319Z",
      "PasswordChangeRequired": true,
      "MultiFactorAuthenticationRequired": true,
      "MultiFactorVerifyMethodId": true,
      "IsUserAdmin": true,
      "AccountId": "sample string 11",
      "AccountTypeId": 1,
      "LanguageCode": "sample string 12",
      "AllowUserChangeEmailAddress": true,
      "IsSSOEnabled": true,
      "PasswordAuthenticationAllowed": true
    }
  ]
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <UserListApiModel z:Id="i2">
      <AccountId>sample string 11</AccountId>
      <AccountTypeId>1</AccountTypeId>
      <AllowUserChangeEmailAddress>true</AllowUserChangeEmailAddress>
      <Company>sample string 6</Company>
      <Department>sample string 7</Department>
      <Email>sample string 2</Email>
      <FirstName>sample string 4</FirstName>
      <IsLocked>true</IsLocked>
      <IsSSOEnabled>true</IsSSOEnabled>
      <IsUserAdmin>true</IsUserAdmin>
      <LanguageCode>sample string 12</LanguageCode>
      <LastActivityDate>2026-11-13T20:04:48.631319+00:00</LastActivityDate>
      <LastName>sample string 5</LastName>
      <MultiFactorAuthenticationRequired>true</MultiFactorAuthenticationRequired>
      <MultiFactorVerifyMethodId>true</MultiFactorVerifyMethodId>
      <PasswordAuthenticationAllowed>true</PasswordAuthenticationAllowed>
      <PasswordChangeRequired>true</PasswordChangeRequired>
      <PhoneNumber>sample string 8</PhoneNumber>
      <Rights>
        <AccessAllContactLists>true</AccessAllContactLists>
        <AccessAllSurveys>true</AccessAllSurveys>
        <AnalyzeSurveys>true</AnalyzeSurveys>
        <CreateSurveys>true</CreateSurveys>
        <DistributePanels>true</DistributePanels>
        <DistributeSMS>true</DistributeSMS>
        <LaunchSurveys>true</LaunchSurveys>
        <ManageContacts>true</ManageContacts>
      </Rights>
      <Roles>
        <UserRoleApiModel>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </UserRoleApiModel>
        <UserRoleApiModel>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </UserRoleApiModel>
      </Roles>
      <SurveyAccessIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </SurveyAccessIds>
      <UserId>1</UserId>
      <UserName>sample string 3</UserName>
      <VerificationDate>2026-11-13T20:04:48.631319+00:00</VerificationDate>
    </UserListApiModel>
    <UserListApiModel z:Ref="i2" />
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2026-11-13T20:04:48.631319+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>