GET User (User Search)

GET User (User Search)

The GET verb on the User API finds all users matching the given parameters. The User API allows various usage scenarios, allowing you to update/delete/create users from 3rd party systems using the API.

On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb.
The format query string parameter controls the desired response format.  Specify either XML or JSON.

/api/v2/user/search?format=xml/json

API Supports Pagination

This API endpoint implements pagination, so you must cater for this when you connect to our platform. You can learn more about pagination in our API overview.

Endpoints & API Explorer

NodeAPI EndpointAPI Explorer
USapi/v2/user/searchModel Description/Schema & Parameters

Parameters

The GET verb on the User API finds all users matching the given parameters. The required and optional parameters for a GET call to the User API are outlined below:

NameTypeDescriptionRequired
CompanyIdIntegerYour unique Company Id found on the Organisation Setup page of the secure website.✓
IntegrationKeyStringYour unique Integration Key found on the Organisation Setup page of the secure website.✓
NameStringUser name to search for.✓*
EmailStringUser email address to search for.✓*
ExternalIdStringUser external ID to search for.✓*
StatusStringSearch for Users in status.
UseNamesBooleanReturns Names instead of GUID identifier for Groups and Folders.
UseExternalIdsBooleanReturns External ID instead of GUID identifier for Groups and Folders.
PageNoIntegerThe page number from which to start reading results (0 based).
PageSizeIntegerThe page size (number of rows) to return. Maximum allowable value is 250.
IncludeDeletedUserAuditsBooleanIncludes audits for deleted users when set to true. False by default.

✓* – At least one parameter is required

Example

Given that the API is REST-based, you can access it directly via your web browser to test it using a REST plugin like the Postman plugin for Google Chrome.

Request URL

https://eforms.mobileform.net/api/v2/user/search?CompanyId=8XXXX&IntegrationKey=dXXXXXXXXXXXXXXXXXXXXXXXXXXXX&Email=user2%40mycompany.com

API Keys

Vendor accounts searching for users using Full Access API Integration Keys retrieve UserID and Id. All other accounts/keys retrieve Id.

Below is an unpopulated sample of what a GET response body might look like when communicating with our User API.

Response Body

{
  "Users": [
    {
      "Id": "eXXXXXXXXXXXXXXXXXXXXXXXXXXxXX",
      "UserId": 5XXXXX,
      "Type": "Premium",
      "FirstName": "Charlie",
      "LastName": "Smithers",
      "Email": "user2@mydomain.com",
      "LoginId": "user2@mydomain.com",
      "Status": "Active",
      "TimeZone": "Argentina Standard Time",
      "TimeZoneOffSet": -180,
      "Country": "AR",
      "WebsiteRole": "VendorAdmin",
      "CreatedDate": "2024-10-08T16:05:14.1076150Z",
      "LastUpdated": "2025-07-11T06:46:43.6611800Z",
      "LastActivity": "2025-04-29T14:12:49.3127810Z",
      "UserDevices": [
        {
          "Id": "eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "OS": "Windows",
          "OSVersion": " Windows 11 Home 23H2",
          "Hardware": "Microsoft Corporation Surface Laptop 4",
          "AppVersion": "6.16.21 (3.25)",
          "LastActivityDate": "2024-10-14T13:39:43Z"
        },
        {
          "Id": "3XXXXXXXXXXXXXXXXXXXXXXXXXX",
          "OS": "Android",
          "OSVersion": "31",
          "Hardware": "Motorola: moto g200 5G",
          "AppVersion": "6.18.01 (32.2)",
          "LastActivityDate": "2024-10-14T16:57:44Z"
        },
        {
          "Id": "fXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
          "OS": "Windows",
          "OSVersion": " Windows 11 Pro 24H2",
          "Hardware": "Micro Computer (HK) Tech Limited Venus series",
          "Alias": "DESKTOP-J6MQBDI",
          "AppVersion": "6.21.00 (3.68)",
          "LastActivityDate": "2025-04-29T14:12:49Z"
        }
      ],
      "UserAudits": [
        {
          "Id": 5XXXXX,
          "Email": "user2@mydomain.com",
          "LoginId": "user2@mydomain.com",
          "On": "2024-10-08T16:05:14.2794975Z",
          "Off": "2024-10-08T16:11:18.4782949Z",
          "OffReason": "Activated",
          "Type": "Premium",
          "Status": "Invited"
        },
        {
          "Id": 5XXXXX,
          "Email": "user2@mydomain.com",
          "LoginId": "user2@mydomain.com",
          "On": "2024-10-08T16:11:18.4782949Z",
          "Type": "Premium",
          "Status": "Active"
        }
      ],
      "Folders": [],
      "Groups": [],
      "CompanyId": 8XXXX
    }
  ],
  "TotalRows": 1
}

    • Related Articles

    • GET Usergroup (Search)

      This API allows you to find all user groups matching the given parameters. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter controls the desired response format. Specify ...

    • Get Tasks (Task Search)

      Using the TaskkSearch API The TaskkSearch API allows you to search for multiple Tasks at a time To search for and retrieve multiple Tasks at once, use a GET with the search API found at: ...

    • GET Environments (Search Multiple)

      To search for and retrieve multiple Environments at once, use a GET with the Search API found at our API Explorer. On the Cloud, this API is available via SSL-secured HTTPS connection using the GET verb. The format query string parameter controls the ...

    • GET Screen (Iconboard Search)

      The GET Screen (Iconboard Search) API returns the Published version of the matching Icon Boards or all versions of a specified Icon Board. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query ...

    • GET Task Recurring (Search)

      This request method lets you find all recurring tasks matching the provided search criteria. On the Cloud, this API is available via SSL-secured HTTPS connection using the REST GET verb. The format query string parameter controls the desired response ...