Developers
Products

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
Range1 <= value <= 200
cursor?string
sort?string

Value in

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

Value in

  • "published"
  • "draft"
  • "unlisted"
  • "hidden"
external_id?string
q?string
deleted?boolean

Response Body

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": null,      "deleted": true,      "display": null,      "external_id": "string",      "format": "course",      "id": "string",      "image": "string",      "lessons_count": 0,      "modules_count": 0,      "name": "string",      "object": "product",      "offer": null,      "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"  }}

Products

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