Skip to main content
GET
Get Module Instance

Authorizations

Authorization
string
header
required

Company API Key

Headers

X-User-Timezone
string
required

User's timezone for timestamp formatting

Path Parameters

instance_id
string
required

The ID of the module instance

Response

Module instance details retrieved successfully

instance_name
string

Instance name

module_name
string

Module name

description
string

Module description

icon
string

Icon URL

schedule
object | null

Crontab schedule details, null if not scheduled

activation_type
string

How the module is activated

configurations
object[]
logs
object[]

Logs from the 3 most recent module runs