Retrieve specific module

Retrieve a specific module's metadata, given its module ID. Only modules with at least one published version are returned. Each module lists its variations: optional elements that can be shown or hidden.

get/modules/{module_id}

Request

Base URL
https://enterprise.knak.io/api/published/v1
Auth
none declared
TypeScript
https://skmtc.dev/knak/apis/knak-enterprise-api/docs/modules/:module_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

module_idstring required

ID of module

Response

Example response

{
  "data": {
    "type": "module",
    "id": "63eff78889f21",
    "attributes": {
      "id": "63eff78889f21",
      "name": "Hero Banner",
      "type": "email",
      "status": "final",
      "category": {
        "id": "63eff7760568b",
        "name": "Headers"
      },
      "brand_ids": [
        "63eff7760568a"
      ],
      "variations": [
        {
          "id": "05283c93-3855-4810-a927-ff30aa3d4805",
          "name": "Speaker bio",
          "enabled_by_default": true
        },
        {
          "id": "9b1f6c2e-4d7a-4f3b-8e21-7c5d0a9e3f12",
          "name": "Button variation",
          "enabled_by_default": false
        }
      ],
      "created_at": "2023-05-17T21:54:19Z",
      "updated_at": "2023-05-18T19:55:21Z"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.