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

Summary of Content

Endpoints
The Team Object
      Attributes
List all Teams
      Permissions 
      Parameters
      cURL Request
      Response
      Example
Look up a Team
      Permissions 
      Parameters
      cURL Request
      Response
      Example
Related Resources

Endpoints

GET /v2/teams

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

GET /v2/teams/{teamId}

      Returns a team object based on its unique identifier, teamId. Learn more.

      Try it in Swagger

The Team Object

Attributes

teamId string

The team’s unique identifier.

name string

The team name.

description string

A description of the team, as defined by an organization team.

createdBy string

The unique identifier, memberId, of the organization member who created the team.

updatedBy string

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

createdAt string

The timestamp at which the team was created.

updatedAt string

The timestamp at which the team was last updated.

IsArchived boolean | undefined

True if the team is archived.

{
    "teamId": "88858466-5299-4425-95c0-4b7d93268bae",
    "name": "Sales US–West",
    "description": "All Sales employees in the Western US region.",
    "createdBy": "6VZszXPJqLXpIezcD5adESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezcD5adESnwfPPUg",
    "createdAt": "2021-10-07T19:43:01.778Z",
    "updatedAt": "2021-10-07T19:43:01.778Z",
}

 

List all Teams

Returns a list of teams in your organization.

GET /v2/teams

Try it in Swagger

 

Permissions 

  • The user account associated with the API access token must have access to view team details. Unless configured otherwise, 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/teams \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Response

Returns Array<Team>.

Array<{
    "teamId": string,
    "createdBy": string,
    "updatedBy": string,
    "createdAt": string,
    "updatedAt": string,
    "name": string,
    "description": string | null
}>

 

Example

Example Request:

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

 

Example Response:

[
 {
    "teamId": "22340501-5fda-4000-8000-000000000001",
    "createdBy": "6VZszXPJqLXpIezcD5adESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezcD5adESnwfPPUg",
    "createdAt": "2021-10-04T20:36:40.591Z",
    "updatedAt": "2021-10-04T20:36:40.591Z",
    "name": "All Members",
   "description": null
 },
 {
    "teamId": "88858466-5299-4425-95c0-4b7d93268bae",
    "createdBy": "6VZszXPJqLXpIezcD5adESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezcD5adESnwfPPUg",
    "createdAt": "2021-10-07T19:43:01.778Z",
    "updatedAt": "2021-10-07T19:43:01.778Z",
    "name": "Sales US–West",
    "description": "All Sales employees in the  Western US region."
 }
]

 

Look up a Team

Returns a team object based on its unique identifier, teamId.

GET /v2/teams/{teamId}

Try it in Swagger

Permissions 

  • The user account associated with the API access token must have access to view team details. Unless configured otherwise, 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/teams/{teamId} \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \

 

Response

Returns a team object.

{
    "teamId": string,
    "createdBy": string,
    "updatedBy": string,
    "createdAt": string,
    "updatedAt": string,
    "name": string,
    "description": string | null
}


Example

Example Request:

curl --location --request GET 'https://api.sigmacomputing.com/v2/teams/22340501-5fda-4000-8000-000000000001' \
--header 'Authorization: Bearer {access_token}' \
--header 'Content-Type: application/json' \


Example Response:

{
    "teamId": "22340501-5fda-4000-8000-000000000001",
    "createdBy": "6VZszXPJqLXpIezcD5adESnwfPPUg",
    "updatedBy": "6VZszXPJqLXpIezcD5adESnwfPPUg",
    "createdAt": "2021-10-04T20:36:40.591Z",
    "updatedAt": "2021-10-04T20:36:40.591Z",
    "name": "All Members",
   "description": null
}

 

Related Resources

API Documentation

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

Product Documentation

People & Teams