Get all Custom API Entries using the extensions endpoint

GET 
/v2/extensions/:custom_api_slug

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 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

custom_api_slug 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 object[]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.
links object
self uri
Specifies the URI of the Custom API Entry.
meta object
timestamps objectrequired
updated_at stringrequired
Specifies the date the entity is created.
created_at stringrequired
Specifies the date the entity is last updated.
data_size integerrequired
Default value: 0
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.
resource_version integer
Default value: 0
A unique identifier representing the current version of the resource. When the resource changes, the resource_version value will also change.
etag_id string
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.
]
meta object

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

current urirequired

Always the current page.

first urirequired

Always the first page.

last urirequired

Always null if there is only one page.

next stringnullrequired

Always null if there is only one page.

prev stringnullrequired

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

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

500

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

Loading...