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 filtering. 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.

• created_at
• description
• field_type
• id
• name
• updated_at

Request

Path Parameters

custom_api_id stringrequired
The id of the Custom API.
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Query Parameters

page[offset] int64

Possible values: <= 10000

The current offset by number of records, not pages. Offset is zero-based. The maximum records you can offset is 10,000. If no page size is set, the page length store setting is used.

page[limit] int64

The maximum number of records per page for this response. You can set this value up to 100. If no page size is set, the page length store setting is used.

filter string

Filter attributes. For more information, see the Filtering section.

sort string

Sort attributes, For more information, see the Sorting section.

Responses

200

OK

application/json

Schema

Schema

data object[]required
Array [
anyOf
BooleanCustomFieldAttributes
id uuid
The unique identifier of the Custom Field.
type string
Specifies the type of the resource object, use custom_field for Custom Field.
name string
Possible values: non-empty and <= 255 characters
Specifies the name of this Custom Field.
description string
Possible values: <= 255 characters
Specifies the description for this Custom API.
slug string
Possible values: non-empty and <= 63 characters
Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.
field_type string
Possible values: [string, integer, boolean, float]
Specifies the type of the field. This field cannot be updated.
use_as_url_slug boolean
Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).
presentation object
sort_order integer
Possible values: <= 1000
Default value: 0
Specifies the order of the field in the User Interface.
links object
self uri
meta object
timestamps objectrequired
updated_at stringrequired
Specifies the date the entity is created.
created_at stringrequired
Specifies the date the entity is last updated.
validation object
boolean object
allow_null_values booleannull
Default value: true
When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted.
immutable booleannull
When set to true, prevents changing the field.
StringCustomFieldAttributes
id uuid
The unique identifier of the Custom Field.
type string
Specifies the type of the resource object, use custom_field for Custom Field.
name string
Possible values: non-empty and <= 255 characters
Specifies the name of this Custom Field.
description string
Possible values: <= 255 characters
Specifies the description for this Custom API.
slug string
Possible values: non-empty and <= 63 characters
Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.
field_type string
Possible values: [string, integer, boolean, float]
Specifies the type of the field. This field cannot be updated.
use_as_url_slug boolean
Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).
presentation object
sort_order integer
Possible values: <= 1000
Default value: 0
Specifies the order of the field in the User Interface.
links object
self uri
meta object
timestamps objectrequired
updated_at stringrequired
Specifies the date the entity is created.
created_at stringrequired
Specifies the date the entity is last updated.
validation object
string object
min_length integernull
Possible values: <= 65535
Specifies the minimum number of characters that can be stored.
max_length integernull
Possible values: <= 65535
Specifies the minimum number of characters that can be stored.
regex stringnull
Possible values: <= 1024 characters
RE2 regular expression that used to restrict the specific characters that can be stored.
allow_null_values boolean
Default value: true
When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted. nullable: false
unique string
Possible values: [yes, no]
Default value: no
If yes, this prevents two Custom API entries from having the same value for this field within the Custom API. When set to no (the default), multiple Custom API entries may have the same value
unique_case_insensitivity boolean
Controls case-insensitive uniqueness for this field. Can only be set to true if unique is set to yes. If true, prevents two Custom API entries from having the same value for this field within the Custom API, ignoring case differences. When set to false (the default), case is considered when checking for uniqueness. This value can only be set during field creation and cannot be modified afterwards.
immutable boolean
When set to true, the value of this field can be specified only during POST requests and cannot be modified during PUT requests.
IntegerCustomFieldAttributes
id uuid
The unique identifier of the Custom Field.
type string
Specifies the type of the resource object, use custom_field for Custom Field.
name string
Possible values: non-empty and <= 255 characters
Specifies the name of this Custom Field.
description string
Possible values: <= 255 characters
Specifies the description for this Custom API.
slug string
Possible values: non-empty and <= 63 characters
Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.
field_type string
Possible values: [string, integer, boolean, float]
Specifies the type of the field. This field cannot be updated.
use_as_url_slug boolean
Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).
presentation object
sort_order integer
Possible values: <= 1000
Default value: 0
Specifies the order of the field in the User Interface.
links object
self uri
meta object
timestamps objectrequired
updated_at stringrequired
Specifies the date the entity is created.
created_at stringrequired
Specifies the date the entity is last updated.
validation object
integer object
min_value integernull
Specifies the minimum whole number that can be stored.
max_value integernull
Specifies the maximum whole number that can be stored.
allow_null_values booleannull
Default value: true
When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted.
immutable booleannull
When set to true, prevents changing the field.
FloatCustomFieldAttributes
id uuid
The unique identifier of the Custom Field.
type string
Specifies the type of the resource object, use custom_field for Custom Field.
name string
Possible values: non-empty and <= 255 characters
Specifies the name of this Custom Field.
description string
Possible values: <= 255 characters
Specifies the description for this Custom API.
slug string
Possible values: non-empty and <= 63 characters
Specifies a slug that must be unique within the scope of the Custom API. This slug will be value as the key in the JSON Object in all entries.
field_type string
Possible values: [string, integer, boolean, float]
Specifies the type of the field. This field cannot be updated.
use_as_url_slug boolean
Enabling this field will mean Custom API Entries created in this Custom API will use this value in the URL instead of the id attribute. In order to set this field, the field must be a string, and unique, not allow null values, no entries have been created yet, and this field cannot be set to true on another custom field. This field cannot be updated. In addition to any validation rules you create, the values must be Unreserved URL Characters (i.e., be alpha-numeric, or one of -, ., _ or ~).
presentation object
sort_order integer
Possible values: <= 1000
Default value: 0
Specifies the order of the field in the User Interface.
links object
self uri
meta object
timestamps objectrequired
updated_at stringrequired
Specifies the date the entity is created.
created_at stringrequired
Specifies the date the entity is last updated.
validation object
float object
min_value integernull
Specifies the minimum whole number that can be stored.
max_value integernull
Specifies the maximum whole number that can be stored.
allow_null_values booleannull
Default value: true
When set to true, this allows null values for that field on Custom API Entries. When set to false, storing null values is not permitted.
immutable booleannull
When set to true, prevents changing the field.
]
meta object

