Using Glide API

Connecting to your Glide Tables via the API allows you to automate your data management and integrate it with your own applications. The basic API allows you to add, edit, update, and delete data within Glide Tables directly.

The Advanced API has the additional ability to get row(s) from Glide Tables.

Note that when you use Glide Advanced API to pull data from Glide, each call costs an update. For Get Rows, an update is charged for every 1,000 rows collected, rounded up. For example, a "get all row" call that returns 500 rows will consume one update. A call that returns 5,800 rows will consume 6 updates.

Using Glide Tables API

You can leverage Glide Tables API in lots of different ways. Let’s break down a few different possibilities together.

Mutations

The mutateTables call in each Glide curl statement adds one or more mutation operation for tables in an app in Glide's queue. After they're added to the queue, they can be processed anytime after the call returns the actions.

This call takes a JSON body of the following form:

The call will succeed if all mutations succeed. It will fail if even one mutation fails. It will return a JSON response that's an array of results—one for each mutation. If a mutation fails, then its result has a property error, which is an error message.

Keep in mind:

• Actions that are enqueued are not guaranteed to succeed. For example, an action to delete a row that does not exist might successfully be queued. However, it will not be processed successfully since there is nothing to delete.

• Actions are not guaranteed to be processed in sequence. For example, two added rows will not necessarily be added in the order they are given in the mutations array.

Add rows

The add-row-to-table mutation adds one row to your table.

If the table has a Row ID column and the call is successful, the result will have a property "Row ID" with the Row ID of the row to be added.

Set columns

The set-columns-in-row mutation sets one or more columns in an existing row in your table.

The ROW-ID-OR-INDEX is one of the following:

• "rowID": "ROW-ID"

• "rowIndex": "ROW-INDEX"

Delete rows

The delete-row mutation deletes an existing row from your table.

Get Rows

Get Rows takes a list of table names and returns all the rows in those tables. It will only return basic columns, not computed columns. The maximum number of rows that can be returned per call is 10,000.

It takes a JSON body of the following form:

Each query looks like this:

startAt is optional, and needs only be sent when continuing a previous query that did not return all rows. For example:

The call returns an array with one element for each query, each of which looks like this:

Each row is a row object, with one property per column. The next field will only be sent when more rows are in the table than Glide sent in the response. Glide will only send a maximum of 10K rows, so if there are more, then the next value of CONTINUATION will be included with the returned data. Your code needs to check for this and make an additional API call that includes the field startAt with the value of CONTINUATION.

Filtered Queries with Big Tables

When querying a Big Table with SQL, a query looks like this:

The params array is optional, but it must be given if the SQL query refers to any parameters.

The allowed SQL is a small strict subset of ANSI SQL. The restrictions are:

• All columns must be selected via *, nothing else can be used

• Only one table can be queried

• No joins or sub-queries

• No group-by

• ORDER BY only allows sorting by a single column

• The WHERE clause allows conditions combined with AND, as well as OR. ORs can be nested within ANDs, but not the other way around.

• Only a few conditions are allowed:

  • Checking for equality with =, or comparisons with < , > , <= , >= , between a column and a constant, or a column and a column

  • Checking for inequality with <> or !=

  • Checking whether a column is (not) empty with IS [NOT] NULL

• LIMIT is supported, but the API will not return more than 1000 rows

Query parameters

The preferred way for the query to include constant values is via parameters, to avoid having to escape strings and format numbers. These are written as numbers, starting at 1, preceded by a dollar sign, i.e. $1, $2, ... If the query uses parameters then they must be passed in the params array. $1 refers to the first element in that array, $2 to the second, and so on. Parameters can be strings, numbers, and booleans, as well as date-times formatted as strings like 1992-01-01T12:18:25.040Z.

Other considerations

• The table name for FROM has to be the same table name that would otherwise be passed as tableName

• The column names are the same as used with the regular API

• Continuations (startAt) are not yet supported

Example

Let's say we want to query a table for which the curl command for Add rows is this:

To get to this code, we need to reveal the Glide Tables API.

Now, we want to get the first 10 rows from that table where:

• Name is Recycled Soft Hat and

• Material is Wooden or Category is Shoes

The query we would send to queryTables in that case would be

Note that we have to quote the column names in SQL so they're interpreted case-sensitively.

The full curl command would be:

Learn Glide Tables API

Want to see the API in action? Explore the resources below.

• Article: Getting Started with Glide API

• Video: How to Use the Glide Tables API (Getting Started in 2022)