younifyd
Menu

List Custom Fields

List Custom Fields

GET/v2/settings/extensions/custom-apis/{custom-api-id}/fields

Use it in a workflow

  1. Add a step and choose the Elastic Path connector.
  2. Pick the List Custom Fields action (under Commerce Extensions).
  3. Fill in the fields below, then reference the result from later steps as {{listCustomFields.response.data}}.

Request

Path parameters

custom-api-idstring (uuid)required

The unique identifier of the Custom API.

Query parameters

page[offset]integer (int64)

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](/docs/api/settings/settings-introduction#page-length) store setting is used.

page[limit]integer (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](/docs/api/settings/settings-introduction#page-length) store setting is used.

filterstring (string)

Filter attributes. For more information, see the [Filtering](/guides/Getting-Started/filtering) section.

sortstring

Specifies the order in which Custom Fields will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).

One ofid-idcreated_at-created_atupdated_at-updated_atfield_type-field_typename-nameslug-slugDefault "-created_at"

Response

Returns 200 with an object. Read it in later steps with {{listCustomFields.response.data.<field>}}.

dataarray<oneOf>
metaobject
resultsobject2 fields
pageobject4 fields
linksobject
currentstring | null
firststring | null
laststring | null
nextstring | null
prevstring | null
json
{
  "data": [
    null
  ],
  "meta": {
    "results": {
      "total": 0,
      "total_method": "exact"
    },
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 1
    }
  },
  "links": {
    "current": "string",
    "first": "string",
    "last": "string",
    "next": "string",
    "prev": "string"
  }
}

Need more? See the Elastic Path guide for connection setup and behaviour shared by every action.