Skip to main content
POST
/
organizations
/
{organization}
/
teams
/
{team}
/
members
Add a member to a team
curl --request POST \
  --url https://api.planetscale.com/v1/organizations/{organization}/teams/{team}/members \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user_id": "<string>"
}
'
{
  "id": "<string>",
  "user": {
    "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
  },
  "actor": {
    "id": "<string>",
    "display_name": "<string>",
    "avatar_url": "<string>"
  },
  "created_at": "<string>",
  "updated_at": "<string>",
  "passwords": [
    {
      "id": "<string>",
      "name": "<string>",
      "role": "reader",
      "cidrs": [
        "<string>"
      ],
      "created_at": "<string>",
      "deleted_at": "<string>",
      "expires_at": "<string>",
      "last_used_at": "<string>",
      "expired": true,
      "direct_vtgate": true,
      "direct_vtgate_addresses": [
        "<string>"
      ],
      "ttl_seconds": 123,
      "access_host_url": "<string>",
      "access_host_regional_url": "<string>",
      "access_host_regional_urls": [
        "<string>"
      ],
      "actor": {
        "id": "<string>",
        "display_name": "<string>",
        "avatar_url": "<string>"
      },
      "region": {
        "id": "<string>",
        "provider": "<string>",
        "enabled": true,
        "public_ip_addresses": [
          "<string>"
        ],
        "display_name": "<string>",
        "location": "<string>",
        "slug": "<string>",
        "current_default": true
      },
      "username": "<string>",
      "plain_text": "<string>",
      "replica": true,
      "renewable": true,
      "database_branch": {
        "name": "<string>",
        "id": "<string>",
        "production": true,
        "mysql_edge_address": "<string>",
        "private_edge_connectivity": true
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Path Parameters

organization
string
required

The name of the organization

team
string
required

The slug of the team

Body

application/json
user_id
string
required

The ID of the organization member to add to the team

Response

Returns the created team membership

id
string
required

The ID of the team membership

user
object
required
actor
object
required
created_at
string
required

When the membership was created

updated_at
string
required

When the membership was last updated

passwords
object[]
required