Glide Table API

Learn about the Glide Table API

If you're new to APIs, check out Glide Table API for Beginners 🚀

Who has access to Glide API?

For Pro & Enterprise plans, every Glide Table has it’s own API. With the API you can:

  • Add row to table

  • Set columns in row

  • Delete row

How do I access Glide API?

Open the Data editor Go to the Glide Table > right-click on the table icon on the left > show API usage This shows a window with the

To get started:

  1. Open the Data editor

  2. Go to the Glide Table > right-click on the table icon on the left > show API usage

  3. This shows a window with the different text statements you can use.

When working with the API, you will pass a unique API Key, sometimes labeled a Bearer Token. It's a long sequence of random numbers and letters that looks like this: 2F2733E2-2B70-4291-8250-633B9E8F16AF You should treat this as a password–it's a secret that you should not share.

If you’re already experienced with APIs, you can view the reference doc below. If you’re new to working with APIs or just need a step by step guide, we'll be posting more content very shortly.

mutateTables

This call enqueues one or more mutation operations for tables in an app in Glide’s queue. When the call returns the actions will have been enqueued, but processing them can happen any time later. Actions that are enqueued are also not guaranteed to succeed.

For example, an action to delete a row that does not exist might successfully enqueue, but it will not be processed successfully. Note also that the 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.

This call takes a JSON body of the following form:

{
    "appID": "APP-ID",
    "mutations": [MUTATION, ...]
}

At least one mutation must be given. There is no definite or enforced upper bound on the number of mutations, but please keep it below 100.

The call will succeed if all mutations succeed, and fail if at least 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.

Each mutation can be one of the following:

add-row-to-table

This mutation will add one row to a table in the app. It has this form:

{
    "kind": "add-row-to-table",
    "tableName": "TABLE-NAME",
    "columnValues": {
        "COLUMN-NAME": "COLUMN-VALUE",
        ...
    }
}

If the table has a row ID column, the result for the call, if successful, will have a property rowID with the row ID of the row to be added.

Not all columns have to be specified. Columns that are not specified will remain empty.set-columns-in-row

set-columns-in-row

This mutation will set one or more columns in an existing row:

{
    "kind": "set-columns-in-row",
    "tableName": "TABLE-NAME",
    "columnValues": {
        "COLUMN-NAME": "COLUMN-VALUE",
        ...
    },

    ROW-ID-OR-INDEX
}

where ROW-ID-OR-INDEX is either

"rowID": "ROW-ID"

or

"rowIndex": ROW-INDEX

ROW-INDEX should only be used for Google Sheet tables. It must be a number, and it’s zero-based, i.e. the first row in the sheet has index 0.

delete-row

This mutation will delete an existing row:

{
    "kind": "delete-row",
    "tableName": "TABLE-NAME",
    ROW-ID-OR-INDEX
}

ROW-ID-OR-INDEX is interpreted identically to set-columns-in-row.

Last updated