Get all Custom API Entries

GET 
https://useast.api.elasticpath.com/v2/extensions/:customApiSlug

Filtering

The following operators and attributes are available for filtering:

Attribute	Operators	Example
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)

Custom API Entries can also be filtered by the slug for each Custom Field. For example, you can get all Custom API Entries with name containing string "wish" by setting filter query parameter like(name,*wish*).

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
• id
• updated_at

Request

Path Parameters

customApiSlug stringrequired
The slug of the Custom API.
Example: wishlists

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 CustomApiEntryAttributes[]required
Array [
id uuid
The unique identifier for the Custom API Entry
type string
Specifies the type of the resource object, use the api_type of the Custom API for Custom API Entry.
$customFieldSlug stringintegerboolean
Specifies the data for this Custom API Entry, each key must match a slug of a Custom Field. The corresponding value must conform to the defined field_type and meet the validation defined for that field if set.
links object
self uri
Specifies the URI of the Custom API Entry.
meta Meta (integer)
timestamps Timestampsrequired
updated_at stringrequired
Specifies the date the entity is created.
created_at stringrequired
Specifies the date the entity is last updated.
data_size required
Specifies the sum of the size of each value stored for the Custom API Entry in bytes. The total size of a Custom API Entry must not exceed 64KB.
]
meta PaginationMeta[]
Array [
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[]
Array [
timestamps object
current uri
Always the current page.
first uri
Always the first page.
last uri
Always null if there is only one page.
next string
Always null if there is only one page.
prev string
Always null if the user is on the first page.
]

Example (from schema)

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string",
      "links": {
        "self": "/extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a"
      },
      "meta": 0
    }
  ],
  "meta": [
    {
      "results": {
        "total": 0
      },
      "page": {
        "limit": 100,
        "offset": 0,
        "current": 1,
        "total": 1
      }
    }
  ],
  "links": [
    {
      "timestamps": {
        "current": "/v2/custom-apis?page[offset]=0&page[limit]=100",
        "first": "/v2/custom-apis?page[offset]=0&page[limit]=100",
        "last": "/v2/custom-apis?page[offset]=0&page[limit]=100",
        "next": null,
        "prev": null
      }
    }
  ]
}

valid_entry

Default Wishlist

{
  "data": [
    {
      "id": "7e067539-6f6c-46e1-8c55-940031b36c6a",
      "type": "wishlist_ext",
      "name": "My Wishlist",
      "items_count": 0,
      "keep_purchased": false,
      "links": {
        "self": "/extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a"
      },
      "meta": {
        "timestamps": {
          "updated_at": "2017-01-10T11:41:19.244Z",
          "created_at": "2017-01-10T11:41:19.244Z"
        },
        "data_size": 6,
        "resource_version": 0
      }
    }
  ],
  "meta": {
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 1
    },
    "results": {
      "total": 1
    }
  },
  "links": {
    "current": "/extensions/wishlists?page[limit]=100&page[offset]=0",
    "first": "/extensions/wishlists?page[limit]=100&page[offset]=0",
    "last": "/extensions/wishlists?page[limit]=100&page[offset]=0",
    "next": null,
    "prev": null
  }
}

default

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"
    }
  ]
}

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

• CURL

curl -L -X GET 'https://useast.api.elasticpath.com' \
-H 'Accept: application/json'

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Parameters

customApiSlug — pathrequired

page[offset] — query

page[limit] — query

filter — query

sort — query

ResponseClear

Click the Send API Request button above and see the response here!