v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Workflows

List custom field values

Returns the custom field values for a given entity.

🔒 Requires: custom_fields:read scope

get/workflows/custom_fields/values

Query parameters

entity'sale' | 'line_item' | 'customer' | 'product' required

The entity type.

entity_idstring required

The entity ID.

Response

A list of all the custom field values associated with entity.

Example response

{
  "data": [
    {
      "definition_id": "1239349157873029120",
      "name": "my_custom_field",
      "title": "My Custom Field"
    }
  ]
}