Developers
Modules

List modules

GET/products/{product_id}/modules

Returns the modules and groups of a product, ordered by position and paginated with a cursor.

The collection can be filtered by parent group, status, kind, and deletion state.

If the product is not accessible with the current credentials, the API returns 404 Not Found instead of an empty collection.

Authorization

AuthorizationBearer <token>

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

In: header

Path Parameters

product_id*string

Query Parameters

limit?integer
Range1 <= value <= 200
cursor?string
sort?string

Value in

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

Value in

  • "published"
  • "draft"
kind?string

Value in

  • "group"
  • "module"
deleted?boolean

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

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

Modules

Modules in API v3: list modules, create a module, retrieve a module, update a module, delete a module, list module contents, reorder module contents, duplicate a module, publish a module.

Create a module POST

Creates a module or, when `kind` is `group`, a group of modules in the product. New modules are created as `draft`. To create a submodule, set `parent_id` to the public ID of a group in the same product. Modules cannot be created in replicated products. Attempts to do so return the `replica_readonly` error code.