Search Users

post

{protocol}://{server}:{port}{basePath}/v1beta/accounts/{accountId}/users:search

This API requires the Account Administrator role.

Searches the user list based on criteria provided.

This data includes basic details of each user and available features including current status for features operation progress.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

Query Params

pageNumber

int32

≥ 1

Defaults to 1

The page number of the records to retrieve. Default value is 1.

pageSize

int32

5 to 50

Defaults to 10

The max number of records to retrieve per page. Default value is 10.

Body Params

The possible fields you can filter and order are userId,loginId,lastName,firstName,emailId,organizationNodeId,profileId

Filter criteria of request

filter

array of objects

length ≤ 50

Specifies details of a row filter. The possible fields you can filter are needs to be supplied as mentioned in description.

filter

orderBy

string

length ≤ 255

Field name on which sorting needs to be performed. The possible fields you can filter are needs to be supplied as mentioned in description.
Field Names are case-sensitive (should be written as it is in description).
The default sorting order is ascending.
To specify descending order, a suffix " desc" should be added. For example, "firstName" for ascending or "firstName asc" for descending".

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200OK

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

500Request processing failed