Custom Field Definitions

List Custom Field Definitions

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

Request

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

Path parameters

brandstring required
Example:acme

Brand slug authorized by this API key.

Query parameters

cursorstring

Opaque nextCursor from the same collection and filters. Omit on the first request.

limitinteger
fieldKeystring

Exact, case-sensitive match. Spaces and punctuation are literal.

entityFieldstring

Exact, case-sensitive match. Spaces and punctuation are literal.

fieldTypestring

Exact, case-sensitive match. Spaces and punctuation are literal.

labelstring

Exact, case-sensitive match. Spaces and punctuation are literal.

isActive'true' | 'false'

Exact Boolean match. Use true or false.

entityTypestring

Response

A page of matching records. totalItems counts all matches across pages. When nextCursor is null, you have reached the last page.

nextCursorstring nullable required
totalItemsinteger required

Total number of matching records across all pages.

Changes

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