---
title: "Retrieve specific module"
method: GET
path: "/modules/{module_id}"
tags: ["Modules"]
---

# Retrieve specific module

`GET /modules/{module_id}`

## Request

- Base URL: `https://enterprise.knak.io/api/published/v1`
- URL: `https://enterprise.knak.io/api/published/v1/modules/{module_id}`
- 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)

Retrieve a specific [module](#tag/module_model)'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.

## Path parameters

- `module_id` string, required

## Response `200`

OK

- ModuleItem
  - `data` Module
    - `type` string
    - `id` string
    - `attributes` object
      - `id` string
      - `name` string
      - `type` 'email' | 'landing'
      - `status` 'draft' | 'final'
      - `category` object, nullable
        - `id` string
        - `name` string
      - `brand_ids` string[]
      - `variations` object[]: Optional elements of the module's latest published version that can be shown or hidden, listed in the order they appear in the module. Empty when the module has no variations.
        - `id` string, required: Identifier of the variation within the module.
        - `name` string, required: The variation's label, or a name derived from the element type when the module author did not label it.
        - `enabled_by_default` boolean, required: Whether the variation is shown in the module by default.
      - `created_at` string, date-time
      - `updated_at` string, date-time

## Other responses

- `401`: Unauthenticated
- `403`: Unauthorized
- `404`: Not Found - the module does not exist or has no published version

---

[API](https://skmtc.dev/knak/apis/knak-enterprise-api.md) - [All operations](https://skmtc.dev/knak/apis/knak-enterprise-api/llms.txt) - [OpenAPI document](https://skmtc.dev/knak/apis/knak-enterprise-api/revisions/31d2c94edfcc?raw)