GET /api/database/admin/views/

Returns all database views in the instance with information about the table, database and workspace they belong to, if the requesting user is staff. This can for example be used to find and intervene with publicly shared views that are being abused.

Servers

Query parameters

Name Type Required Description
page Integer No

Defines which page should be returned.

sorts String No

A comma separated string of attributes to sort by, each attribute must be prefixed with + for a descending sort or a - for an ascending sort. The accepted attribute names are: id, name, type, database_name, workspace_name, public, owned_by_username, created_on. For example sorts=-id,-name will sort the views first by descending id and then ascending name. A sortparameter with multiple instances of the same sort attribute will respond with the ERROR_INVALID_SORT_ATTRIBUTE error.

only_public Boolean No

If set to true, only publicly shared views are returned.

size Integer No

Defines how many views should be returned per page.

search String No

If provided, only views matching it exactly by slug, by the email address of their owner, or by the id of the view, its table, its database, its workspace or its owner are returned. Names are not searched.

ids String No

A comma-separated list of views IDs to filter by. When provided, only views with those IDs are returned.

workspace_id Integer No

If provided, only views in the workspace with this id are returned.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.