Sign in
CustomField

Search custom fields by type, name and optional value

get/1.0/kb/customFields/search

Query parameters

objectTypestring
fieldNamestring
fieldValuestring
offsetinteger
limitinteger
audit'FULL' | 'MINIMAL' | 'NONE'

Response

successful operation

customFieldIdstring uuid
objectIdstring uuid
objectType'ACCOUNT' | 'ACCOUNT_EMAIL' | 'BLOCKING_STATES' | 'BUNDLE' | 'CUSTOM_FIELD' | 'INVOICE' | 'PAYMENT' | 'TRANSACTION' | 'INVOICE_ITEM' | 'INVOICE_PAYMENT' | 'SUBSCRIPTION' | 'SUBSCRIPTION_EVENT' | 'SERVICE_BROADCAST' | 'PAYMENT_ATTEMPT' | 'PAYMENT_METHOD' | 'TAG' | 'TAG_DEFINITION' | 'TENANT' | 'TENANT_KVS'
namestring required
valuestring required

Changes

Changed in 2 of the 4 revisions of this API.11