The following article covers Sigma’s developer API for organization members. 

Summary of Content

Endpoints
The Member Object
      Attributes
List all Organization Members
      Permissions 
      Parameters
      cURL Request
      Response
      Example
Look up an Organization Member
      Permissions 
      Parameters
      cURL Request
      Response
      Example
Related Resources

Endpoints

GET /v2/members

      Returns a list of members in your organization. Learn more.
      Try it in Swagger

GET /v2/members/{memberId}

      Returns a member object based on its unique identifier, memberId. Learn more.
      Try it in Swagger

The Member Object

Attributes

organizationId string

The organization’s unique identifier.

memberId string

The member’s unique identifier.

memberType string

“admin” | “author” | “creator” | “explorer” | “viewer” | <custom-account-type>

firstName string

The first name listed on the member’s account.

lastName string

The last name listed on the member’s account.

email string

The email address associated with the member’s account.

profileImgUrl string | null

A url path to the member’s saved profile image. This value remains Null if the user does not have a custom profile image.

createdBy string

The unique identifier, memberId, of the member who created the account either through invite or signup.

updatedBy string

The unique identifier, memberId, of the member who last made changes to the account.

createdAt string

The timestamp at which the account was created.

updatedAt string

The timestamp at which the account was last updated.

IsArchived boolean | undefined

True if the member is archived.

 {
    "organizationId": "cf2de26e-9a2c-4c58-ba1c-91a0955df7ez",
    "memberId": "7xtVWXPJqLptLezceRadESnwfttOP",
    "memberType": "creator",
    "firstName": "Anna",
    "lastName": "Jacobs",
    "email": "anna_jocabs@myawesomecompany.com",
"profileImgUrl": "https://img-c2.sigmacomputing.com/cf2de26e-9a2c-4c58-ba1c-91a0955df7ee/7a8709c2-37dd-4171-a9a5-a9e33gt0da55",
    "createdBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "createdAt": "2021-10-04T20:36:41.044Z",
    "updatedAt": "2021-10-08T21:38:25.044Z"
  }

 

List all Organization Members

Returns a list of members in your organization.

Does not include pending invites.

GET /v2/members

Try it in Swagger

Permissions 

  • The user account associated with the API access token must have access to view organization members. Only Admins have this level of access.
    Note: If you encounter a permission error for the given endpoint, check with your organization Admin to verify your account type and permissions associated with your API token.

Parameters

None

cURL Request

curl --location --request GET 'https://api.sigmacomputing.com/v2/members' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Response

Returns Array<Member>.

Array<{
   "organizationId": string
    "memberId": string
    "memberType": "admin" | "creator" | "explorer" | "viewer" | string,
    "firstName": string
    "lastName": string
    "email": string
    "profileImgUrl": string | null,
    "createdBy": string
    "updatedBy": string
    "createdAt": string,
    "updatedAt": string,
    "isArchived": boolean | undefined
}>

 

Example

Example Request:

curl --location --request GET 'https://api.sigmacomputing.com/v2/members' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Example Response:

[
 {
    "organizationId": "cf2de26e-9a2c-4c58-ba1c-91a0955df7ez",
    "memberId": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "memberType": "admin",
    "firstName": "Paul",
    "lastName": "Sudds",
    "email": "paul_Sudds@myawesomecompany.com",
"profileImgUrl": "https://img-c2.sigmacomputing.com/rtE6e26e-9a2c-4c58-ba1c-91a0955df7ee/787g6409c2-37dd-4171-a9a5-a9e33gt89ry5o",
    "createdBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "createdAt": "2021-08-07T11:26:41.044Z",
    "updatedAt": "2021-09-23T21:38:25.044Z"
},
  {
    "organizationId": "cf2de26e-9a2c-4c58-ba1c-91a0955df7ez",
    "memberId": "7xtVWXPJqLptLezceRadESnwfttOP",
    "memberType": "creator",
    "firstName": "Anna",
    "lastName": "Jacobs",
    "email": "anna_jocabs@myawesomecompany.com",
"profileImgUrl": "https://img-c2.sigmacomputing.com/cf2de26e-9a2c-4c58-ba1c-91a0955df7ee/7a8709c2-37dd-4171-a9a5-a9e33gt0da55",
    "createdBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "createdAt": "2021-10-04T20:36:41.044Z",
    "updatedAt": "2021-10-08T21:38:25.044Z"
  },
   ...
]

 

Look up an Organization Member

Returns a member object based on its unique identifier, memberId.

GET /v2/members/{memberId}

Try it in Swagger

 

Permissions 

  • The user account associated with the API access token must have access to view organization members. Only Admins have this level of access.
    Note: If you encounter a permission error for the given endpoint, check with your organization Admin to verify your account type and permissions associated with your API token.

Parameters

None

cURL Request

curl --location --request GET 'https://api.sigmacomputing.com/v2/members/{memberId} \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Response

Returns a member object.

{
   "organizationId": string
    "memberId": string
  "memberType": "admin" | "creator" | "explorer" | "viewer" | string,
    "firstName": string
    "lastName": string
    "email": string
    "profileImgUrl": string | null,
    "createdBy": string
    "updatedBy": string
    "createdAt": string,
    "updatedAt": string,
    "isArchived": boolean | undefined
}

 

Example

Example Request:

curl --location --request GET 'https://api.sigmacomputing.com/v2/members/cf2de26e-9a2c-4c58-ba1c-91a0955df7ez \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \


Example Response:

{
    "organizationId": "cf2de26e-9a2c-4c58-ba1c-91a0955df7ez",
    "memberId": "7xtVWXPJqLptLezceRadESnwfttOP",
    "memberType": "creator",
    "firstName": "Anna",
    "lastName": "Jacobs",
    "email": "anna_jocabs@myawesomecompany.com",
"profileImgUrl": "https://img-c2.sigmacomputing.com/cf2de26e-9a2c-4c58-ba1c-91a0955df7ee/7a8709c2-37dd-4171-a9a5-a9e33gt0da55",
    "createdBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezceRadESnwfPPUg",
    "createdAt": "2021-10-04T20:36:41.044Z",
    "updatedAt": "2021-10-08T21:38:25.044Z",
"isArchived": false
}

 

Related Resources

API Documentation

Get Started with Sigma's API
Create an API Token and Client Id

Product Documentation

People & Teams