Checkbox Survey Software Checkbox Survey Software
  • Features
    • Survey Creation
      Survey question types, logic, merging, and action options.
    • Survey Look & Feel
      Survey customization, branding, and mobile responsiveness.
    • Survey Distribution
      Email invitations, reminders, embed options, and custom links.
    • Security & Permissions
      Survey permissions, sharing options, SSO, and data security.
    • Results & Reporting
      Data export formats, charts & graphs, report filtering and API.
    • Automation & Integration
      Automatic emails & URL redirects, API, and JavaScript.
    • On-Premises Features
      Overview of on-premises version features and architecture.
    • Full Feature List
      Compare all features and limits for hosted and on-premises plans.
  • Pricing
    • Hosted Plans
      Individual, team and enterprise cloud-hosted plans.
    • On-Premises Software
      Perpetual software licenses, installed on your own servers.
    • White Label & OEM
      Learn about integrating Checkbox into your software for resale.
    • Discounts Programs
      Discounts for academic, government and non-profits.
  • About
    • Clients
      View a sampling of our global customers by industry.
    • Blog
      Company news, announcements, and industry articles.
    • Case Studies
      Learn how some of our clients use Checkbox to streamline operations.
  • Contact Us
  • Support
    • Version 7 Help Guides
      Searchable knowledge base for Checkbox Version 7.
    • Legacy (V6) Help Guides
      Searchable knowledge base for Checkbox Version 6.
    • API Docs
      Documentation for working with the Checkbox Version 7 API.
    • Technical Requirements
      Technical requirements for installing Checkbox on-premises.
    • Support Info & Policies
      Customer support hours, holidays, access information, and terms.
    • Support Login
      Login form for Checkbox on-premises support users.
  • 
  • 
    • Sales/General
      +1 (617) 231-8890
    • Support
      +1 (617) 231-8899
  • Sign In
    • US-hosted
      Sign in page for accounts hosted in the US.
    • Canada-hosted
      Sign in page for accounts hosted in Canada.
    • EU-hosted
      Sign in page for accounts hosted in the EU.
    • UK-hosted
      Sign in page for accounts hosted in the UK.
    • Australia-hosted
      Sign in page for accounts hosted in Australia.
    • Support Login
      Login for on-premises support customers.
  • Try it Free
    • Hosted Trial
      Create a 14-day cloud-hosted trial account. US, Canada, EU, UK, & Australia hosting options.
    • On-Premises Trial
      Download a 30-day on-premises trial to install on your own servers (not for PC/laptop installation).
    • Learn More
      Not sure which option to choose? Learn more about our versions.
Homepage / Doc / Get Users

Get Users

The GetUsers method matches the GetUserData method in data returned except that it returns data for multiple users matching filtering parameters.

class Test
{
    static void Main()
    {
        var client = new UserManagementServiceClient();

        var getUsersResponse = client.GetUsers(authToken, null, 1, 2, null, true, null, null);

        if (!getUsersResponse.CallSuccess)
        {
            Console.WriteLine(getUsersResponse.FailureMessage);
            return;
        }

        var userList = getUsersResponse.ResultData.ResultPage;

        foreach (var user in userList)
        {
            Console.WriteLine("UserName: {0} | Email: {1} | First Name: {2}", user.UniqueIdentifier, user.Email, user.Profile.NameValueList[0].Value);
            if (user.RoleMemberships != null)
            {
                Console.WriteLine("User has the following roles :");
                foreach (var role in user.RoleMemberships)
                {
                    Console.WriteLine(role);
                }
            }
        }

        //Always close the client
        client.Close();
    }
}

 

Input Parameters

Parameter Type Description
authToken string Authentication token to validate permission over the data requested
provider string This should be a null or empty string
pageNumber int Page number to pull for users supplying 0 will pull all pages at once
pageSize int Number of results to pull into a single page of users
sortField string Field to sort the data returned on. Valid values are : UniqueIdentifier, Email
sortAscending bool True will sort the data ascending, false will sort the data descending
filterField string Field to filter user data on. Valid values are : UniqueIdentifier, Email, UserName, GUID, Created, CreatedBy, ModifiedDate, ModifiedBy
filterValue string Value to filter the FilterField on
There is currently an issue in 2016 Q4 which causes this method to not sort properly by “Email”
This section is currently under construction. Any documents that appear blank will be populated as soon as possible. If you have any questions or need assistance with something that is not currently documented please feel free to submit a support ticket and we will be glad to assist you.
February 24, 2017

Web Services

  • Getting Started
    • Checking if API Is Live
    • Adding a service reference
  • Authentication
    • Login
  • Responses
    • Export Responses
  • Surveys
    • List Available Surveys
    • List Surveys and Folders
  • Users
    • Get User Data
    • Create User
    • Create User Group
    • Get Users
    • Lock User
    • Unlock User
  • Invitations
    • Create Invitation
    • Update Invitation
    • Add Scheduled Invitation Activity
    • Send Invitation to Filtered Recipient List
    • Create Email List Panel
    • Add Email Address To Email List Panel
    • Add Email List Panels to Invitation
  • Security
  • Styles

 

Checkbox develops affordable, feature-rich survey software for organizations, teams, and individuals. Available as a cloud-hosted subscription or installable software. API, source code and integration options available.

Checkbox Survey Inc.
65 Chapel Street, Newton, MA 02458  USA
General: 1-617-231-8890
Sales: 1-617-231-8891
Support: 1-617-231-8899
info@checkbox.com

  • Features
  • Pricing
  • On-Premises Software
  • Blog
  • Contact Us
  • Pay a Quote/Invoice
  • Support
  • Release Notes
  • API Documentation
  • Hosted SLA
  • Software License Agreement
  • Privacy Policy
©  2002 - Checkbox Survey, Inc.