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

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.

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

GET/workflow-node-types//options/
Path parameters
node_typerequired
fieldrequired
Query parameters
user_idinteger

Reseller keys only: the id of one of your direct client users. The call then acts as that client, on that client's agents, numbers, campaigns and balance. Calls, sessions and bulk campaigns spend that client's balance and concurrency. Omit it to act on your own account. An empty value, 0, false or your own user id also means your own account. Any other value that is not a positive integer id is refused with 400 invalid_request. A key that is not a reseller's gets 403 when it names someone else. A user who is not your direct client gets 404.

dependsinteger

The value of the field this one depends on (depends_on in the node type), such as the chosen phone number id.

curl -X GET 'https://backend.omnidim.io/api/v1/workflow-node-types/{node_type}/options/{field}' \
  -H 'Authorization: Bearer YOUR_API_KEY'
Example response
synthetic
{
  "options": [
    {
      "id": 0,
      "label": "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.

field*string

A field name from getWorkflowNodeType.

Query Parameters

user_id?integer

Reseller keys only: the id of one of your direct client users. The call then acts as that client, on that client's agents, numbers, campaigns and balance. Calls, sessions and bulk campaigns spend that client's balance and concurrency. Omit it to act on your own account. An empty value, 0, false or your own user id also means your own account. Any other value that is not a positive integer id is refused with 400 invalid_request. A key that is not a reseller's gets 403 when it names someone else. A user who is not your direct client gets 404.

depends?integer

The value of the field this one depends on (depends_on in the node type), such as the chosen phone number id.

Response body

application/json

Response Body

Up to 100 choices.

application/json
options?

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.

List workflows

Your workflows, oldest first, one cursor page at a time. Use it to find a workflow id. Pass back `next_cursor` until it is `null`.