Expandable Fields

Each response returned by API endpoints can have fields that reference other objects, which are not returned in full by default.
For example, the getExperience operation returns and Experience object which contains a project field.
By default, this is a string and represents the ID of the referenced project object.

In some use cases, more data related to the respective object might be needed. The Convert API offers the ability to expand certain fields
into a more detailed object identified by the ID that would be sent by default.

The expanded object is the same object that the get[Object] operation would return, not having though any of the Optional fields

Format

The expand parameter must be an array when present. In URL parameters, use the following format:

expand[]=field1&expand[]=field2

Valid Examples

Expanding project and audiences in an experience response:

expand[]=project&expand[]=audiences

Expanding goals and variations in an experience response:

expand[]=goals&expand[]=variations

Error Cases

Invalid format (string instead of array):

expand=project  # ❌ Wrong
expand[]=project  # ✅ Correct

Response:

{
    "code": 422,
    "message": [
        "The 'expand' parameter must be a array."
    ],
    "parameters": [
        "expand"
    ]
}