Using the API
Last updated
Last updated
Welcome to Retable's public API documentation. This documentation gives you broad information about how to use Retable API with your organization.
There are four different sections that you can use.
Data
Workspace
Project
Retable
To use Retable Public API, you have to obtain an API key from Retable.io
Login to your Retable account
Click on the name of the user which is on the right top of the screen.
Click API tab
Enable and copy your API Key
User limitations are directly applied to API endpoints.
Retable API is in public beta. Several functionalities work perfectly, and there are a few that we are still working on. Hence, there might be some unstable conditions, and you'll see constant changes to the API. Feel free to send us any questions regarding our API, preferably to our Discord channel. Have fun!
You can design, build, and automate anything for your work by integrating Retable with any of your apps in just a few clicks with Retable Make (Integromat) Integration.
While you are on a table you will see a URL in the browser address bar, similar to this: https://app.retable.io/retable/2BIeQnYjn1EPOITr/s6zbj6a0sfqZMpkh/6C1z5kFwY7uR5D3O
The first part after "retable" prefix is Workspace Id
The second part after Workspace Id is Project Id
The third part after Project Id is Retable Id
Hence, the overall URL structure is like this:
https://app.retable.io/retable/{workspace_id}/{project_id}/{retable_id}
Within the project menu, there is an information field that displays all relevant IDs for the current table. This field is helpful if you want to establish an API connection to your table.
Through this menu, you can effortlessly access your workspace ID, project ID, table ID, and the total number of rows in the table.
Column ID
You can obtain the column ID by using the "Copy column ID" option in the column's right-click menu or by copying column IDs from the Customize Column screen.
You can use either the column ID or the column name in API connections.
Your API requests are authenticated using API keys. Any request that doesn't include an API key will return an error.
You can generate and delete an API key from your user page at any time on Retable.io.
This generated API key is constant - when it is generated, it never changes. However, you can change its usable state or add a new one on the same page. Team members can have 2 API keys.
Retable API has a rate limit of 12 API calls/second. It returns an error if you exceed this limit.
After obtaining your API Key (starts with RTBL-v1 prefix) you have to add an ApiKey header to every request. Otherwise, you will get an Unauthorized Error and if your API key is disabled, a "423 locked" response will be returned.
For the Beta version, we have not implemented any libraries. However, we are planning to add libraries in the coming versions.
Requests expect a JSON body.
All responses come in a JSON object inside of a data field:
Almost all responses contain created_by, updated_by and deleted_by objects called basic user objects. These objects contain information about the user who made the create, update and delete operations. They have four basic fields:
id (string): Unique Id of the user
name (string): Name of the user
surname (string): Surname of the user
email (string): Unique email address of the user
If the response contains a basic user object, the created_by user object always contains a non-null value. updated_by and deleted_by can return null values.
In Addition to basic user objects, responses return created_at, updated_at and deleted_at date fields. These fields indicate when the component is created, updated or deleted in UTC. created_at always contains a non-null date value. Other date fields (updated_at and deleted_at) can contain null values.
In the public API, the column orders correspond to those in your Default view.
This endpoint is for data related API operations.
GET https://api.retable.io/v1/public/retable/{retable_id}/data
GET https://api.retable.io/v2/public/retable/{retable_id}/data
Body
You can get the all the rows or specific rows that you want by adding row_id query param.
Even though v1 and v2 return same data, format is different. Could be choose to best suit for need.
All the rows must be separate with comma like ...data?row_id=1,2,3 when row_id query used. (Query limited with 50 rows.)
retable_id*
String
Id of the Retable
row_id
String
Rows of table
In this request's response, there is an object array called rows. This object contains information about a row.
An example row object:
id (integer): Id of the row
created_at (string): UTC date-time when the row is created
updated_at (string): UTC date-time when the row is updated
created_by (basic user object): User info that created the row
updated_by (basic user object): User info that updated the row
columns (column cell data object): A simple object that contains the column names as key and cell data as value
Only the owner or the editor roles can insert a row. Otherwise, you will get a "Not Allowed" error.
POST https://api.retable.io/v1/public/retable/{retable_id}/data
retable_id*
String
Id of the Retable
columns*
Object Array
An object with fields column_id & cell_data
column_id*
String
Id of the column
cell_data
String
Data that will be inserted into the new cell
With the body example below, you will be inserting two rows with cell data 'Isengard' and 'Rivendell' to the column with Id 'Bvt1FQhTyAPjmDx'.
Null values can be entered and will be displayed as null in your data when using null.
The response will be the inserted values.
If you do not provide the cell_value field in the body, you will get a "Bad Request" error.
Only the owner or the editor roles can update a row. Otherwise, you will get a "Not Allowed" error.
PUT https://api.retable.io/v1/public/retable/{retable_id}/data
retable_id*
String
Id of the Retable
rows*
Object Array
An array of row objects
row_id*
Integer
Row Id of where the update will be done
columns*
Object Array
An array of column row data object
column_id*
String
Id of the column
update_cell_value*
String
New cell value
Null values can be entered and will be displayed as null in your data when using null.
Only the owner of the Retable can delete a row. Otherwise, you will get a "Not Allowed" error.
DELETE https://api.retable.io/v1/public/retable/{retable_id}/data
retable_id*
String
Id of the Retable
row_ids*
Integer Array
Row Ids that will be deleted rows
If the given row Id does not exist in the Retable, delete row request returns Status Ok
with deleted_row_count is 0.
This includes workspace-related API operations.
GET https://api.retable.io/v1/public/workspace
GET https://api.retable.io/v1/public/workspace/{workspace_id}
workspace_id*
String
Id of the workspace
workspace_id*
String
4uKOsae419bI
POST https://api.retable.io/v1/public/workspace
If the name is not given in the body, an auto-generated name will be assigned.
name
String
Name of the workspace
description
String
Description of the workspace
retable_id is the last part of the table URL - the part after the last slash.
Example: app.retable.io/retable/{workspace_id}/{project_id}/{retable_id}
This includes project-related API operations.
GET https://api.retable.io/v1/public/workspace/{workspace_id}/project
workspace_id*
String
Id of the workspace
GET https://api.retable.io/v1/public/project/{project_id}
project_id*
String
Id of the project.
limit
Number
Number of records.
offset
Number
Indicates of where to start within the result set.
POST https://api.retable.io/v1/public/workspace/{workspace_id}/project
workspace_id*
String
Id of the workspace
name*
String
Name of the project
description
String
Description of the project
color
String
Hex color code of the project
In this section, you can see available Retable endpoints and Retable related API operations.
Every endpoint returns a column array object which contains current column information.
An example column object:
name (string): A unique identifier, different for every column.
type (string): Type of the column.
title (string): Title of the column.