REST API

Build an API route in less than 2 minutes.

Create your first API route by creating a table called todos to store tasks.

Let's create our first REST route which we can query using cURL or the browser.

We'll create a database table called todos for storing tasks. This creates a corresponding API route /rest/v1/todos which can accept GET, POST, PATCH, & DELETE requests.

1

Set up a Supabase project with a 'todos' table

Create a new project in the Supabase Dashboard.

After your project is ready, create a table in your Supabase database. You can do this with either the Table interface or the SQL Editor.

1
-- Create a table called "todos"
2
-- with a column to store tasks.
3
create table todos (
4
  id serial primary key,
5
  task text
6
);
2

Allow public access

Let's turn on Row Level Security for this table and allow public access.

1
-- Turn on security
2
alter table "todos"
3
enable row level security;
4
5
-- Allow anonymous access
6
create policy "Allow public access"
7
  on todos
8
  for select
9
  to anon
10
  using (true);
3

Insert some dummy data

Now we can add some data to our table which we can access through our API.

1
insert into todos (task)
2
values
3
  ('Create tables'),
4
  ('Enable security'),
5
  ('Add data'),
6
  ('Fetch data from the API');
4

Fetch the data

Find your API URL and Keys in your Dashboard API Settings. You can now query your "todos" table by appending /rest/v1/todos to the API URL.

Copy this block of code, substitute <PROJECT_REF> and <ANON_KEY>, then run it from a terminal.

1
curl 'https://<PROJECT_REF>.supabase.co/rest/v1/todos' \
2
-H "apikey: <ANON_KEY>" \
3
-H "Authorization: Bearer <ANON_KEY>"

Bonus

There are several options for accessing your data:

Browser

You can query the route in your browser, by appending the anon key as a query parameter:

https://<PROJECT_REF>.supabase.co/rest/v1/todos?apikey=<ANON_KEY>

Client libraries

We provide a number of Client Libraries.

1
const { data, error } = await supabase.from('todos').select()