v17

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

List databases

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_database, delete_database, write_database, read_branch, delete_branch, create_branch, delete_production_branch, connect_branch, connect_production_branch, connect_production_read_only_branch, delete_branch_password, delete_production_branch_password, delete_production_read_only_branch_password, read_deploy_request, create_deploy_request, approve_deploy_request, read_comment, create_comment, restore_backup, restore_production_branch_backup, read_backups, write_backups, delete_backups, delete_production_branch_backups, write_branch_vschema, write_production_branch_vschema

OAuth Scopes

ResourceScopes
Organizationread_databases
get/organizations/{organization}/databases

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

Query parameters

qstring

Search term to filter databases by name

pageinteger

If provided, specifies the page offset of returned results

per_pageinteger

If provided, specifies the number of returned results

Response

Retrieves the databases for an organization

typestring required

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

current_pageinteger required

The current page number

next_pageinteger nullable required

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

next_page_urlstring nullable required

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

prev_pageinteger nullable required

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

prev_page_urlstring nullable required

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