Home
Advocacy API

Sparse Fieldsets

Return only the fields you need for each resource type.

You may request that an endpoint return only specific fields in the response on a per-type basis by including a fields[TYPE] parameter, where TYPE is the resource's type as it appears in the response (for example, tint for boards). The value of the fields parameter must be a comma-separated list that refers to the name(s) of the fields to be returned.

For example:

GET /v2/teams/1/tints?include=personalizations&fields[tint]=name,status&fields[personalization]=name,theme HTTP/1.1
Accept: application/vnd.api+json