Search for user | Search for group
GET {{baseUrl}}/v1/members?where_type=-11141396&limit=-11141396&page=-11141396&sort=aliquip aute&query=aliquip aute&fields=aliquip aute&expand=aliquip aute&expand_fields=aliquip aute&suppress_response_codes=irure labore Duis dolor ea
Search for a user or group
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
where_type | number | Specify 0 for a user, and 1 for a group | |
limit | number | Page size | |
page | number | Page number | |
sort | string | Order by named column (Using prefixes such as sort=asc_name or sort=desc_name ). Format can be sort = id, sort = name, sort = first_name, sort = last_name, sort = group_id, sort = mailaddress. If the prefix of asc or desc is not used then asc will be assumed. | |
query | string | Filters the results, returning the users with the specified query string in their log-in name, lastname or firstname | |
fields | string | Exclude all fields except the one(s) that are specified (e.g. fields=data&fields=definitions). | |
expand | string | Expand all fields that belong to the specified persona (e.g. expand=node&expand=member). | |
expand_fields | string | Expand specified field. Note: field must belong to a persona (e.g. expand_fields=id&expand_fields=owner_user_id). | |
suppress_response_codes | string | Forces the server to always return a HTTP Response of '200 OK'. The data returned from the call will have an additional integer feature named 'statusCode', which will contain the actual status code (the 'statusCode' feature will be added regardless of whether the REST API call was successful or not).<br><br>NOTE: This parameter does not require a value, so it should be specified as <ul><li><b>[Query String]:</b><code>?suppress_response_codes</code></li><li><b>[Form Body (where the value is an empty string)]</b>: <code>suppress_response_codes = </code></li></ul> |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"id":80891856,"name":"ut non Excepteur","first_name":"ullamco","last_name":"consectetur","type":"in","name_formatted":"aliqua","initials":"adipisicing consequat Lorem in"},{"id":96556572,"name":"nulla minim ad","first_name":"quis qui pariatur","last_name":"deserunt","type":"ali","name_formatted":"consequat ut ad aliqua mollit","initials":"eiusmod c"}]}