SearchParameters

data class SearchParameters @JvmOverloads constructor(val cursor: String? = null, val limit: Int? = null, val query: Organization.OrganizationMembers.SearchQuery? = null)

Data class used for wrapping the parameters necessary to search members

Constructors

Link copied to clipboard
constructor(cursor: String? = null, limit: Int? = null, query: Organization.OrganizationMembers.SearchQuery? = null)

Properties

Link copied to clipboard
val cursor: String? = null

The cursor field allows you to paginate through your results. Each result array is limited to 1000 results. If your query returns more than 1000 results, you will need to paginate the responses using the cursor. If you receive a response that includes a non-null next_cursor in the results_metadata object, repeat the search call with the next_cursor value set to the cursor field to retrieve the next page of results. Continue to make search calls until the next_cursor in the response is null.

Link copied to clipboard
val limit: Int? = null

The number of search results to return per page. The default limit is 100. A maximum of 1000 results can be returned by a single search request. If the total size of your result set is greater than one page size, you must paginate the response. See the cursor field.

Link copied to clipboard

The optional query object contains the operator, i.e. AND or OR, and the operands that will filter your results. Only an operator is required. If you include no operands, no filtering will be applied. If you include no query object, it will return all Members with no filtering applied.