v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB

Organizations

Get an organization

Authorization

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
User	read_organizations
Organization	read_organization

get/organizations/{organization}

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

Response

Returns an organization

idstring required

The ID for the organization

namestring required

The name of the organization

billing_emailstring required

The billing email of the organization

created_atstring required

When the organization was created

updated_atstring required

When the organization was last updated

planstring required

The billing plan of the organization

valid_billing_infoboolean required

Whether or not the organization's billing information is valid

ssoboolean required

Whether or not SSO is enabled on the organization

sso_directoryboolean required

Whether or not the organization uses an SSO directory

single_tenancyboolean required

Whether or not the organization has single tenancy enabled

managed_tenancyboolean required

Whether or not the organization has managed tenancy enabled

has_past_due_invoicesboolean nullable

Whether or not the organization has past due billing invoices.

database_countinteger required

The number of databases in the organization

sso_portal_urlstring nullable

The URL of the organization's SSO portal.

featuresobject required

Features that can be enabled on the organization

idp_managed_rolesboolean required

Whether or not the IdP provider is be responsible for managing roles in PlanetScale

invoice_budget_amountstring required

The expected monthly budget for the organization

keyspace_shard_limitinteger required

The keyspace shard limit for the organization

has_cardboolean required

Whether or not the organization has a payment method on file

payment_info_requiredboolean required

Whether or not the organization requires payment information