Bigin icon

Bigin

Consume Bigin API

Event → Get Many

AI-generated

Summary

Retrieve multiple Event records from Bigin with optional filtering, sorting, pagination, and field selection to tailor the data returned.

Inputs

  • Return All — Boolean flag to return all matching Events or limit the number returned.
  • Limit — Maximum number of Events to return when Return All is false (1 to 50000).
  • Select All Fields — Boolean to select all fields or specific fields to include in the results.
  • Select Fields — Array of specific Event fields to return if Select All Fields is false.
  • Filter (WHERE) — Collection of filter conditions to restrict which Events are returned, combined by AND/OR logic.
  • Offset — Number of records to skip before starting to return results, for pagination.
  • Order By — List of sorting rules specifying Event fields and direction (ascending/descending) for ordering results.

Output shape

A list of Event records, each containing the requested fields.

Can return all matching results if 'Return All' is true; otherwise limited by 'Limit'. Filters and sorting are applied server-side. Supports pagination via 'Offset'. Fields returned depend on 'Select All Fields' and 'Select Fields' inputs.

Examples

Example 1: Return up to 100 Event records, selecting only 'Name' and 'Start Date', filtered to only those starting after a certain date, ordered by 'Start Date' ascending.

Return All: false; Limit: 100; Select All Fields: false; Select Fields: ['Name', 'Start Date']; Filter: Start Date > X; Order By: Start Date ASC.

Links

Discussion