List organizations

curl --request GET \
  --url https://api.planetscale.com/v1/organizations \
  --header 'Authorization: <api-key>'

{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {}
  ]
}

Organizations

List organizations

When using a service token, returns the list of organizations the service token has access to. When using an OAuth token, returns the list of organizations the user has access to.

Authorization

A OAuth token must have at least one of the following scopes in order to use this API endpoint:

OAuth Scopes

Resource	Scopes
User	`read_organizations`

GET

organizations

List organizations

curl --request GET \
  --url https://api.planetscale.com/v1/organizations \
  --header 'Authorization: <api-key>'

{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {}
  ]
}

Authorizations

Authorization

string

header

required

Query Parameters

page

number

default:1

If provided, specifies the page offset of returned results

per_page

number

default:25

If provided, specifies the number of returned results

Response

Gets the organizations for the current user

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

Create or renew an OAuth token

Get an organization

Introduction

Webhooks in PlanetScale

Authentication

PlanetScale API

List organizations

Authorization

Authorizations

Query Parameters

Response