v1

latestOpenAPI 3.0.32026-08-067332206.6 KB

custom_fields

List custom fields

Lists custom fields for the matching asset.

get/assets/{asset_id}/custom_field_values

Query parameters

includestring

Set it to custom_field_key to return those custom field keys related to the asset you're fetching. Related records are returned in an included array in the response.

Allowed value: custom_field_key

WARNING: This parameter can slow response times.

Response

The custom fields for the asset.

Example response

{
  "data": [
    {
      "id": "r79p3j4gbcgtv33gbsqrxb",
      "attributes": {
        "key": "Campaign",
        "value": "Fall"
      }
    }
  ],
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 1
  }
}