Get Data from Dataset

Queries the specified dataset and returns matching records. Provide field names in the fields array; use "Get Fields from Dataset (v1.2)" to discover available names. The response contains paginated rows under data, an aggregations array (empty when none requested), and a pagination block with page navigation links. Results default to page 1 with 500 records per page (maximum 1000).

Use "Get Field Options (v1.2)" to retrieve valid filter values. Filter fields do not need to appear in the fields list. Future hires have a status of Inactive; include it in your status filter to retrieve them. Values for options-type fields using includes/does_not_include operators must be passed as arrays.

When any requested fields are historical table fields, pass their entity names in showHistory; entity names are returned by "Get Fields from Dataset (v1.2)". Grouping (groupBy) currently supports only one field; when active, data becomes an object keyed by group value instead of an array. Sort priority follows the order of objects in sortBy. Aggregations accept a defaultAggregation applied to every field and/or per-field overridingAggregations.

Aggregations by field type: text: count; date: count, min, max; int: count, min, max, sum, avg; bool: count; options: count; govIdText: count.

Filter operators by field type: text: contains, does_not_contain, equal, not_equal, empty, not_empty; date: lt, lte, gt, gte, equal, not_equal, empty, not_empty, last, next, range; int: equal, not_equal, gte, gt, lte, lt, empty, not_empty; bool: checked, not_checked; options: includes, does_not_include, empty, not_empty; govIdText: empty, not_empty.

Language
Credentials
:
URL
Response
Click Try It! to start a request and see the response here!