Skip to main content
GET
/
content
/
api
/
v4
/
custom_widgets
/
{id}
Get the details for a module by ID
curl --request GET \
  --url https://api.hubapi.com/content/api/v4/custom_widgets/{id}
{
  "authorAt": 1704317276220,
  "categories": [],
  "contentTags": [],
  "contentTypes": [
    "LANDING_PAGE",
    "SITE_PAGE"
  ],
  "created": 1589381258170,
  "createdById": 5,
  "css": "/* cool CSS */",
  "cssAssets": [],
  "cssCdnUri": "",
  "cssRenderOptions": {
    "async": true
  },
  "default": false,
  "deleted": false,
  "deletedAt": 0,
  "externalJs": [],
  "externalJsRenderOptions": {},
  "extraClasses": "",
  "fields": [
    {
      "allow_new_line": false,
      "default": "Hello world",
      "display_width": null,
      "help_text": "",
      "id": "video_title",
      "label": "Video Title",
      "locked": false,
      "name": "video_title",
      "required": true,
      "show_emoji_picker": false,
      "type": "text",
      "validation_regex": ""
    }
  ],
  "filename": "My Module",
  "folderId": 99988,
  "folderPath": "my-theme/modules",
  "global": false,
  "hostTemplateTypes": [
    "PAGE"
  ],
  "id": 12345678910,
  "inheritedAsset": false,
  "inlineHelpText": "",
  "isAvailableForNewContent": true,
  "isJsModule": false,
  "jsAssets": [],
  "jsRenderOptions": null,
  "messages": {},
  "minifiedCssCdnUri": "https://cdn2.hubspot.net/hub/1234/hub_generated/module_assets/012345678910/987/module_012345678910_My_Module.min.css",
  "moduleId": 12345678910,
  "name": "My Module",
  "otherAssets": [],
  "path": "/my-theme/modules/My Module",
  "placeholder": null,
  "portalId": 1234,
  "previewKey": "WLh7vw4zt8G1fuvBuBTmCQ",
  "purchased": false,
  "schemaVersion": 2,
  "smartObjects": [],
  "smartType": "NOT_SMART",
  "source": "<!-- HTML source -->",
  "tags": [],
  "updated": 1704317276220,
  "updatedById": 1122,
  "writeable": true
}

Path Parameters

id
string
required

The ID of the module to fetch the details for

Response

200 - application/json

Successful response

id
integer

The unique ID of the module

name
string

The name of the module

path
string

The path of the module

source
string

The HTML source of the module

css
string

The CSS for the module

fields
object[]

The fields/parameters of the module

global
boolean

Whether this is a global module

isAvailableForNewContent
boolean

Whether the module is available for new content

created
integer

When the module was created

updated
integer

When the module was last updated