Resource Expansion - Terminal

Some of Terminal’s endpoints feature an expand parameter that allows you to expand nested resources. This helps you get straight to the data you’re looking for in less requests.

Example

As an example, if you are calling an expandable endpoint that includes the following relationship:

{
  "vehicle": "vcl_01GSKTHKXVVS2EKE6MP0N20YPE"
}

By providing expand=vehicle in the request you can expand the field to include all details:

{
  "vehicle": {
    "id": "vcl_01GSKTHKXVVS2EKE6MP0N20YPE",
    "vin": "12345"
    // ... other vehicle properties
  }
}

One-level expansion

expand is one level deep. Nested relationship fields on an expanded entity stay IDs. For example, expand=vehicle returns the vehicle object, but vehicle.devices and vehicle.groups remain IDs. Request those resources separately (or with their own expand) if you need the nested objects.