KNknak
Modules

List all modules

Retrieve all modules in your organization that have at least one published version. Modules without a published version are not returned. Each module lists its variations: optional elements that can be shown or hidden.

get/modules

Request

Query parameters

filter[name]string
Example:Hero Banner

Filter modules by name. Exact match filter.

filter[type]'email' | 'landing'
Example:email

Filter modules by type. Exact match filter.

filter[brand_id]string
Example:63eff7760568a

Filter modules by associated brand. Accepts one or more comma-separated brand IDs and returns modules associated with any of the given brands.

sortstring
Example:created_at

Sort modules by field (created_at, updated_at).

pageinteger

Page number

per_pageinteger

Number of items per page

Response

OK

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"
      }
    }
  ],
  "links": {
    "first": "https://enterprise.knak.io/api/published/v1/modules?page=1",
    "last": "https://enterprise.knak.io/api/published/v1/modules?page=3",
    "prev": "https://enterprise.knak.io/api/published/v1/modules?page=1",
    "next": "https://enterprise.knak.io/api/published/v1/modules?page=3"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 3,
    "links": [
      {
        "url": "https://enterprise.knak.io/api/published/v1/modules?page=2",
        "label": "Next",
        "active": true
      }
    ],
    "path": "https://enterprise.knak.io/api/published/v1/modules?page=2",
    "per_page": 10,
    "to": 2,
    "total": 2
  }
}

Changes

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