Get Fields from Dataset (v1.2)

Returns a paginated list of field descriptors for the specified dataset. Each field includes its machine-readable name, human-readable label, parent section type and name, and entityName. Use the returned field name values in the fields array when querying data via "Get Data from Dataset (v2)". Use "List Datasets (v1.2)" to discover valid datasetName values. Pagination defaults to page 1 with 500 fields per page (maximum 1000). Out-of-range page numbers are clamped to the nearest valid page. Some datasets, especially employee, may return hundreds of fields. This endpoint does not support filtering by parent/entity/type; retrieve all pages and group client-side.

The employee dataset field names are fully qualified with their section prefix and differ from the field names used by list-employees and get-employee. Do not assume a field name from one endpoint works in the other.

For fields whose type is list, multilist, or another option-backed type, the field id can be matched to fieldId from list-list-fields to retrieve the account-level option list.

Note: Compared to "Get Fields from Dataset (v1)", this version returns RFC 7807 application/problem+json error responses and includes an X-Request-ID correlation header.

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

The name of the dataset to retrieve fields for. Use "List Datasets (v1.2)" to discover valid 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.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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