Skip to main content
GET
/
module
/
instance
/
{instance_id}
Get Module Instance
curl --request GET \
  --url https://api.getoutbox.ai/module/instance/{instance_id} \
  --header 'Authorization: <api-key>' \
  --header 'X-User-Timezone: <x-user-timezone>'
{
  "instance_name": "<string>",
  "module_name": "<string>",
  "description": "<string>",
  "icon": "<string>",
  "schedule": {},
  "activation_type": "<string>",
  "configurations": [
    {
      "name": "<string>",
      "key": "<string>",
      "value": "<string>",
      "secret": true
    }
  ],
  "logs": [
    {
      "timestamp": "<string>",
      "message": "<string>",
      "type": "<string>"
    }
  ]
}

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

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