Teams API

Overview

The Teams API lets you list and create the teams your account belongs to. Use the returned id values as teamId in other API endpoints such as Apps and Environments.

---

GET /v1/teams

Returns all teams the authenticated user belongs to. On Community Edition (self-hosted) instances only the default (personal) team is returned; Enterprise Edition instances return all teams.

Base URL: https://api.stormkit.io

Authentication: User-level API key passed as the Authorization header. To generate one: Profile → Account → API Keys.

Response — 200 OK

Field	Type	Description
teams	Team[]	Array of team objects.

Team object:

Field	Type	Description
id	string	Unique team ID. Use this as teamId in other endpoints.
name	string	Human-readable team name.
slug	string	URL-friendly team identifier. Unique within the response; suffixed with -id when two teams share the same slug.
isDefault	boolean	true for the personal (default) team automatically created with the account.
currentUserRole	string	Role of the authenticated user in this team: owner, admin, or developer.

Error responses

Status	Condition
403	Missing or invalid API key.
500	Internal server error.

Example

curl -X GET \
     -H 'Authorization: <user_api_key>' \
     'https://api.stormkit.io/v1/teams'

// Example response
{
  "teams": [
    {
      "id": "7",
      "name": "Personal",
      "slug": "personal",
      "isDefault": true,
      "currentUserRole": "owner"
    },
    {
      "id": "42",
      "name": "Acme Corp",
      "slug": "acme-corp",
      "isDefault": false,
      "currentUserRole": "admin"
    }
  ]
}

---

POST /v1/teams

Creates a new team owned by the authenticated user, who is added as its owner. Creating teams is an Enterprise Edition capability — Community Edition instances only ever have the default (personal) team.

Base URL: https://api.stormkit.io

Authentication: User-level API key passed as the Authorization header. To generate one: Profile → Account → API Keys.

Request body

Field	Type	Required	Description
name	string	Yes	Human-readable team name. The slug is derived from it.

Response — 201 Created

Field	Type	Description
team	Team	The newly created team.

The Team object has the same shape as in GET /v1/teams.

Error responses

Status	Condition
400	Missing name, or the per-user team limit has been reached.
402	The license is not Enterprise Edition.
403	Missing or invalid API key, or the key scope is below user level.
500	Internal server error.

Example

curl -X POST \
     -H 'Authorization: <user_api_key>' \
     -H 'Content-Type: application/json' \
     -d '{"name":"Acme Corp"}' \
     'https://api.stormkit.io/v1/teams'

// Example response
{
  "team": {
    "id": "42",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "isDefault": false,
    "currentUserRole": "owner"
  }
}