BUbudibase
queries

Execute a query

Changed on

Queries which have been created within a Budibase app can be executed using this,

post/queries/{queryId}

Request

  • Base URL
    https://budibase.app/api/public/v1
  • URL
    https://budibase.app/api/public/v1/queries/{queryId}
  • Auth
    API key in header x-budibase-api-key

Path parameters

queryIdstring required

The ID of the query which this request is targeting.

Headers

x-budibase-app-idstring required

The ID of the app which this request is targeting.

Request body

parametersobject

This contains the required parameters for the query, this depends on query type, setup and bindings.

Response

Returns the result of the query execution.

dataobject[] required

The data response from the query.

paginationobject

If pagination is supported, this will contain the bookmark/anchor information for it.

Changes