List Custom AP Is

List Custom APIs

GET/v2/settings/extensions/custom-apis

Use it in a workflow

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

Request

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 APIs will be returned. For more information, see [Sorting](/guides/Getting-Started/sorting).

One ofid-idcreated_at-created_atupdated_at-updated_atapi_type-api_typename-nameslug-slugDefault "-created_at"

Response

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

dataarray<object>

idstring (uuid)

The unique identifier for the Custom API.

typestring

Specifies the type of the resource object, use `custom_api` for Custom APIs.

namestring

Specifies the name of this Custom API.

descriptionstring

Specifies the description for this Custom API.

slugstring

Specifies a unique slug identifier for the Custom API. The API Entries for the created Custom API will be accessible at the location `/v2/extensions/<slug>`.

api_typestring

Specifies a unique API type for this Custom API. Entries for this API will use this value for their `type` field. This field must be suffixed with `_ext` to distinguish it from built in APIs.

allow_upsertsboolean

Controls whether upsert operations are allowed for Custom API Entries via the `PUT` method. When set to `true`, it allows the creation of new Custom API Entries using `PUT` if the record doesn't exist, and updates the existing record if it does. When `false`, `PUT` requests can only update existing entries.

Default false

presentationobject2 fields

Optional presentation options for the Custom API.

linksobject1 fields

metaobject1 fields

relationshipsobject1 fields

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",
      "name": "string",
      "description": "string",
      "slug": "string",
      "api_type": "string",
      "allow_upserts": false,
      "presentation": {
        "page": "string",
        "section": "string"
      },
      "links": {
        "self": "string"
      },
      "meta": {
        "timestamps": {
          "created_at": "2017-01-10T11:41:19.244Z",
          "updated_at": "2017-01-10T11:41:19.244Z"
        }
      },
      "relationships": {
        "parent_apis": {
          "data": [
            {
              "id": null,
              "type": 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?