List Custom API Entries

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

Use it in a workflow

Add a step and choose the Elastic Path connector.
Pick the List Custom API Entries action (under Commerce Extensions).
Fill in the fields below, then reference the result from later steps as {{listCustomApiEntries.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.

page[total_method]string

The method used to calculate the total number of matching entries in the response.

One oflower_boundobservedDefault "lower_bound"

filterstring (string)

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

sortstring

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

One ofid-idcreated_at-created_atupdated_at-updated_atnullDefault "-created_at"

timeoutinteger

Specifies how long in milliseconds the request should be allowed to take. The service will return a 422 if the request takes longer than the specified timeout.

Response

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

dataarray<object>

idstring (uuid)

The unique identifier for the Custom API Entry.

typestring

Specifies the type of the resource object, use the `api_type` of the [Custom API](/docs/api/commerce-extensions/create-a-custom-api) for Custom API Entry.

linksobject1 fields

metaany

metaobject

resultsobject2 fields

pageobject4 fields

linksobject

currentstring | null

firststring | null

laststring | null

nextstring | null

prevstring | null

json

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "string",
      "links": {
        "self": "string"
      },
      "meta": 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.

Was this page helpful?