results objectrequired

total integer

Total number of results for the entire collection.

page objectrequired

limit integer

The maximum number of records for all pages.

offset integer

The current offset by number of pages.

current integer

The current number of pages.

total integer

The total number of records for the entire collection.

links object

current urirequired

Always the current page.

first urirequired

Always the first page.

last urirequired

Always null if there is only one page.

next stringnullrequired

Always null if there is only one page.

prev stringnullrequired

Always null if the user is on the first page.

Example (from schema)

{
  "data": [
    null,
    null,
    null,
    null
  ],
  "meta": {
    "results": {
      "total": 0
    },
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 1
    }
  },
  "links": {
    "current": "/v2/settings/custom-apis?page[offset]=0&page[limit]=100",
    "first": "/v2/settings/custom-apis?page[offset]=0&page[limit]=100",
    "last": "/v2/settings/custom-apis?page[offset]=0&page[limit]=100",
    "next": null,
    "prev": null
  }
}

getFields

{
  "data": [
    {
      "type": "custom_field",
      "name": "Name",
      "description": "This field stores the name of the wishlist.",
      "slug": "name",
      "field_type": "string",
      "validation": {
        "string": {
          "min_length": 3,
          "max_length": 128,
          "regex": "[a-zA-Z0-9 ]{3,128}",
          "allow_null_values": true,
          "immutable": false,
          "unique": "no",
          "unique_case_insensitivity": false
        }
      }
    }
  ],
  "meta": {
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 1
    },
    "results": {
      "total": 1
    }
  },
  "links": {
    "current": "/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields?page[limit]=100&page[offset]=0",
    "first": "/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields?page[limit]=100&page[offset]=0",
    "last": "/settings/extensions/custom-apis/3fa85f64-5717-4562-b3fc-2c963f66afa6/fields?page[limit]=100&page[offset]=0",
    "next": null,
    "prev": null
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

missing-name

Required field missing

{
  "errors": [
    {
      "detail": "Invalid filter: unknown field [version] specified in search filter, allowed fields are [api_type created_at description id name slug updated_at]",
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

404

Not found. The requested entity does not exist.

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

not-found

Requested entity not found

{
  "errors": [
    {
      "title": "Not Found",
      "status": "404",
      "detail": "Not found"
    }
  ]
}

500

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

application/json

Schema

Schema

errors Error[]required
Array [
title stringrequired
A brief summary of the error.
status stringrequired
The HTTP response code of the error.
detail string
Optional additional detail about the error.
]

Example (from schema)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

internal-server-error

Internal server error

{
  "errors": [
    {
      "title": "Internal Server Error",
      "status": "500",
      "detail": "there was a problem processing your request"
    }
  ]
}

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom_api_id/fields' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

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!