Search for user | Search for group
GET {{baseUrl}}/v2/members?where_type=-11141396&where_business_email=aliquip aute&where_name=aliquip aute&where_first_name=aliquip aute&where_last_name=aliquip aute&limit=-11141396&page=-11141396&sort=aliquip aute&query=aliquip aute&expand=aliquip aute&fields=aliquip aute&metadata=true&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 | |
where_business_email | string | Filters the results, returning the users where the business email matches the specified string | |
where_name | string | Filters the results, returning the users where the login name matches the specified string | |
where_first_name | string | Filters the results, returning the users where the first name matches the specified string | |
where_last_name | string | Filters the results, returning the users where the last name matches the specified string | |
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 any of the following fields: name, first_name, last_name, business_email. <br> NOTE: query cannot be used together with any combination of: where_name, where_first_name, where_last_name, where_business_email. | |
expand | string | Resolve individual fields (e.g. expand=properties{id,parent_id}&expand=versions{file_name}) or entire sections (eg. expand=properties) that contain known identifiers (nodes, members, etc.). | |
fields | string | Filter the response by returning only the specified individual fields or sections (e.g. fields=properties{id, parent_id}&fields=versions). If the data structure is an array, a specific item can be retrieved instead (e.g. versions{mime_type}.element(0)). | |
metadata | boolean | Returns metadata (data type, field length, min/max values, etc.) about data. This is an empty parameter, thus no value is required (e.g. ?metadata). | |
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
{"collection":[{"paging":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"sorting":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"paging":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}],"sorting":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}],"results":[{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}],"links":[{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]},{"data":[{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"},{"value":"\u003cError: Too many levels of nesting to fake this schema\u003e"}]}]}