Search Syncable Accounts
Searches the accounts that can be synchronized, with pagination.
Request URL
POST {base_url}/uc-user/api/v1/accounts/resellers/syncable/search-pageRequest parameters
- Headers
-
Parameter Required Type Description Authorization Yes String The access token used for authentication. Format: Bearer
{access_token}.x-tenant-code No String The tenant name. Note: You can obtain tenant name using the Query Tenants interface.
- Body parameters
-
Parameter Required Type Description pageSize No Integer The number of records to retrieve per page. pageNumber No Integer The page number to retrieve. sorts No Array<Sort_Condition> The sort conditions. keyword No String The keyword used for fuzzy matching. name No String The name of the user, used for fuzzy matching of the first name and last name, case-insensitive. email No String The email address, used for fuzzy matching, case-insensitive. company No String The company name, used for fuzzy matching, case-insensitive.
- Sort_Condition
-
Parameter Required Type Description property No String The name of the field to sort by. direction No String The sort order. Valid value:
asc: Sort in ascending order.desc: Sort in descending order.
Response parameters
| Parameter | Type | Description |
|---|---|---|
| requestId | String | The unique ID of the request, which can be used to quickly locate the request. |
| code | String | The HTTP status code of the request.
|
| message | String | The status message of the request. |
| detailMessage | String | The detailed error information. When the request is successful, this parameter returns empty. |
| result | Object<Syncable_Account_Page_Result> | The search result of syncable accounts. |
- Syncable_Account_Page_Result
-
Parameter Type Description pageSize Integer The number of records per page. pageNumber Integer The current page number. total Integer The total number of records that match the search conditions. results Array<Syncable_Account> The list of accounts that can be synchronized. totalPages Integer The total number of pages. empty Boolean Whether the current page is empty.
- Syncable_Account
-
Parameter Type Description ppAccountId String The PP user ID, which is the same as the NovoOne user ID. It identifies the account in synchronization operations. status String The status of the account obtained from PP:
ACTIVEINACTIVE
firstName String The first name of the user. lastName String The last name of the user. email String The email address of the account, which is used as the login username. company String The company name.