Developers
Modules9

List module contents

GET/products/{product_id}/modules/{module_id}/content

Returns the direct contents of a module, meaning its submodules and the lessons placed directly in it, in display order. Items in the trash are not included.

All entries are returned in a single response while preserving the standard collection response format.

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

Public ID of the product, prefixed with prd_.

module_id*string

Public ID of the module, prefixed with mod_.

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

curl -X GET "https://example.com/products/string/modules/string/content"
{  "data": [    {      "id": "string",      "kind": "module",      "name": "string",      "object": "content_entry",      "position": 0,      "status": "published"    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Delete a module DELETE

Moves the module to the trash, together with its submodules and lessons. Copies of the module in replicated accounts are also moved to the trash. Restoring the module through the update operation does not restore those copies. Replicated modules cannot be deleted. Attempts to delete them return the `replica_readonly` error code.

Reorder module contents PUT

Sets the display order of the submodules and lessons placed directly in the module. The `ids` array accepts both module public IDs (`mod_`) and lesson public IDs (`les_`) in the desired order. For each kind of item you send, the array must contain the complete set of items of that kind currently in the module. If the supplied set does not match, the API returns the `order_set_mismatch` error code and the existing order remains unchanged. To avoid overwriting concurrent changes, send the module `ETag` from the retrieve operation in the `If-Match` header.