Qodex.ai

Member search with search terms highlighted

GET {{baseUrl}}/.api/api.svc/search/members?q=&rows=&page=&hl=&groupIds=

This endpoint searches through your digital workplace for the members you specify and displays information about them.

Request Params

KeyDatatypeRequiredDescription
qnull(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}}
rowsnullInteger

The number of results to return.

Default: 10 | | page | null | | Integer

The page number to begin at for returned results.

Default: 1 | | hl | null | | Boolean

If true, the call returns HTML formatted results with the query keywords bolded. | | groupIds | null | | String (UUID) 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 |

HEADERS

KeyDatatypeRequiredDescription
AcceptstringThe type of response data to request. By default this endpoint will respond with XML.

The options are:

  • application/json
  • application/xml |

RESPONSES

status: OK

{"minRequestPeriod":0,"requestSupportCode":637780472584108017,"dictionary":null,"response":{"__type":"namevalue:http://schemas.iglooplatform.com/Igloo.Old.Common","name":"results","value":{"__type":"SearchResults:http://schemas.iglooplatform.com/Igloo.Old.Common","count":1,"facets":[],"hit":[{"__type":"ExtendedMemberHit:#Igloo.Old.Common.Search","hasImage":false,"id":"{{$randomUUID}}","namespace":"{{$randomFirstName}}","Highlights":[],"email":"{{$randomEmail}}","name":{"firstName":"{{$randomFirstName}}","lastName":"{{$randomLastName}}","fullName":"{{$randomLastName}}","initials":"{{$randomNameSuffix}}"}}]}}}