Get Data from Dataset (v1)

Deprecated. Use "Get Data from Dataset (v2)" instead.

Retrieves records from the specified dataset using the fields, filters, sorting, grouping, and aggregations supplied in the request body. 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. For options-type fields using includes/does_not_include, pass the filter value as an array enclosed in square brackets, for example ["Full-Time", "Part-Time"].

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The machine-readable name of the dataset to query. Use "List Datasets (v1.2)" to discover available names.

Query Params
integer
≥ 1
Defaults to 1

The page number to retrieve. Defaults to 1.

integer
1 to 1000
Defaults to 500

The number of records to retrieve per page. Defaults to 500. Maximum is 1000.

Body Params
fields
array of strings
required

Field names to include in each returned record. Use "Get Fields from Dataset" to discover available names.

fields*
aggregations
object

Aggregation configuration. Set defaultAggregation to apply one aggregation type to every requested field, or use overridingAggregations to target specific fields. Both may be combined.

sortBy
array of objects

Ordered list of sort rules. Priority follows array order.

sortBy
filters
object

Filter configuration. Combine multiple conditions with a match strategy.

groupBy
array of strings

Field names to group results by. Currently supports only one field. When grouping is active, the data key in the response becomes an object keyed by group value instead of an array.

groupBy
showHistory
array of strings

Entity names of historical table fields whose history rows should be included. Entity names are returned by "Get Fields from Dataset".

showHistory
Responses

400

Invalid or missing argument(s), such as an unrecognised operator, malformed filter, invalid dataset name, or empty request body.

403

Insufficient permissions to access this dataset.

500

An unexpected internal error occurred while retrieving data.

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json