Custom Field Definitions

Get Custom Field Definitions

get/brands/{brand}/custom-field-definitions/{id}

Request

  • Base URL: https://app.amber.ai/api/public/v1
  • URL: https://app.amber.ai/api/public/v1/brands/{brand}/custom-field-definitions/{id}
  • Auth: HTTP bearer

Path parameters

brandstring required
Example:acme

Brand slug authorized by this API key.

idstring required

Stable resource identifier.

Response

The requested record.

idstring required
entityTypestring required
entityFieldstring required
fieldKeystring required
fieldTypestring required
labelstring required
descriptionstring nullable required
requiredboolean required
defaultValueSchema0 required(unresolved $ref)
selectValuesSchema1[] required(unresolved $ref)
isActiveboolean required
sequencenumber required
createdAtstring nullable required
updatedAtstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.