Sign in
SQL

List databases

List all databases owned by your account.

get/workspace/sql/databases

Query parameters

activeboolean

Filter by active status.

created_at__gtestring date-time

Filter by created_at (greater than or equal).

created_at__ltestring date-time

Filter by created_at (less than or equal).

fieldsstring

Comma-separated list of field names to include in the response. Nested fields can be accessed using dot notation.

idinteger

Filter by id (accepts comma-separated values).

last_editorstring

Filter by last editor (case-insensitive, partial match).

namestring

Filter by name (case-insensitive, partial match).

orderingstring

Which field to use when ordering the results.

pageinteger

A page number within the paginated result set.

page_sizeinteger

A numeric value that indicates the number of items per page.

searchstring

A search term.

statusstring

Filter by status (accepts comma-separated values).

updated_at__gtestring date-time

Filter by updated_at (greater than or equal).

updated_at__ltestring date-time

Filter by updated_at (less than or equal).

Response

List of databases retrieved successfully.

countinteger

Total number of items

total_pagesinteger

Total number of pages

pageinteger

Current page number

page_sizeinteger

Number of items per page

nextstring uri nullable

URL to the next page of results

previousstring uri nullable

URL to the previous page of results

Example response

{
  "count": 123,
  "total_pages": 10,
  "page": 1,
  "page_size": 10,
  "next": "https://api.example.com/items?page=3",
  "previous": "https://api.example.com/items?page=1"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.