Expanding Responses

Many API objects can be expanded to request a response providing additional information about the object. This can be done using the expand parameter from them, which can reveal singular, multiple or embedded properties within the object.

Expanding responses is especially useful for properties which are not revealed in default responses.

Attributes

Responses can be expanded in the following ways:

1. By using the expand parameter.
2. By separating fields using a dot.
3. By leveraging the data parameter followed by the desired fields.

Key Points

• Not all fields are expandable. The ones which are have an expandable tag.
• Expansions can happen for a maximum of 4 levels or embedded fields.

This document will guide you through a basic structure of responses.

    {
      "success": true,
      "data": "object"
    }

Attribute	Explanation	Datatype
success	This will return true or false	boolean
data	This will return data	object