List members (Paginated)

GET

/v2.1/members

GET

/v2.1/members

$ curl https://api.sigmacomputing.com/v2.1/members \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "entries": [
3     {
4       "organizationId": "org-9f8b7c6d5e4a3b2c1d0e",
5       "memberId": "mem-1234567890abcdef",
6       "memberType": "admin",
7       "firstName": "Alice",
8       "lastName": "Johnson",
9       "email": "alice.johnson@example.com",
10       "profileImgUrl": "https://cdn.sigmacomputing.com/profiles/alicejohnson.png",
11       "createdBy": "admin-0987654321fedcba",
12       "updatedBy": "admin-0987654321fedcba",
13       "createdAt": "2024-01-15T09:30:00Z",
14       "updatedAt": "2024-04-10T14:45:00Z",
15       "homeFolderId": "folder-abcdef1234567890",
16       "userKind": "internal",
17       "isArchived": false,
18       "isInactive": false
19     }
20   ],
21   "nextPage": "page_2_token_abc123",
22   "total": 25,
23   "hasMore": false
24 }

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.

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

limitdoubleOptional

searchstringOptional

emailstringOptional

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.

totaldouble

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

hasMoreboolean

[Deprecated] Indicates whether more results are available.