Get A Custom Api

Get a Custom API

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

Use it in a workflow

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

Request

Path parameters

custom-api-idstring (uuid)required

The unique identifier of the Custom API.

Response

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

dataobject

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

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": "652e39d8-d613-493e-8c20-fef99ad6327a",
            "type": "custom_api"
          }
        ]
      }
    }
  }
}

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

Was this page helpful?