Sigma REST APIMembersList members

List members (Paginated)

View as Markdown
**Attention:** This API endpoint uses pagination by default. List all users in Sigma. ### Usage notes - Filter your results using the `email` query parameter. - If using `email` to filter by email address, you must URL encode the "@" character as `%40`. - **[Deprecated]** Using the `search` parameter is deprecated. If using `search` to filter by email address, you must URL encode the "@" character as `%40`. - Using `email` and `search` together is not supported.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Query parameters

pagestringOptional
Use to specify further pages using the string returned in the nextPage portion of the response.
limitdoubleOptional

Number of results to return per page, with a maximum of 1,000 per request. Use the page option in subsequent requests to retrieve the next set of results.

searchstringOptional

[Deprecated] Use the email query parameter instead.

emailstringOptional

Filter by email address. You must URL encode the ”@” character as %40.

includeArchivedbooleanOptional
includeInactivebooleanOptional

Response

The response body.
entrieslist of objects
Array of results returned by the endpoint
nextPagestring or null

Returns a string that can be used as the page parameter in the next request to fetch the next page of results. The last page of results returns null.

totaldoubleOptional
Total number of results. Useful to determine if there is a need to paginate.
hasMorebooleanOptional

[Deprecated] Indicates whether more results are available.