Expanding responses

The expand request parameter offers the option to request additional information in an expanded response for many objects.

This parameter is widely available across our API requests and influences the response of the specific request only.

In numerous instances, an object's response properties include the ID of a related object. For instance, a Task might include an associated Assignee ID. These objects can be expanded in alignment with the expand request parameter.

Throughout this documentation, the expandable label denotes ID fields that can be expanded into objects. Recursion is supported for expansion by specifying nested fields after a dot (.).

The expand parameter can be utilized on any endpoint that returns expandable fields, including list, create, and update endpoints.

Expanding multiple objects concurrently is possible by identifying multiple items within the expand array.