Management API

Base Resource URL:

     https://68.64.59.140/api/v01/users

Description:

Provides access to users registered in the system

Available sub-resources:

Resource URL Description
https://68.64.59.140/api/v01/users/[user-name]    User name of a user, on which action is required.

Supported Actions:

find  
Method:  GET       Implicit:  Yes       Returns:  User[] *      
Consumes:  xurl  Produces:  json, xml 
 
Returns list of available users based on specified search conditions.

Parameters:
# Name Type Required Default Description
01 offset Integer No 0 Index of the first record returned from the search result.\n\r\n> **Note:** Default value is 0. Used with limit parameter for pagination.\n\r\n> **Tip:** Use this field for implementing paginated results. See Error Messages section for details on pagination issues.
02 limit Integer No 100 Maximum number of records to load per search call.\n\r\n> **Note:** Default value is 100. Adjust based on performance requirements.\n\r\n> **Tip:** Use this field to balance response size and performance. See Webhooks Management Guide for details on handling large datasets.
03 сreateDate.from Date No Query parameter to search users by their creation date. All users created within the date range defined will be included.
04 сreateDate.to Date No Query parameter to search users by their creation date. All users created within the date range defined will be included.
05 userName String(255) No Query parameter to search users by full name (soundex on full name is supported as well).
06 name String(255) No Query parameter to search users by full name.
07 code Integer No Query parameter to search users by code.
08 id Integer No Query parameter to search users by id.
09 active Boolean No Query parameter to search users by activity status.
Copyright © Motionsoft. All Rights Reserved.
All Logos and Trademarks used or mentioned on this page are copyrighted property of their respective owners and are used for display purposes only.