Get all Custom API Entries

GET 
https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom_api_id/entries

Get all Custom API Entries

Filtering

The following operators and attributes are available for filtering all Custom API Entries:

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)

The following operators and attributes may be available for filtering Custom API Entries depending on how the Custom Fields for that Custom API are configured.

Field type	Operators
string	lt,le,eq,gt,ge,in,like
integer	lt,le,eq,gt,ge,in
float	lt,le,gt,ge,in
boolean	eq

Given there is a Custom Field with "slug": "name" and "field_type": "string".

When you get all Custom API Entries with query parameter: ?filter=like(name,*wish*).

Then you will get all Custom API Entries where name contains the string wish.

Sorting

The following attributes are available for sorting. 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.

• id
• created_at
• updated_at

Request

Path Parameters

custom_api_id stringrequired
The id of the Custom API.
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

Query Parameters

page[offset] int64

Possible values: >= 0 and <= 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

Possible values: >= 0

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.

page[total_method] string
Possible values: [lower_bound, observed]
The method used to calculate the total number of matching entries in the response.
Enum Value	Description
lower_bound	Restricts the count of records to at most 10,000. If there are <=10,000 records, the response will indicate it is an exact total, otherwise it will indicate lower_bound.
observed	Restricts the count of record to check only if there is a next page. For example if your page[offset] is 0, and page[limit] is 25, and there are 200 records, then with page[total_method]=observed, the response will indicate there are 26, so that the client knows there are more records.
Default value: lower_bound
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 object[]required
Array [
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 for Custom API Entry.
links object
selfstring,null<uri>nullable
Specifies the URI of the Custom API Entry.
Example: /extensions/wishlists/7e067539-6f6c-46e1-8c55-940031b36c6a
meta object
timestamps objectrequired
updated_atstringrequired
Specifies the date the entity is created.
Example: 2017-01-10T11:41:19.244Z
created_atstringrequired
Specifies the date the entity is last updated.
Example: 2017-01-10T11:41:19.244Z
data_sizeintegerrequired
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.
Default value: 0
Example: 6
resource_versioninteger
A unique identifier representing the current version of the resource. When the resource changes, the resource_version value will also change.
Default value: 0
Example: 4
etag_idstring
A unique identifier representing the current version of the resource that is a hashed string. When the resource changes, the etag_id will also change.
Example: 6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b
property name*any
]
meta object
results objectrequired
totalinteger
Total number of results for the entire collection.
total_methodstring
The method used to calculate the total number results
Enum Value	Description
exact	Indicates that the total is an exact count of results
lower_bound	When there are more than 10,000 results, we stop counting at 10,000 and report that the count is a lower_bound.
observed	Will indicate if there is at least one more result past the current page, this is the highest performing option as it doesn't require an extra call.
Possible values: [exact, lower_bound, observed]
page objectrequired
limitinteger
The maximum number of records for all pages.
Example: 100
offsetinteger
The current offset by number of pages.
Example: 0
currentinteger
The current number of pages.
Example: 1
totalinteger
The total number of records for the entire collection.
Example: 1
links object
currentstring,null<uri>nullablerequired
Always the current page.
Example: /v2/settings/custom-apis?page[offset]=0&page[limit]=100
firststring,null<uri>nullablerequired
Always the first page.
Example: /v2/settings/custom-apis?page[offset]=0&page[limit]=100
laststring,null<uri>nullablerequired
Always null if there is only one page.
Example: /v2/settings/custom-apis?page[offset]=0&page[limit]=100
nextstring | nullnullablerequired
Always null if there is only one page.
Example: null
prevstring | nullnullablerequired
Always null if the user is on the first page.
Example: null

Example (auto)

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "type": "string",
      "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": 4,
        "etag_id": "6b86b273ff34fce19d6b804eff5a3f5747ada4eaa22f1d49c01e52ddb7875b4b"
      }
    }
  ],
  "meta": {
    "results": {
      "total": 0,
      "total_method": "exact"
    },
    "page": {
      "limit": 100,
      "offset": 0,
      "current": 1,
      "total": 1
    }
  },
  "links": {
    "current": "/v2/settings/custom-apis?page[offset]=0&page[limit]=100",
    "first": "/v2/settings/custom-apis?page[offset]=0&page[limit]=100",
    "last": "/v2/settings/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,
        "etag_id": "5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9"
      }
    }
  ],
  "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
  }
}

400

Bad request. The request failed validation.

application/json

Schema

Schema

errors Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstring<string>required
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

missing-name

Required field missing

{
  "errors": [
    {
      "detail": "Invalid filter: unknown field [version] specified in search filter, allowed fields are [api_type created_at description id name slug updated_at]",
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

403

Forbidden. You do not have permission to access this resource.

application/json

Schema

Schema

errors Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstring<string>required
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

{
  "errors": [
    {
      "title": "string",
      "status": "string",
      "detail": "string"
    }
  ]
}

forbidden-error

Forbidden error

{
  "errors": [
    {
      "title": "Forbidden",
      "status": "403",
      "detail": "You do not have permission to access this resource."
    }
  ]
}

500

Internal server error. There was a system failure in the platform.

application/json

Schema

Schema

errors Error[]required
Array [
titlestringrequired
A brief summary of the error.
statusstring<string>required
The HTTP response code of the error.
detailstring
Optional additional detail about the error.
]

Example (auto)

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

Authorization: http

name: bearerAuthtype: httpscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/settings/extensions/custom-apis/:custom_api_id/entries");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://useast.api.elasticpath.com

Auth

Bearer Token

Parameters

custom_api_id — pathrequired

page[offset] — query

page[limit] — query

page[total_method] — query

---lower_boundobserved

filter — query

sort — query

ResponseClear

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