REST from your database catalog
    DocumentationCheat sheetQuestionsDownloadSource
    Questions
    • How do I...?
    Start here
    • Getting started
    • What a table becomes
    • Compared with PostgREST
    Setting up
    • Tables, columns and relations
    • Security and hooks
    • Writes and procedures
    • Prefer: return=representation
    • Node, Fastify, Express
    Reading
    • select
    • /{key}
    • relation(...)
    • order
    • limit, offset
    • relation.order, .limit
    • count
    • count(), sum(), avg()...
    • "name"
    Filtering
    • eq, neq
    • gt, gte, lt, lte
    • in
    • like, ilike
    • match, imatch
    • is
    • ov, cs, cd
    • not
    • relation.column
    • or, and
    Databases
    • Supported databases
    • Adding a database
    Reference
    • Cheat sheet
    • Errors
    Reading

    Read a page

    Take limit rows, after skipping offset of them.

    limit=2limit=2&offset=2

    A read without limit answers at most 50 rows. A limit above 1000 is refused with limit_exceeded, never quietly lowered, so a client always knows what it got.

    Combine paging with order, so the pages follow a sequence you chose.

    Examples

    The first page of two.
    /todos?select=id,name&order=id&limit=2

    Asking the database...

    The second page.
    /todos?select=id,name&order=id&limit=2&offset=2

    Asking the database...

    Too many rows at once.
    /todos?limit=1001

    Asking the database...

    See alsoKnow how many there are Sort the rows
    PreviousSort the rowsNext Sort and page what is embedded
    restloom - a REST API generated from your database catalog
    DocumentationDownloadSource