Get all Custom Fields

GET 
https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom_api_id/fields

Get all Custom Fields

Filtering

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

Attribute	Operators	Example
name	eq,like	eq(name,"Last Name")
description	eq,like	like(description,*confidential*)
slug	eq,like,in	like(slug,*private*)
field_type	eq,in	eq(field_type,string)
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)

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.

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

Request

Responses

200

OK

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.

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

custom_api_id — pathrequired

page[offset] — query

page[limit] — query

filter — query

sort — query

ResponseClear

Click the Send API Request button above and see the response here!