---
title: "Module Search By ID"
method: GET
path: "/module/{moduleId}"
tags: ["module"]
---

# Module Search By ID

`GET /module/{moduleId}`

Get the Module object specified by the provided moduleId

## Path parameters

- `moduleId` string, required

## Response `200`

successful operation

- Module — Class Module
  - `moduleId` integer — The ID of this Module
  - `name` string — Module Name
  - `author` string — Module Author
  - `description` string — Description of the Module
  - `icon` string — An icon to use in the toolbar
  - `type` string — The type code for this module
  - `legacyTypes` LegacyType[] — Legacy type codes for this module
    - `name` unknown
    - `condition` unknown
  - `dataType` string — The data type of the data expected to be returned by this modules data provider
  - `group` string[] — The group details for this module
  - `dataCacheKey` string — The cache key used when requesting data
  - `fallbackData` integer — Is fallback data allowed for this module? Only applicable for a Data Widget
  - `regionSpecific` integer — Is specific to a Layout or can be uploaded to the Library?
  - `schemaVersion` integer — The schema version of the module
  - `compatibilityClass` string — The compatibility class of the module
  - `showIn` string — A flag indicating whether the module should be excluded from the Layout Editor
  - `assignable` integer — A flag indicating whether the module is assignable to a Layout
  - `hasThumbnail` integer — Does this module have a thumbnail to render?
  - `thumbnail` string — This is the location to a module's thumbnail
  - `renderAs` string — Should be rendered natively by the Player or via the CMS (native|html)
  - `class` string — Class Name including namespace
  - `validatorClass` string[] — Validator class name including namespace
  - `properties` Property[] — Properties to display in the property panel and supply to stencils
    - `id` string — ID, saved as a widget option
    - `type` string — Type, determines the field type
    - `title` string — Title: shown in the property panel
    - `helpText` string — Help Text: shown in the property panel
    - `default` string — An optional default value
  - `onInitialize` string — JavaScript function run when a module is initialised, before data is returned
  - `onParseData` string — Data Parser run against each data item applicable when a dataType is present
  - `onDataLoad` string — A load function to run when the widget first fetches data
  - `onRender` string — JavaScript function run when a module is rendered, after data has been returned
  - `onVisible` string — JavaScript function run when a module becomes visible
  - `sampleData` string — Optional sample data item, only applicable when a dataType is present
  - `enabled` integer — A flag indicating whether this module is enabled
  - `previewEnabled` integer — A flag indicating whether the Layout designer should render a preview of this module
  - `defaultDuration` integer — The default duration for Widgets of this Module when the user has not set a duration.
  - `settings` Property[] — An array of additional module specific settings
    - `id` string — ID, saved as a widget option
    - `type` string — Type, determines the field type
    - `title` string — Title: shown in the property panel
    - `helpText` string — Help Text: shown in the property panel
    - `default` string — An optional default value
  - `propertyGroups` PropertyGroup[] — An array of additional module specific group properties
    - `id` unknown
    - `expanded` unknown
    - `title` unknown
    - `helpText` unknown
  - `requiredElements` string[] — An array of required elements
  - `isInstalled` boolean — $isInstalled Is this module installed?
  - `isError` boolean — $isError Does this module have any errors?
  - `errors` string[] — $errors An array of errors this module has.

---

[API](https://skmtc.net/xibosignage/apis/xibo-api.md) · [All operations](https://skmtc.net/xibosignage/apis/xibo-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/xibosignage/xibo-api/revisions/fe497e811c7f/schema)