Skip to main content
GET
/
organizations
/
{organization}
/
service-tokens
List service tokens
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/service-tokens \
  --header 'Authorization: Bearer <token>'
{
  "type": "<string>",
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "display_name": "<string>",
      "avatar_url": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "expires_at": "<string>",
      "last_used_at": "<string>",
      "actor_id": "<string>",
      "actor_display_name": "<string>",
      "actor_type": "<string>",
      "token": "<string>",
      "plain_text_refresh_token": "<string>",
      "service_token_accesses": [
        {
          "id": "<string>",
          "access": "<string>",
          "description": "<string>",
          "resource_name": "<string>",
          "resource_id": "<string>",
          "resource_type": "<string>",
          "resource": {
            "id": "<string>",
            "name": "<string>",
            "created_at": "<string>",
            "updated_at": "<string>",
            "deleted_at": "<string>"
          }
        }
      ],
      "oauth_accesses_by_resource": {
        "database": {
          "databases": [
            {
              "name": "<string>",
              "id": "<string>",
              "organization": "<string>",
              "url": "<string>"
            }
          ],
          "accesses": [
            {
              "name": "<string>",
              "description": "<string>"
            }
          ]
        },
        "organization": {
          "organizations": [
            {
              "name": "<string>",
              "id": "<string>",
              "url": "<string>"
            }
          ],
          "accesses": [
            {
              "name": "<string>",
              "description": "<string>"
            }
          ]
        },
        "branch": {
          "branches": [
            {
              "name": "<string>",
              "id": "<string>",
              "database": "<string>",
              "organization": "<string>",
              "url": "<string>"
            }
          ],
          "accesses": [
            {
              "name": "<string>",
              "description": "<string>"
            }
          ]
        },
        "user": {
          "users": [
            {
              "name": "<string>",
              "id": "<string>"
            }
          ],
          "accesses": [
            {
              "name": "<string>",
              "description": "<string>"
            }
          ]
        }
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://planetscale.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
organization
string
required

The name of the organization

Query Parameters

​
page
integer
default:1

If provided, specifies the page offset of returned results

​
per_page
integer
default:25

If provided, specifies the number of returned results

Response

Returns the organization's service tokens

​
type
string
required

The response type. Always "list" for paginated responses.

​
current_page
integer
required

The current page number

​
next_page
integer | null
required

The next page number, or null when this is the last page

​
next_page_url
string | null
required

The next page of results, or null when this is the last page

​
prev_page
integer | null
required

The previous page number, or null when this is the first page

​
prev_page_url
string | null
required

The previous page of results, or null when this is the first page

​
data
object[]
required