Pagination and Filtering

Use pagination for endpoints that return collections, and use list item query bodies when you need selected fields, filters, sorting, or page-by-page sync.

REST APIConnect Yeeflow with external systems
OpenAPI 3.0.1apiKeyJSONWebhooksNo live console

pageIndex and pageSize

Several endpoints use pageIndex and pageSize. The imported PageSize schema says the default is 20 and the maximum cannot be greater than 1000.

ParameterPurpose
pageIndexThe page of items to return.
pageSizeMaximum items returned. Default 20; maximum 1000.

Fields, Filters, and Sorts

POST /lists/{appID}/{listID}/items/query accepts a structured body with selected fields, filter objects, sort objects, and pagination settings.

PropertyOpenAPI-backed behavior
FieldsOptional array of field IDs/names to include. If omitted, the server returns all field values.
FiltersOptional array of filter objects. If omitted, the server returns all items for the query.
SortsOptional array of sort objects with Field and Desc.
PageIndex / PageSizeUse page-by-page reads when results exceed PageSize.

Query list items with filters

curl "https://api.yeeflow.com/v1/lists/YOUR_APP_ID/YOUR_LIST_ID/items/query" \
  -H "apiKey: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "Fields": ["Title", "Text1", "Created"],
    "Filters": [
      {
        "Field": "Created",
        "Type": 3,
        "Value": "2026-01-01"
      }
    ],
    "Sorts": [
      {
        "Field": "Created",
        "Desc": true
      }
    ],
    "PageIndex": 1,
    "PageSize": 20
  }'
Indexed fields

The OpenAPI source notes that only indexed fields can be used in filters and sorting. Confirm list field indexing before depending on a filter or sort in a production integration.

Documented filter operators

TypeOperator
0Equal
1Less than or equal
2Greater than or equal
3Greater than
4Less than
5Not equal
6Null
7Not null
8Starts with
9In
10Contains