SIsigmacomputing
Members

List members (Paginated)

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.
get/v2.1/members

Request

  • Base URL
    https://api.sigmacomputing.com
  • Auth
    HTTP bearer

Query parameters

pagestring

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

limitnumber double

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.

emailstring

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

includeArchivedboolean
includeInactiveboolean

Response

The response body.

nextPagestring nullable required

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.

totalnumber double

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

hasMoreboolean

[Deprecated] Indicates whether more results are available.

Changes

No recorded changes to this operation across all 1 revision of this API.