Workflows
List custom field definitions
Returns the custom field definitions for a given entity type.
🔒 Requires: custom_fields:read scope
get/workflows/custom_fields
Query parameters
entity'sale' | 'line_item' | 'customer' | 'product' required
The entity type.
Response
A list of all the custom field definitions associated with the entity type.
Example response
{
"data": [
{
"id": "1239349157873029120",
"name": "my_custom_field",
"title": "My Custom Field"
}
]
}