Skip to main content
List endpoints return compact responses by default. When a result has related data, the response keeps its identifiers and leaves the related object or collection as null. Use the Expand parameter to include that data in the same request. Expansion applies to each item in results.
Each endpoint defines its expansions through its own enum. In OpenAPI, Expand is an array whose items belong to that enum. Each endpoint’s documentation therefore shows all supported values directly.
Check the Expand parameter in the API reference. Not all endpoints support expansion or share the same values.

​
Expand a relationship

For example, the sales order list returns customerId but does not load the customer object unless you request it.
The relevant part of each result is:
Add Expand=Customer to include the customer in each order on the page:
The response keeps customerId and populates customer:
If an item does not have the requested relationship, the related property remains null.

​
Expand several relationships

Repeat Expand to request more than one relationship. This example includes the cause, asset, and main employee for each maintenance work order:
Do not separate values with commas. Send one instance of the parameter for each value.

​
Expand a nested relationship

Use dot notation to reach a relationship within another relationship. For example, you can include the lines of the load order linked to each shipment:
When you request LoadOrder.Lines, Bold also includes LoadOrder. You do not need to send both values. The maximum depth is two levels: Parent or Parent.Child. Each endpoint’s reference lists the supported combinations.

​
Combine expansions with a query

You can use Expand with pagination, filters, search, and sorting when the endpoint supports those parameters.
Expansion changes the related data included in the response. It does not change which items match the filter or the pagination structure.

​
Handle unsupported values

The API responds with 400 Bad Request if you send a value that is not defined for the endpoint.
Check the Expand parameter’s enum in the endpoint documentation. Available values can differ between endpoints even when their responses contain similar relationships.
Request only the data you need. Expansions increase query work and response size. Limit nested collections in particular, and combine them with a pageSize appropriate for your integration.