Retrieve configuration of custom fields

filter

string

Implemented filter mappings:
name - customFieldConfigName
groupName - Bank Account Group
type - BOOLEAN, CURRENCY_AMOUNT, EMAIL, DATE, FORMATED_TEXT, NUMERIC, TEXT, SELECTION_LIST
order - 1,2,3
required - true/false
For example, when you need to fetch all "required" custom config that belong to a name "customFieldConfigName" you need to run this query
filter=name=customFieldConfigName required=true

Condition values have to be escaped if they contain whitespace or operator symbols. To do so, enclose the whole value in double quotation marks
e.g. filter=name="Custom Field Config Name" required=true.

The following operators are supported in a filter term

Operator	Name	Description	Example
=	Equal	Exact match of a single value	name=customFieldConfigName
!=	Not Equal	Negated equal	name!=customFieldConfigName
:	In	Matches field against list of comma separated values	name:customFieldConfigName,optionalCustomFieldConfigName,additionalCustomFieldConfigName
!:	Not In	Negated In	name!:customFieldConfigName,optionalCustomFieldConfigName,additionalCustomFieldConfigName
<field>	Exists	A field without operator. Is true if the field is not null	name
<field>!	Not Exists	Negated exists. Is true if field is null	name!

The Equal (=) and Not-Equal (!=) operators can be used together with wildcards to match partial strings. A single asterisk (*) can be placed at the very start or end of a value to match any number of characters there.

Usage	Name	Description
customFieldConfigName=foo* or customFieldConfigName="foo"*	Starts with	Matches any string starting with the value.
customFieldConfigName=foo or customFieldConfigName="foo"	Ends with	Matches any string ending with the value.
customFieldConfigName=foo or customFieldConfigName="foo"	Like	Matches any string containing the value.

page_number

integer

Defaults to 1

Specify which page of results to return, one-based i.e. starts from 1

page_size

integer

Defaults to 50

specifies the number of items per page

200A list of configuration entities

4XXError caused by the client, like invalid inputs or missing authorization.

5XXError caused by the server.