Retrieve custom fields

Retrieves the custom fields schema for a specified resource.

SecurityAPI Key: SecretApiKey or HTTP: JWT
Request
path Parameters
resource
required
string

Type of resource schema.

Enum: "customers" "payment-instruments" "subscriptions" "transactions" "websites" "products" "plans" "bump-offers" "gateway-accounts" "deposit-requests"
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

get
/custom-fields/{resource}
Request samples
$customFields = $client->customFields()->search('customers', [
    'filter' => 'type:boolean',
]);
Responses

200

Schema of custom fields retrieved.

Response Schema: application/json
Array
name
string

Name of the custom field.

type
required
string

Describes the data type. Custom field type value cannot be changed.

Array of strings with up to 255 characters. Maximum size is 1000 elements.

description
string or null

Description of the custom field.

object or null

Additional schema which adds additional values constrains.

Array of objects (SelfLink)

Related links.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

Response samples
application/json
[ { "name": "string", "type": "array", "description": "string", } ]