Skip to main content
POST
/
teams
Create team
curl --request POST \
  --url https://api.vantage.sh/v2/teams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "workspace_tokens": [
    "<string>"
  ],
  "user_tokens": [
    "<string>"
  ],
  "user_emails": [
    "<string>"
  ],
  "role": "owner"
}
'
{
  "token": "team_8467157535a30221",
  "name": "New Team",
  "description": "New Team Description",
  "workspace_tokens": [
    "wrkspc_52b6e5e663b4cde1"
  ],
  "user_tokens": [
    "usr_a00e614b5843c234"
  ]
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Create a new Team.

​
name
string
required

The name of the Team.

​
description
string

The description of the Team.

​
workspace_tokens
string[]

The Workspace tokens to associate to the Team.

​
user_tokens
string[]

The User tokens to associate to the Team.

​
user_emails
string[]

The User emails to associate to the Team.

​
role
enum<string>

The role to assign to the provided Users. Defaults to 'editor' which has editor permissions.

Available options:
owner,
editor,
viewer

Response

Team model

​
token
string
​
name
string

The name of the Team.

Example:

"Cost Savers"

​
description
string

The description of the Team.

Example:

"The Team that saves costs"

​
workspace_tokens
string[]

The tokens for any Workspaces that the Team belongs to

​
user_emails
string[]

The email addresses for Users that belong to the Team

​
user_tokens
string[]

The tokens for Users that belong to the Team