Concepts

Pagination and filtering

On this page

Lists that page
Filtering
Sorting

Most lists in Bizisy are short enough to return whole: the people of a company, its units, locations, custom fields, open checklists. They take filters, not pages. The few lists that grow without bound page with a cursor.

Lists that page#

Action	Paging fields
`platform.activity.list`	`before`, `limit`
`platform.notifications.list`	`limit`, `before`
`org.positions.list`	`limit`, `after`
`documents.list`	`limit`
`webhooks.deliveries.list`	`before`, `limit`

How each one pages:

Activity (platform.activity.list): newest first. limit (default 50, at most 100). The result has next_before; pass it as before to get the next page. null means you've reached the end.
Webhook deliveries (webhooks.deliveries.list): one endpoint's last 30 days, newest first. limit (default 25, at most 100), and the same before / next_before pattern.
Open positions (org.positions.list): draft, open and on-hold positions come whole; filled and cancelled ones come newest first, limit at a time (default 50, at most 200). For the next page pass after, the id of the last closed position you got.
Documents (documents.list): newest (or largest) first, up to limit (default and maximum 500). Narrow with its filters rather than paging.

Shell

# The second page of Activity
curl https://api.bizisy.com/v1/platform/activity.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" -H "Content-Type: application/json" \
  -d '{"limit": 100, "before": "01k6x3f9qv2m8a7d5c4b3n2p1r"}'

Filtering#

List actions filter on what you'd filter on in the app. Filters combine with AND. For example, org.people.list takes:

Filter	Example
`as_of`	`"2026-12-01"`: the directory on that day
`status`	`"all"` to include leavers; default `active` and `pre_hire`
`q`	`"ana"`: name, email or title, case-insensitive
`unit_id`, `include_subunits`	A team and every unit below it
`location_id`, `manager_id`	One location; someone's direct reports
`joined_between`, `left_between`	`{"from": "2026-01-01", "to": "2026-03-31"}` (HR in the app only)

Every action's filters are in the API reference. Read actions also accept GET with the filters as query parameters; objects are JSON-encoded:

Shell

curl -G https://api.bizisy.com/v1/org/people.list \
  -H "Authorization: Bearer $BIZISY_API_KEY" \
  --data-urlencode 'status=all' --data-urlencode 'q=ana'

Sorting#

Each list has one documented order (people by name, Activity newest first, …), stated in the action's description. There is no sort parameter except where the reference shows one.

Something missing or wrong on this page? Write to hello@bizisy.com.