---
title: "List members (Paginated)"
method: GET
path: "/v2.1/members"
tags: ["Members"]
---

# List members (Paginated)

`GET /v2.1/members`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2.1/members`
- Auth: HTTP bearer

**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`.

## Query parameters

- `page` string
- `limit` number, double
- `email` string
- `includeArchived` boolean
- `includeInactive` boolean

## Response `200`

The response body.

- MembersV21ListMembersResponse200
  - `entries` V21MembersGetResponsesContentApplicationJsonSchemaEntriesItems[], required: Array of results returned by the endpoint
    - `organizationId` string, required
    - `memberId` string, required
    - `memberType` string, required
    - `firstName` string, required
    - `lastName` string, required
    - `email` string, required
    - `profileImgUrl` string, nullable, required
    - `createdBy` string, required
    - `updatedBy` string, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
    - `homeFolderId` string, required: ID of the My Documents folder for the user
    - `userKind` string, required
    - `language` 'DE_DE' | 'EN' | 'EN_AU' | 'EN_CA' | 'EN_GB' | 'EN_IE' | 'ES_ES' | 'ES_MX' | 'FR_CA' | 'FR_FR' | 'IT_IT' | 'JA_JA' | 'KO_KR' | 'NL_NL' | 'PL_PL' | 'PT_BR' | 'PT_PT' | 'RU_RU' | 'SV_SE' | 'TH_TH' | 'TR_TR' | 'ZH_CN' | 'ZH_TW': The user's preferred display language. (Beta)
    - `formatRegion` 'AU' | 'BR' | 'CA' | 'CN' | 'DE' | 'ES' | 'FR' | 'GB' | 'IE' | 'IT' | 'JP' | 'KR' | 'MX' | 'NL' | 'PL' | 'PT' | 'RU' | 'SE' | 'TH' | 'TR' | 'TW' | 'US': Controls number, date, and currency formatting for the user, following the conventions of the specified region. (Beta)
    - `isArchived` boolean: Whether a user is deactivated in Sigma.
    - `isInactive` boolean: Whether a user is archived by SCIM.
  - `nextPage` string, 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`.
  - `total` number, double: Total number of results. Useful to determine if there is a need to paginate.
  - `hasMore` boolean: **[Deprecated]** Indicates whether more results are available.

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)