Skip to main content
GET
/
module
/
instance
/
list
List Module Instances
curl --request GET \
  --url https://api.getoutbox.ai/module/instance/list \
  --header 'Authorization: <api-key>'
[
  {
    "id": "<string>",
    "icon": "<string>",
    "status": "active",
    "instance_name": "<string>",
    "description": "<string>",
    "activation_type": "<string>",
    "custom_params": {},
    "variables": [
      {
        "name": "<string>",
        "description": "<string>",
        "type": "<string>",
        "required": true,
        "preset": true
      }
    ]
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.getoutbox.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Company API Key

Response

List of module instances retrieved successfully

​
id
string

Module instance ID

​
icon
string

Icon URL

​
status
enum<string>

Status based on most recent module run

Available options:
active,
running,
error
​
instance_name
string

Instance name

​
description
string

Module description

​
activation_type
string

How the module is activated

​
custom_params
object

Custom parameters

​
variables
object[]