/
5 minute read
June 30, 2022

Field Filtering

The Core API supports field filtering for most GET requests. Append the fields parameter to your request URL to return only the requested fields in the response body.

Query parameters

Fields Description

fields

string
Optional

Specify a comma-delimited list of fields to return (field_1,field_2,…​). Omit this field to return all fields.

Allowable Values:

All alpha-numeric characters, plus - and _.

Note
Commas simultaneously delimit fields and nesting levels. The order in which you specify fields is insignificant in regards to nesting level. For example, the following sample request URL will return these four fields, provided all four fields exist: field_1, field_1.field_2, field_2, and field_2.field_1.

Sample request URL

HTML
Copied

Is this helpful?

Yes
No
Join our developer newsletter