Skip to main content
POST
/
organizations
/
{organization}
/
teams
Create an organization team
curl --request POST \
  --url https://api.planetscale.com/v1/organizations/{organization}/teams \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "display_name": "<string>",
  "creator": {
    "id": "<string>",
    "display_name": "<string>",
    "avatar_url": "<string>"
  },
  "members": [
    {
      "id": "<string>",
      "display_name": "<string>",
      "name": "<string>",
      "email": "<string>",
      "avatar_url": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "two_factor_auth_configured": true,
      "default_organization": {
        "id": "<string>",
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "deleted_at": "<string>"
      },
      "sso": true,
      "managed": true,
      "directory_managed": true,
      "email_verified": true
    }
  ],
  "databases": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "branches_url": "<string>"
    }
  ],
  "analyst_databases": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "branches_url": "<string>"
    }
  ],
  "name": "<string>",
  "slug": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "description": "<string>",
  "managed": true
}

Documentation Index

Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
organization
string
required

The name of the organization

Body

application/json
​
name
string
required

The name of the team

​
description
string

A description of the team's purpose

Response

Returns the created team

​
id
string
required

The ID of the team

​
display_name
string
required

The display name of the team

​
creator
object
required
​
members
object[]
required
​
databases
object[]
required
​
analyst_databases
object[]
required
​
name
string
required

The name of the team

​
slug
string
required

The slug of the team

​
created_at
string
required

When the team was created

​
updated_at
string
required

When the team was last updated

​
description
string | null
required

The description of the team

​
managed
boolean
required

Whether the team is managed through SSO/directory services