curl --request GET \
--url https://api.planetscale.com/v1/organizations/{organization}/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
}
]
}A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
Service Token Accesses
read_organization
OAuth Scopes
| Resource | Scopes |
|---|---|
| Organization | read_organization |
curl --request GET \
--url https://api.planetscale.com/v1/organizations/{organization}/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
}
]
}The name of the organization
Search term to filter teams by name
Returns teams in the organization
The current page number
The next page number
The next page of results
The previous page number
The previous page of results
Show child attributes
The ID of the team
The display name of the team
Show child attributes
The ID of the user
The display name of the user
The name of the user
The email of the user
The URL source of the user's avatar
When the user was created
When the user was last updated
Whether or not the user has configured two factor authentication
Show child attributes
The ID for the resource
The name for the resource
When the resource was created
When the resource was last updated
When the resource was deleted, if deleted
Whether or not the user is managed by SSO
Whether or not the user is managed by an authentication provider
Whether or not the user is managed by a SSO directory
Whether or not the user is verified by email
Show child attributes
The name of the team
The slug of the team
When the team was created
When the team was last updated
The description of the team
Whether the team is managed through SSO/directory services
Was this page helpful?