interface
Source: index.ts ↗
IWorkspaceUsersQueryOptions
Configuration options for querying users
export interface IWorkspaceUsersQueryOptions
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
number | (Optional) Specify number of items per page. | ||
number | (Optional) Specify (zero-based) starting offset for the paged results. | ||
string | (Optional) Structured prefix filter - disjunctions are separated by colon (’,’) - conjunctions are separated by space (’ ‘) - basic form match, if it matches as prefix to any of firstName, lastName and email |
Property details
IWorkspaceUsersQueryOptions.limitproperty
Specify number of items per page.
limit?: number;
Remarks
Default value is 1000
IWorkspaceUsersQueryOptions.offsetproperty
Specify (zero-based) starting offset for the paged results.
offset?: number;
IWorkspaceUsersQueryOptions.searchproperty
Structured prefix filter - disjunctions are separated by colon (’,’) - conjunctions are separated by space (’ ‘) - basic form match, if it matches as prefix to any of firstName, lastName and email
search?: string;