Blocks

Get a block action catalog and input definitions

Call directly when the block type is known, avoiding the full catalog. For example, quickbooks exposes quickbooks.runReport and all reportType choices, date/filter inputs and report output fields. Requires workflows:read. Unknown or hidden block types return 404. Provider permissions and region availability are checked only during execution.

get/blocks/{type}

Request

  • Base URL
    https://workflow.loopfour.ai/api/v1
  • URL
    https://workflow.loopfour.ai/api/v1/blocks/{type}
  • Auth
    API key in header x-api-key

Path parameters

typestring required

Response

Success

successunknown

Example response

{
  "data": {
    "type": "quickbooks",
    "name": "QuickBooks",
    "links": {
      "self": "/api/v1/blocks/quickbooks",
      "collection": "/api/v1/blocks"
    },
    "actions": [
      "quickbooks.runReport",
      "quickbooks.getInvoice"
    ],
    "inputs": [
      {
        "key": "reportType"
      }
    ],
    "outputs": [
      "Header",
      "Columns",
      "Rows"
    ],
    "subBlocks": [
      {
        "id": "reportType",
        "title": "Report",
        "type": "combobox",
        "options": [
          {
            "id": "ProfitAndLoss",
            "label": "Profit And Loss"
          }
        ]
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.