List Records - SnackBase

GET

api

records

{collection}

List Records

curl --request GET \
  --url https://api.example.com/api/v1/records/{collection}

{
  "items": [
    {
      "id": "<string>",
      "account_id": "<string>",
      "created_at": "<string>",
      "created_by": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>",
      "account_name": "<string>"
    }
  ],
  "total": 123,
  "skip": 123,
  "limit": 123
}

Path Parameters

collection

string

required

Query Parameters

skip

integer

default:0

Required range: x >= 0

limit

integer

default:30

Required range: 1 <= x <= 100

sort

string

default:-created_at

fields

string | null

filter

string | null

expand

string | null

cursor

string | null

cursor_before

string | null

include_count

boolean

default:false

Response

Successful Response

RecordListResponse
CursorListResponse

Response for listing records.

items

RecordResponse · object[]

required

List of records

Show child attributes

total

integer

required

Total number of records matching filter

skip

integer

required

Number of records skipped

limit

integer

required

Number of records returned

Create RecordCreate a new record in a collection. Validates the request data against the collection schema, auto-generates a record ID, and sets system fields (account_id, created_at, created_by). Args: collection: The collection name (from URL path). data: The record data (request body). May include 'account_id' for superadmins. current_user: The authenticated user, or None for anonymous. auth_context: Authorization context for permission checking. session: Database session. Returns: The created record with all fields including system fields.

List Records

curl --request GET \
  --url https://api.example.com/api/v1/records/{collection}

{
  "items": [
    {
      "id": "<string>",
      "account_id": "<string>",
      "created_at": "<string>",
      "created_by": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>",
      "account_name": "<string>"
    }
  ],
  "total": 123,
  "skip": 123,
  "limit": 123
}