GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
roles
List roles
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/roles \
  --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

Path Parameters

​
organization
string
required

The name of the organization that owns this resource

​
database
string
required

The name of the database that owns this resource

​
branch
string
required

The name of the branch that owns this resource

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

Returns roles

​
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