- Print
Look up a table query for a Tulip Table by id
Looks up a table query for a Tulip Table by id.
Requires the table-queries:read
API key scope.
The id of a Tulip Table.
The id of a Tulip Table query.
The Tulip Table query was retrieved successfully.
A Tulip Table query that exists on a Tulip Table. The record object will include all the fields of the query, addition to the record's created timestamp and last updated timestamp.
The ID of the Tulip Table that the query exists on.
The name of the Tulip Table Query.
The filters that are applied on this Tulip Table Query.
The filters can use any of the columns defined in the Tulip Table (including _createdAt
and _updatedAt
) that the query exists on with any of the functions.
The value to compare to.
If datasourceType
is set to "app-info"
, then params
is not required.
If datasourceType
is set to "static"
, then params
is required.
The static value to compare to. Must be of the same type as the data in the column specified by field
.
How the filters applied on this Tulip Table Query are aggregated.
The field and sorting direction used to sort the query results
Sorts are used to order the queries based on columns defined in the Tulip Table where the query exists.
The field that records should be sorted by in the response. Can be the name of any of the columns of the Table (including id
) or one of these special values:
_sequenceNumber
_createdAt
_updatedAt
The direction of the records, either acsending or descending
The number of records that will be returned at most from this Tulip Table query.
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
The request was made unauthorized. HTTP Basic Authorization using a Tulip API Key is required for use of the API.
The provided authentication info was rejected. The response will provide additional details.
The requested database entry was not found.
The request was malformed. This could mean that headers, query parameters, or the request body was unable to be parsed or had unexpected values.
The server encountered an unexpected error.