Back to articles
Guide

Collections API Guide

A detailed guide to Collections API: create collections, add records, use pagination, and work with query parameters.

•
5 min read

Collections API is a REST API that lets you create your own collections and store JSON data inside them.

It works well for frontend projects when you need a simple backend without setting up a separate server: demos, interview tasks, learning projects, portfolios, and internal tools.

You can create up to 3 collections. Each collection can contain up to 30 records, and every record can be any JSON object.

Each response follows the JSend format.

Collection visibility#

A collection can be private or public.

  • private means the collection is only accessible with an API key. With the key, you can read, create, update, and delete records.
  • public means the collection can be read without an API key. Creating, updating, and deleting records still requires an API key. This makes it possible to share a collection publicly without giving other users control over the data.

The collection itself can only be deleted through the dashboard. Even if the API key is compromised, the entire collection cannot be deleted through the API. Only the records inside it are at risk.

Create a collection#

Example of creating a collection named students:

The response will look like this:

After the collection is created, its URL will look like this:

Where:

  • namespace is the unique account namespace. It is created once and stays the same.
  • name is the collection name.

You can find both namespace and name in the dashboard after creating the collection. namespace is also returned in the API response.

Add data to a collection#

After creating a collection, you can add your own data to it.

Example request for creating the first record:

The maximum number of records in one collection is 30.

If the limit is reached, you will not be able to add new records until you delete one of the old ones.

Get collection records#

Example request for reading records from the students collection:

All collections share a free limit of 2000 requests per day. You can inspect rate limits in the response headers.

Example headers:

Query parameters#

After adding data to a collection, you can use query parameters to control the response.

They are optional, but useful for real interfaces such as lists, tables, pagination, and sorting.

Available parameters:

  • page — page number
  • limit — number of records returned in the response
  • sort — sorting by record id. Available values: ASC and DESC

Example request:

The response will look like this:

Where:

  • items — the array of records
  • payload — the JSON object you originally sent
  • meta — pagination, sorting, limits, and next-page information

Playground#

The API page includes a built-in playground where you can test requests directly in the browser.

After you sign in, the API key is filled in automatically. This is useful for quick tests, response checks, and request debugging without a separate client.

Open Collections API