List Custom Fields

GET 
/v2/settings/extensions/custom-apis/:custom-api-id/fields

Retrieves a list of Custom Fields

Filtering

The following operators and attributes are available for filtering Custom Fields:

Attribute	Operators	Example
id	lt,le,eq,gt,ge,in	eq(id,859aeba1-03c2-4822-bd4c-89afce93d7eb)
created_at	lt,le,eq,gt,ge	ge(created_at,2024-04-29T00:00:00.000Z)
updated_at	lt,le,eq,gt,ge	le(updated_at,2024-04-29T00:00:00.000Z)
description	eq,like	like(description,*confidential*)
field_type	eq,in	eq(field_type,string)
name	eq,like	eq(name,"Last Name")
slug	eq,like,in	like(slug,*private*)

Sorting

The following attributes are available for sorting. When specified, the results are sorted in ascending order based on the value of the field. To sort in descending order, prefix the attribute with -, for example, -updated_at. The default sort order is created_at in descending order.

• id
• created_at
• updated_at
• field_type
• name
• slug

Request

Responses

200

List of Custom Fields

400

Bad request. The request failed validation.

404

Not found. The requested entity does not exist.

500

Internal server error. There was a system failure in the platform.