Skip to main content
GET
/
organizations
/
{organization_name}
/
teams
List teams in an organization
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization_name}/teams \
  --header 'Authorization: <api-key>'
{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "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>"
        }
      ],
      "name": "<string>",
      "slug": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "description": "<string>",
      "managed": true
    }
  ]
}

Authorizations

Authorization
string
header
required

Path Parameters

organization_name
string
required

The name of the organization

Query Parameters

q
string

Search term to filter teams by name

Response

Returns teams in the organization

current_page
number
required

The current page number

next_page
number
required

The next page number

next_page_url
string
required

The next page of results

prev_page
number
required

The previous page number

prev_page_url
string
required

The previous page of results

data
object[]
required