MCP is live.Set upAsk the community
OmniDimension
Dashboard
DocumentationAPI referenceSDKsMCP
Workflows

Get a workflow node type

The settings one node type reads, with their types, required flags and outputs. Call it before you add or edit a node, because its `fields` are the keys of the node's `config`. Use `detail=full` only when you need help text and examples.

Workflow builder. Included from the Jump Starter plan. See plans.

GET/workflow-node-types/
Path parameters
node_typerequired
Query parameters
detailstring · enum

full adds descriptions, examples and output_example.

curl -X GET 'https://backend.omnidim.io/api/v1/workflow-node-types/{node_type}?detail=minimal' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
synthetic
{
  "type": {
    "type": "string",
    "label": "string",
    "category": "string",
    "kind": "trigger",
    "description": "string",
    "sends": false,
    "fields": "string",
    "outputs": [
      "string"
    ],
    "output_example": "string"
  }
}

Authorization

BearerAuth
headerAuthorizationBearer <token>

Bearer token authentication. Obtain your API key from the OmniDimension dashboard.

Path Parameters

node_type*string

A node type from listWorkflowNodeTypes, such as whatsapp.

Query Parameters

detail?string

full adds descriptions, examples and output_example.

Default"minimal"
Value in"minimal""full"

Response body

application/json

Response Body

The node type.

application/json
type?

One node type with the settings it reads.

List workflow node types

Search the node types a workflow can use, such as `whatsapp`, `voice_ai` or `conditional`. Call it first when you do not know which node to add. Then call `getWorkflowNodeType` for the settings of one type.

List choices for a node field

The choices for one `ref` field of a node type, such as the phone numbers, agents or integrations in your account. Call it for every `ref` field and never guess an id. If it returns `400 no_options`, the field is not chosen from a list, so ask the user for the value.