Developers
Showcases9

List showcases

GET/showcases

Lists showcases and showcase groups in the account, ordered by position and paginated with a cursor.

By default, only top-level items are returned; use parent_id to list the showcases inside a group. The collection can also be filtered by status, kind, and name (q). Set deleted=true to list showcases in the trash instead of active ones.

Credentials limited to specific showcases only see those showcases.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "position"
  • "-position"
parent_id?string

Only showcases inside the group with this public ID. Without it, only top-level items are returned.

status?string

Only items with this status.

Value in

  • "published"
  • "draft"
  • "unlisted"
  • "hidden"
kind?string

Only groups or only showcases.

Value in

  • "group"
  • "showcase"
deleted?boolean

When true, returns only items in the trash. Items in the trash are excluded by default.

q?string

Text search term.

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/showcases"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "deleted": true,      "id": "string",      "image": "string",      "kind": "group",      "name": "string",      "object": "showcase",      "parent_id": "string",      "position": 0,      "products_count": 0,      "revision": "string",      "status": "published",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Showcases9

Showcases in API v3: list showcases, create a showcase, reorder showcases, retrieve a showcase, update a showcase, delete a showcase, duplicate a showcase, list showcase products, reorder showcase products.

Create a showcase POST

Creates a showcase or a showcase group. New showcases and groups are always created with the `draft` status. Showcases follow a two-level hierarchy: groups exist only at the top level and can contain showcases. To create a showcase inside a group, set `parent_id` to the group's public ID; if `parent_id` does not reference a group, the request is rejected with `hierarchy_violation`. A showcase created inside a group is always created with the `showcase` kind.