Developers
Products19

List products

GET/products

Lists the products of the account. Results are paginated with a cursor and can be filtered by showcase, status, external ID, search term, and deletion state.

If the credentials are limited to specific products, only those products are returned.

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

  • "id"
  • "-id"
showcase_id?string

Only products in the showcase with this public ID.

status?string

Only products with this status.

Value in

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

Only products with this external ID.

q?string

Text search term.

deleted?boolean

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

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/products"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "definitions": {        "alias_product_id": "string"      },      "deleted": true,      "display": {        "hide_module_bar": true,        "show_progress": true      },      "external_id": "string",      "format": "course",      "id": "string",      "image": "string",      "lessons_count": 0,      "modules_count": 0,      "name": "string",      "object": "product",      "offer": {        "embed": {          "dynamic": true,          "url": "string"        },        "expected_delivery_id": "string",        "free": {          "class_id": "string",          "duration": 0,          "duration_type": "string",          "enabled": true        },        "url": "string"      },      "position": 0,      "revision": "string",      "showcase_id": "string",      "status": "published",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Products19

Products in API v3: list products, create a product, retrieve a product, update a product, delete a product, list access schedules, create an access schedule, retrieve an access schedule, update an access schedule, delete an access schedule, list release rules, create a release rule, retrieve a release rule, update a release rule, delete a release rule, list product content, reorder product content, copy a product, publish a product.

Create a product POST

Creates a product in the given showcase. New products are created with the `draft` status. `position` is 1-based within the showcase; a value greater than the number of products places the product at the end. `external_id` must be unique among the account's products that are not in the trash; a duplicate value returns the `already_exists` error code.