Get a smart module

GET/homes/{homeId}/smartModules/{moduleId}

Base URL: https://api.tinkermode.com

Get the info on the specified Smart Module.

Authentication

Send an Authorization header of the form ModeCloud <AUTH_CODE>.

Must contain a user, service account, or project API key.

Path parameters

Name	Type	Required	Constraints	Description
`homeId`	integer	Yes		The unique ID for a specified home.
`moduleId`	string	Yes		Module ID

Responses

`200` The requested Smart Module is returned. Only public information such as description will be included.

Content type: application/json

Property	Type	Required	Constraints	Description
`bulkDataLabel`	string	No		If module accepts bulk data, this is an identifier for bulk data upload.
`configData`	object	No		Configuration data. Used only during creation/update of the Smart Module.
`creationTime`	string	No	read-only (server-generated); format: date-time	Timestamp of entry creation.
`dataSourceModules`	array<string>	No	unique items	If module uses other modules as data sources, this is the list of module IDs of the data sources.
`description`	string	Yes		A short description of the Smart Module.
`id`	string	Yes	read-only (server-generated); pattern: ^[a-z0-9][a-z0-9_\-]+[a-z0-9]$	Smart Module ID. Must be unique within the project. Must be 3 or more lowercase alphanumeric characters; dashes ('-') and underscores ('_') may be used after the first character but must be followed by 1+ lowercase alphanumeric characters.
`moduleType`	string	Yes		Type of Smart Module. Must be one of the recognized type IDs.
`subscribedEvents`	array<string>	No	unique items	If module accepts events, this is the list of event types the Smart Module subscribes to.
`suspended`	boolean	No		Set to true to disable this Smart Module.

Response example

{
  "description": "Webhook for device commands",
  "id": "001",
  "moduleType": "webhooks",
  "suspended": false
}

`401` Authorization is required to access this resource.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`403` Request failed because of denied permission.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`404` The requested smartModule does not exist or is not accessible.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`429` Request failed because of rate limit.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`500` An unexpected error has occurred.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.

`503` The service is temporarily unavailable.

Content type: application/json

Property	Type	Required	Constraints	Description
`data`	object	No	read-only (server-generated)	Any relevant data related to error.
`reason`	string	Yes	read-only (server-generated)	Reason of error.