List custom field definitions

get https://{domain_prefix}.retail.lightspeed.app/api/2.0/workflows/custom_fields

Returns the custom field definitions for a given entity type.

Response

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://example.retail.lightspeed.app/api/2.0/workflows/custom_fields?entity=sale' \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of all the custom field definitions associated with the entity type.