Skip to main content
GET
/
api
/
v1
/
collections
List Collections
curl --request GET \
  --url https://api.example.com/api/v1/collections
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "table_name": "<string>",
      "fields_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "records_count": 0
    }
  ],
  "total": 123,
  "page": 123,
  "page_size": 123,
  "total_pages": 123
}

Headers

authorization
string | null

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
page_size
integer
default:25

Items per page

Required range: 1 <= x <= 100
sort_by
string
default:created_at

Field to sort by

sort_order
string
default:desc

Sort order: asc or desc

search
string | null

Search term for name or ID

Response

Successful Response

Paginated list of collections.

items
CollectionListItem · object[]
required

List of collections

total
integer
required

Total number of collections

page
integer
required

Current page number

page_size
integer
required

Number of items per page

total_pages
integer
required

Total number of pages