Flow Templates

List Flow Templates

get

Retrieves a paginated list of flow templates included in marketplace blueprints.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters

filter[name]stringOptional

Filter results by name.

filter[hidden_from_marketplace]stringOptional

Filter results by hidden_from_marketplace.

filter[visible_for_marketplace]stringOptional

Filter results by visible_for_marketplace.

filter[id]stringOptional

Filter results by id.

filter[blueprint_id]stringOptional

Filter results by blueprint_id.

filter[,]stringOptional

Filter results by ,.

filter[marketplaceApps]stringOptional

Filter results by marketplaceApps.

filter[marketplace_apps.blueprint_id]stringOptional

Filter results by marketplace_apps.blueprint_id.

filter[blueprint_version_number]stringOptional

Filter results by blueprint_version_number.

filter[marketplace_apps.version]stringOptional

Filter results by marketplace_apps.version.

filter[private]stringOptional

Filter results by private.

filter[visibility]stringOptional

Filter results by visibility.

includestringOptional

Comma-separated list of relationships to include. Available: systemTemplates.logo, flowStepTemplates, flowStepTemplates.children, flowStepTemplates.parentFlowStep, flowTemplateSchedules, marketplaceCompany, publicCompany, marketplaceApps

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/patchworks/flow-templates

HTTPcURLJavaScriptPython

GET /api/v1/patchworks/flow-templates HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/patchworks/flow-templates",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/patchworks/flow-templates?page=1",
    "last": "https://api.example.com/api/v1/patchworks/flow-templates?page=1",
    "prev": null,
    "next": null
  }
}

Get Flow Template

get

Retrieves the details of a specific flow template included in a marketplace blueprint.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_templatestringRequired

The flow template identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[hidden_from_marketplace]stringOptional

Filter results by hidden_from_marketplace.

filter[visible_for_marketplace]stringOptional

Filter results by visible_for_marketplace.

filter[id]stringOptional

Filter results by id.

filter[blueprint_id]stringOptional

Filter results by blueprint_id.

filter[,]stringOptional

Filter results by ,.

filter[marketplaceApps]stringOptional

Filter results by marketplaceApps.

filter[marketplace_apps.blueprint_id]stringOptional

Filter results by marketplace_apps.blueprint_id.

filter[blueprint_version_number]stringOptional

Filter results by blueprint_version_number.

filter[marketplace_apps.version]stringOptional

Filter results by marketplace_apps.version.

filter[private]stringOptional

Filter results by private.

filter[visibility]stringOptional

Filter results by visibility.

includestringOptional

Comma-separated list of relationships to include. Available: systemTemplates.logo, flowStepTemplates, flowStepTemplates.children, flowStepTemplates.parentFlowStep, flowTemplateSchedules, marketplaceCompany, publicCompany, marketplaceApps

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/patchworks/flow-templates/{flow_template}

HTTPcURLJavaScriptPython

GET /api/v1/patchworks/flow-templates/{flow_template} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Delete Flow Template

delete

Permanently deletes a specific flow template.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_templatestringRequired

The flow template identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/patchworks/flow-templates/{flow_template}

HTTPcURLJavaScriptPython

DELETE /api/v1/patchworks/flow-templates/{flow_template} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Action completed successfully."
}

List Flow Template Steps

get

Retrieves a paginated list of steps for a specific flow template.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_templatestringRequired

The flow template identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/patchworks/flow-templates/{flow_template}/steps

HTTPcURLJavaScriptPython

GET /api/v1/patchworks/flow-templates/{flow_template}/steps HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "label": "My Label",
      "colour": "blue",
      "logo_url": "example_logo_url",
      "version": 1,
      "version_name": "example_version_name",
      "rate_limit_unit": "second",
      "rate_limit_duration": 1,
      "system_type_id": 1,
      "protocol": "HTTP",
      "company_id": 1,
      "date_format": "example_date_format",
      "help_link": "example_help_link",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/patchworks/flow-templates/{flow_template}/steps",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/patchworks/flow-templates/{flow_template}/steps?page=1",
    "last": "https://api.example.com/api/v1/patchworks/flow-templates/{flow_template}/steps?page=1",
    "prev": null,
    "next": null
  }
}

Install Flow Template

post

Installs a specific flow template from a marketplace blueprint.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_templatestringRequired

The flow template identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-templates/{flow_template}/install

HTTPcURLJavaScriptPython

POST /api/v1/flow-templates/{flow_template}/install HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}