Clarifymedical · Schema

WorkflowResponse

CompanyHealthcareDataAnalyticsHealthTechAPI

Properties

Name Type Description
data object The resource.
View JSON Schema on GitHub

JSON Schema

clarifymedical-workflow-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/clarifymedical/main/json-schema/clarifymedical-workflow-response-schema.json",
  "title": "WorkflowResponse",
  "x-generated": "2026-10-09",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/clarifymedical-openapi.json#/components/schemas/WorkflowResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "enum": [
            "workflow"
          ],
          "description": "The resource type; matches the `object` path parameter."
        },
        "id": {
          "type": "string",
          "description": "The unique ID of the resource."
        },
        "attributes": {
          "oneOf": [
            {
              "type": "object",
              "properties": {
                "_id": {
                  "type": "string",
                  "description": "The unique ID of the workflow."
                },
                "name": {
                  "type": "string",
                  "description": "The workflow’s display name."
                },
                "description": {
                  "type": "string",
                  "description": "A human-readable description of the workflow."
                },
                "enabled": {
                  "type": "boolean",
                  "description": "Whether the workflow is active and processing triggers."
                },
                "enabled_by": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The ID of the user who first enabled the workflow."
                },
                "published_at": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "The time the workflow was published, or null if it has never been published."
                },
                "exits": {
                  "default": {},
                  "type": "object",
                  "additionalProperties": {
                    "type": "object",
                    "properties": {
                      "_id": {
                        "type": "string",
                        "description": "The block identifier, unique within the workflow. The trigger block is always `trigger`."
                      },
                      "plugin_id": {
                        "type": "string",
                        "enum": [
                          "on:clarify:add-to-list",
                          "on:clarify:remove-from-list",
                          "on:clarify:set-relationship",
                          "on:clarify:unset-relationship",
                          "on:clarify:change-relationship",
                          "on:clarify:stream-event",
                          "on:clarify:automation-webhook",
                          "on:manual:execution",
                          "on:general:time:heartbeat",
                          "on:clarify:create:record",
                          "on:clarify:update:record",
                          "on:clarify:delete:record",
                          "on:clarify:upsert:record",
                          "on:email:bounce",
                          "on:email:click",
                          "on:email:open",
                          "on:email:reply",
                          "on:email:send",
                          "clarify:upsert:record",
                          "clarify:create:record",
                          "clarify:update:record",
                          "clarify:delete:record",
                          "clarify:find:records",
                          "clarify:set-relationship",
                          "clarify:unset-relationship",
                          "clarify:send:email",
                          "clarify:email-validation",
                          "clarify:linkedin:visit",
                          "clarify:linkedin:connect",
                          "clarify:linkedin:message",
                          "clarify:linkedin:inmail",
                          "webhook:send:outbound",
                          "code:execute",
                          "general:delay:for",
                          "ai:generate"
                        ],
                        "description": "The plugin that defines what this block does (for example `clarify:create:record`)."
                      },
                      "filters": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "field": {
                              "type": "string",
                              "description": "The path to the value the condition is tested against (for example `state.event.object.data.person.name`)."
                            },
                            "condition": {
                              "type": "object",
                              "additionalProperties": {},
                              "description": "The condition the field value must satisfy for the block to run."
                            }
                          },
                          "required": [
                            "field",
                            "condition"
                          ]
                        },
                        "description": "Conditions that must all pass for the block to run."
                      },
                      "input": {
                        "type": "object",
                        "additionalProperties": {},
                        "description": "The block’s configuration, keyed by input name."
                      },
                      "prev": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The `_id` of the previous block, or null for the trigger."
                      },
                      "next": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The `_id` of the next block, or null for the last block."
                      }
                    },
                    "required": [
                      "_id",
                      "plugin_id",
                      "filters",
                      "input",
                      "prev",
                      "next"
                    ]
                  },
                  "description": "Exit blocks keyed by block id, run when a record leaves the workflow."
                },
                "run_limits": {
                  "default": {},
                  "type": "object",
                  "properties": {
                    "max_runs_per_record": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "The maximum number of runs allowed per record. Null means unlimited."
                    },
                    "cooldown_period_days": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "The number of days a record must wait before it can re-enter the workflow."
                    }
                  },
                  "description": "Limits on how often a record can run through the workflow."
                },
                "_created_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "The time the workflow was created."
                },
                "_created_by": {
                  "type": "string",
                  "description": "The ID of the user who created the workflow."
                },
                "_updated_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "The time the workflow was last updated."
                },
                "_updated_by": {
                  "type": "string",
                  "description": "The ID of the user who last updated the workflow."
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "sequence"
                  ],
                  "description": "The workflow type. `sequence` workflows are email sequences (campaigns)."
                },
                "trigger": {
                  "type": "object",
                  "properties": {
                    "_id": {
                      "type": "string",
                      "description": "The block identifier, unique within the workflow. The trigger block is always `trigger`."
                    },
                    "plugin_id": {
                      "type": "string",
                      "enum": [
                        "clarify:email-validation",
                        "clarify:send:email",
                        "clarify:linkedin:visit",
                        "clarify:linkedin:connect",
                        "clarify:linkedin:message",
                        "clarify:linkedin:inmail",
                        "general:delay:for",
                        "on:clarify:add-to-list",
                        "on:manual:execution"
                      ],
                      "description": "The plugin that defines what this block does, restricted to plugins valid in sequence workflows."
                    },
                    "filters": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "field": {
                            "type": "string",
                            "description": "The path to the value the condition is tested against (for example `state.event.object.data.person.name`)."
                          },
                          "condition": {
                            "type": "object",
                            "additionalProperties": {},
                            "description": "The condition the field value must satisfy for the block to run."
                          }
                        },
                        "required": [
                          "field",
                          "condition"
                        ]
                      },
                      "description": "Conditions that must all pass for the block to run."
                    },
                    "input": {
                      "type": "object",
                      "additionalProperties": {},
                      "description": "The block’s configuration, keyed by input name."
                    },
                    "prev": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "The `_id` of the previous block, or null for the trigger."
                    },
                    "next": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "The `_id` of the next block, or null for the last block."
                    }
                  },
                  "required": [
                    "_id",
                    "plugin_id",
                    "filters",
                    "input",
                    "prev",
                    "next"
                  ],
                  "description": "The block that starts each run."
                },
                "blocks": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object",
                    "properties": {
                      "_id": {
                        "type": "string",
                        "description": "The block identifier, unique within the workflow. The trigger block is always `trigger`."
                      },
                      "plugin_id": {
                        "type": "string",
                        "enum": [
                          "clarify:email-validation",
                          "clarify:send:email",
                          "clarify:linkedin:visit",
                          "clarify:linkedin:connect",
                          "clarify:linkedin:message",
                          "clarify:linkedin:inmail",
                          "general:delay:for",
                          "on:clarify:add-to-list",
                          "on:manual:execution"
                        ],
                        "description": "The plugin that defines what this block does, restricted to plugins valid in sequence workflows."
                      },
                      "filters": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "field": {
                              "type": "string",
                              "description": "The path to the value the condition is tested against (for example `state.event.object.data.person.name`)."
                            },
                            "condition": {
                              "type": "object",
                              "additionalProperties": {},
                              "description": "The condition the field value must satisfy for the block to run."
                            }
                          },
                          "required": [
                            "field",
                            "condition"
                          ]
                        },
                        "description": "Conditions that must all pass for the block to run."
                      },
                      "input": {
                        "type": "object",
                        "additionalProperties": {},
                        "description": "The block’s configuration, keyed by input name."
                      },
                      "prev": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The `_id` of the previous block, or null for the trigger."
                      },
                      "next": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The `_id` of the next block, or null for the last block."
                      }
                    },
                    "required": [
                      "_id",
                      "plugin_id",
                      "filters",
                      "input",
                      "prev",
                      "next"
                    ]
                  },
                  "description": "The workflow’s blocks keyed by block id."
                }
              },
              "required": [
                "_id",
                "name",
                "description",
                "enabled",
                "published_at",
                "_created_at",
                "_created_by",
                "_updated_at",
                "_updated_by",
                "type",
                "trigger",
                "blocks"
              ]
            },
            {
              "type": "object",
              "properties": {
                "_id": {
                  "type": "string",
                  "description": "The unique ID of the workflow."
                },
                "name": {
                  "type": "string",
                  "description": "The workflow’s display name."
                },
                "description": {
                  "type": "string",
                  "description": "A human-readable description of the workflow."
                },
                "enabled": {
                  "type": "boolean",
                  "description": "Whether the workflow is active and processing triggers."
                },
                "enabled_by": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "description": "The ID of the user who first enabled the workflow."
                },
                "published_at": {
                  "type": [
                    "string",
                    "null"
                  ],
                  "format": "date-time",
                  "description": "The time the workflow was published, or null if it has never been published."
                },
                "exits": {
                  "default": {},
                  "type": "object",
                  "additionalProperties": {
                    "type": "object",
                    "properties": {
                      "_id": {
                        "type": "string",
                        "description": "The block identifier, unique within the workflow. The trigger block is always `trigger`."
                      },
                      "plugin_id": {
                        "type": "string",
                        "enum": [
                          "on:clarify:add-to-list",
                          "on:clarify:remove-from-list",
                          "on:clarify:set-relationship",
                          "on:clarify:unset-relationship",
                          "on:clarify:change-relationship",
                          "on:clarify:stream-event",
                          "on:clarify:automation-webhook",
                          "on:manual:execution",
                          "on:general:time:heartbeat",
                          "on:clarify:create:record",
                          "on:clarify:update:record",
                          "on:clarify:delete:record",
                          "on:clarify:upsert:record",
                          "on:email:bounce",
                          "on:email:click",
                          "on:email:open",
                          "on:email:reply",
                          "on:email:send",
                          "clarify:upsert:record",
                          "clarify:create:record",
                          "clarify:update:record",
                          "clarify:delete:record",
                          "clarify:find:records",
                          "clarify:set-relationship",
                          "clarify:unset-relationship",
                          "clarify:send:email",
                          "clarify:email-validation",
                          "clarify:linkedin:visit",
                          "clarify:linkedin:connect",
                          "clarify:linkedin:message",
                          "clarify:linkedin:inmail",
                          "webhook:send:outbound",
                          "code:execute",
                          "general:delay:for",
                          "ai:generate"
                        ],
                        "description": "The plugin that defines what this block does (for example `clarify:create:record`)."
                      },
                      "filters": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "field": {
                              "type": "string",
                              "description": "The path to the value the condition is tested against (for example `state.event.object.data.person.name`)."
                            },
                            "condition": {
                              "type": "object",
                              "additionalProperties": {},
                              "description": "The condition the field value must satisfy for the block to run."
                            }
                          },
                          "required": [
                            "field",
                            "condition"
                          ]
                        },
                        "description": "Conditions that must all pass for the block to run."
                      },
                      "input": {
                        "type": "object",
                        "additionalProperties": {},
                        "description": "The block’s configuration, keyed by input name."
                      },
                      "prev": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The `_id` of the previous block, or null for the trigger."
                      },
                      "next": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The `_id` of the next block, or null for the last block."
                      }
                    },
                    "required": [
                      "_id",
                      "plugin_id",
                      "filters",
                      "input",
                      "prev",
                      "next"
                    ]
                  },
                  "description": "Exit blocks keyed by block id, run when a record leaves the workflow."
                },
                "run_limits": {
                  "default": {},
                  "type": "object",
                  "properties": {
                    "max_runs_per_record": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "The maximum number of runs allowed per record. Null means unlimited."
                    },
                    "cooldown_period_days": {
                      "type": [
                        "number",
                        "null"
                      ],
                      "description": "The number of days a record must wait before it can re-enter the workflow."
                    }
                  },
                  "description": "Limits on how often a record can run through the workflow."
                },
                "_created_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "The time the workflow was created."
                },
                "_created_by": {
                  "type": "string",
                  "description": "The ID of the user who created the workflow."
                },
                "_updated_at": {
                  "type": "string",
                  "format": "date-time",
                  "description": "The time the workflow was last updated."
                },
                "_updated_by": {
                  "type": "string",
                  "description": "The ID of the user who last updated the workflow."
                },
                "type": {
                  "type": "string",
                  "enum": [
                    "system"
                  ],
                  "description": "The workflow type. `system` workflows back built-in features and are hidden."
                },
                "trigger": {
                  "type": "object",
                  "properties": {
                    "_id": {
                      "type": "string",
                      "description": "The block identifier, unique within the workflow. The trigger block is always `trigger`."
                    },
                    "plugin_id": {
                      "type": "string",
                      "enum": [
                        "on:clarify:add-to-list",
                        "on:clarify:remove-from-list",
                        "on:clarify:set-relationship",
                        "on:clarify:unset-relationship",
                        "on:clarify:change-relationship",
                        "on:clarify:stream-event",
                        "on:clarify:automation-webhook",
                        "on:manual:execution",
                        "on:general:time:heartbeat",
                        "on:clarify:create:record",
                        "on:clarify:update:record",
                        "on:clarify:delete:record",
                        "on:clarify:upsert:record",
                        "on:email:bounce",
                        "on:email:click",
                        "on:email:open",
                        "on:email:reply",
                        "on:email:send",
                        "clarify:upsert:record",
                        "clarify:create:record",
                        "clarify:update:record",
                        "clarify:delete:record",
                        "clarify:find:records",
                        "clarify:set-relationship",
                        "clarify:unset-relationship",
                        "clarify:send:email",
                        "clarify:email-validation",
                        "clarify:linkedin:visit",
                        "clarify:linkedin:connect",
                        "clarify:linkedin:message",
                        "clarify:linkedin:inmail",
                        "webhook:send:outbound",
                        "code:execute",
                        "general:delay:for",
                        "ai:generate"
                      ],
                      "description": "The plugin that defines what this block does (for example `clarify:create:record`)."
                    },
                    "filters": {
                      "type": "array",
                      "items": {
                        "type": "object",
                        "properties": {
                          "field": {
                            "type": "string",
                            "description": "The path to the value the condition is tested against (for example `state.event.object.data.person.name`)."
                          },
                          "condition": {
                            "type": "object",
                            "additionalProperties": {},
                            "description": "The condition the field value must satisfy for the block to run."
                          }
                        },
                        "required": [
                          "field",
                          "condition"
                        ]
                      },
                      "description": "Conditions that must all pass for the block to run."
                    },
                    "input": {
                      "type": "object",
                      "additionalProperties": {},
                      "description": "The block’s configuration, keyed by input name."
                    },
                    "prev": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "The `_id` of the previous block, or null for the trigger."
                    },
                    "next": {
                      "type": [
                        "string",
                        "null"
                      ],
                      "description": "The `_id` of the next block, or null for the last block."
                    }
                  },
                  "required": [
                    "_id",
                    "plugin_id",
                    "filters",
                    "input",
                    "prev",
                    "next"
                  ],
                  "description": "The block that starts each run."
                },
                "blocks": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "object",
                    "properties": {
                      "_id": {
                        "type": "string",
                        "description": "The block identifier, unique within the workflow. The trigger block is always `trigger`."
                      },
                      "plugin_id": {
                        "type": "string",
                        "enum": [
                          "on:clarify:add-to-list",
                          "on:clarify:remove-from-list",
                          "on:clarify:set-relationship",
                          "on:clarify:unset-relationship",
                          "on:clarify:change-relationship",
                          "on:clarify:stream-event",
                          "on:clarify:automation-webhook",
                          "on:manual:execution",
                          "on:general:time:heartbeat",
                          "on:clarify:create:record",
                          "on:clarify:update:record",
                          "on:clarify:delete:record",
                          "on:clarify:upsert:record",
                          "on:email:bounce",
                          "on:email:click",
                          "on:email:open",
                          "on:email:reply",
                          "on:email:send",
                          "clarify:upsert:record",
                          "clarify:create:record",
                          "clarify:update:record",
                          "clarify:delete:record",
                          "clarify:find:records",
                          "clarify:set-relationship",
                          "clarify:unset-relationship",
                          "clarify:send:email",
                          "clarify:email-validation",
                          "clarify:linkedin:visit",
                          "clarify:linkedin:connect",
                          "clarify:linkedin:message",
                          "clarify:linkedin:inmail",
                          "webhook:send:outbound",
                          "code:execute",
                          "general:delay:for",
                          "ai:generate"
                        ],
                        "description": "The plugin that defines what this block does (for example `clarify:create:record`)."
                      },
                      "filters": {
                        "type": "array",
                        "items": {
                          "type": "object",
                          "properties": {
                            "field": {
                              "type": "string",
                              "description": "The path to the value the condition is tested against (for example `state.event.object.data.person.name`)."
                            },
                            "condition": {
                              "type": "object",
                              "additionalProperties": {},
                              "description": "The condition the field value must satisfy for the block to run."
                            }
                          },
                          "required": [
                            "field",
                            "condition"
                          ]
                        },
                        "description": "Conditions that must all pass for the block to run."
                      },
                      "input": {
                        "type": "object",
                        "additionalProperties": {},
                        "description": "The block’s configuration, keyed by input name."
                      },
                      "prev": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The `_id` of the previous block, or null for the trigger."
                      },
                      "next": {
                        "type": [
                          "string",
                          "null"
                        ],
                        "description": "The `_id` of the next block, or null for the last block."
                      }
            

# --- truncated at 32 KB (49 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/clarifymedical/refs/heads/main/json-schema/clarifymedical-workflow-response-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/clarifymedical-workflow-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.