Skip to main content
GET
/
organizations
/
{organization}
/
databases
List databases
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases \
  --header 'Authorization: Bearer <token>'
{
  "current_page": 123,
  "next_page": 123,
  "next_page_url": "<string>",
  "prev_page": 123,
  "prev_page_url": "<string>",
  "data": [
    {
      "id": "<string>",
      "url": "<string>",
      "branches_url": "<string>",
      "branches_count": 123,
      "open_schema_recommendations_count": 123,
      "development_branches_count": 123,
      "production_branches_count": 123,
      "issues_count": 123,
      "multiple_admins_required_for_deletion": true,
      "ready": true,
      "at_backup_restore_branches_limit": true,
      "at_development_branch_usage_limit": true,
      "data_import": {
        "state": "<string>",
        "import_check_errors": "<string>",
        "started_at": "<string>",
        "finished_at": "<string>",
        "data_source": {
          "hostname": "<string>",
          "port": 123,
          "database": "<string>"
        }
      },
      "region": {
        "id": "<string>",
        "provider": "<string>",
        "enabled": true,
        "public_ip_addresses": [
          "<string>"
        ],
        "display_name": "<string>",
        "location": "<string>",
        "slug": "<string>",
        "current_default": true
      },
      "html_url": "<string>",
      "name": "<string>",
      "state": "pending",
      "sharded": true,
      "default_branch_shard_count": 123,
      "default_branch_read_only_regions_count": 123,
      "default_branch_table_count": 123,
      "default_branch": "<string>",
      "require_approval_for_deploy": true,
      "resizing": true,
      "resize_queued": true,
      "allow_data_branching": true,
      "foreign_keys_enabled": true,
      "automatic_migrations": true,
      "restrict_branch_region": true,
      "insights_raw_queries": true,
      "plan": "<string>",
      "insights_enabled": true,
      "production_branch_web_console": true,
      "migration_table_name": "<string>",
      "migration_framework": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "schema_last_updated_at": "<string>",
      "kind": "mysql"
    }
  ]
}

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 the database belongs to

Query Parameters

q
string

Search term to filter databases by name

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

Retrieves the databases for an organization

current_page
integer
required

The current page number

next_page
integer
required

The next page number

next_page_url
string
required

The next page of results

prev_page
integer
required

The previous page number

prev_page_url
string
required

The previous page of results

data
object[]
required