Member search
GET {{baseUrl}}/.api2/api/v{{apiVersion}}/communities/:communityKey/search/membersDetailed?query=
api/v{apiVersion:version}/communities/{communityKey:long}/search/membersDetailed
Request Params
| Key | Datatype | Required | Description |
| query | null | | (Required)
String
The search query string. This can contain user email addresses, names, or a comma separated list of user IDs. To return all members of the digital workplace, use * as the query parameter.
Examples:
{{$randomFirstName}} {{$randomLastName}}{{$randomExampleEmail}}{{$randomUUID}},{{$randomUUID}},{{$randomUUID}}| |groupIds| null | | String (GUID)
A comma separated list of member group GUIDs. If this parameter is provided, only users in the specified groups will be returned.
Examples:
{{$randomUUID}}{{$randomUUID}},{{$randomUUID}}
Default: Searches all user groups |
| memberSearchType | null | | String
A comma separated list of the fields to search.
Examples:
- name
- namespace
- profile
- occupation
Default: All |
| offset | null | | Integer
The index at which to start results for pagination. If more results are returned than the limit parameter allows, the offset can be used to return the next page of results in a second call.
For example, if the limit is set to 10, to return the second page of results, the offset should be 10, meaning the returned results will begin with the tenth result.
Default: 0 |
| limit | null | | Integer
The number of results to return per call.
Default: 10 |
HEADERS
| Key | Datatype | Required | Description |
| Cookie | string | | |
| Accept | string | | |
RESPONSES
status: ``