v17

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

Schema recommendations

List schema recommendations

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

OAuth Scopes

Resource	Scopes
Organization	read_databases
Database	read_database

get/organizations/{organization}/databases/{database}/schema-recommendations

organizationstring required

Organization name slug from list_organizations. Example: acme.

databasestring required

Database name slug from list_databases. Example: app-db.

state'open' | 'closed'

Filter by recommendation state

pageinteger

If provided, specifies the page offset of returned results

per_pageinteger

If provided, specifies the number of returned results

Returns schema recommendations

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