Flow Versions

List Flow Versions

get

Retrieves a paginated list of all versions for a specific flow.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flows/{flow}/versions

HTTPcURLJavaScriptPython

GET /api/v1/flows/{flow}/versions HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 0,
      "flow_id": 0,
      "flow_name": "string",
      "flow_priority": 0,
      "iteration": 0,
      "status": "Draft",
      "is_deployed": false,
      "is_editable": true,
      "deployed_at": null,
      "deployed_by": null,
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-01T00:00:00.000000Z",
      "has_callback_step": false,
      "latest_run": null,
      "steps": [],
      "schedules": []
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://core.wearepatchworks.com/api/v1/flows/4/versions",
    "per_page": 15,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://core.wearepatchworks.com/api/v1/flows/4/versions?page=1",
    "last": "https://core.wearepatchworks.com/api/v1/flows/4/versions?page=1",
    "prev": null,
    "next": null
  }
}

Create Flow Version

post

Creates a new draft version of a flow. Intended for use when a flow has no existing versions.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flows/{flow}/versions

HTTPcURLJavaScriptPython

POST /api/v1/flows/{flow}/versions HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 0,
    "flow_id": 0,
    "flow_name": "string",
    "flow_priority": 0,
    "iteration": 0,
    "status": "Draft",
    "is_deployed": false,
    "is_editable": true,
    "deployed_at": null,
    "deployed_by": null,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z",
    "has_callback_step": false,
    "latest_run": null,
    "steps": [],
    "schedules": []
  }
}

Get Flow Version

get

Retrieves the details of a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

versionstringRequired

The version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flows/{flow}/versions/{version}

HTTPcURLJavaScriptPython

GET /api/v1/flows/{flow}/versions/{version} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 0,
    "flow_id": 0,
    "flow_name": "string",
    "flow_priority": 0,
    "iteration": 0,
    "status": "Draft",
    "is_deployed": false,
    "is_editable": true,
    "deployed_at": null,
    "deployed_by": null,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z",
    "has_callback_step": false,
    "latest_run": null,
    "steps": [],
    "schedules": []
  }
}

Update Flow Version

put

Updates an existing flow version. Accepts a deployed_at timestamp.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

versionstringRequired

The version identifier.

Body

application/json

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/flows/{flow}/versions/{version}

HTTPcURLJavaScriptPython

PUT /api/v1/flows/{flow}/versions/{version} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "deployed_at": null
}

ExamplesSet deployed timestamp

{
  "data": {
    "id": 0,
    "flow_id": 0,
    "flow_name": "string",
    "flow_priority": 0,
    "iteration": 0,
    "status": "Draft",
    "is_deployed": false,
    "is_editable": true,
    "deployed_at": null,
    "deployed_by": null,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z",
    "has_callback_step": false,
    "latest_run": null,
    "steps": [],
    "schedules": []
  }
}

Delete Flow Version

delete

Permanently deletes a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

versionstringRequired

The version identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flows/{flow}/versions/{version}

HTTPcURLJavaScriptPython

DELETE /api/v1/flows/{flow}/versions/{version} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "string"
}

Copy Flow Version

post

Copies an existing deployed flow version into a new draft version. Any existing draft for that flow is overwritten.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

versionstringRequired

The version identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flows/{flow}/versions/{version}/copy

HTTPcURLJavaScriptPython

POST /api/v1/flows/{flow}/versions/{version}/copy HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 0,
    "flow_id": 0,
    "flow_name": "string",
    "flow_priority": 0,
    "iteration": 0,
    "status": "Draft",
    "is_deployed": false,
    "is_editable": true,
    "deployed_at": null,
    "deployed_by": null,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z",
    "has_callback_step": false,
    "latest_run": null,
    "steps": [],
    "schedules": []
  }
}

Upload Flow Version

post

Uploads a given flow version to your private marketplace.

This operation requires administrator permissions. If you are authorising requests with an API key, this request won't work (company-level API keys are associated with manager-level permissions). If you are an administrator, you can use OAuth 2 credentials to complete this operation. For more information please see our Authentication section.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flow_versionstringRequired

The flow version identifier.

Body

application/json

privatestringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/upload

HTTPcURLJavaScriptPython

POST /api/v1/flow-versions/{flow_version}/upload HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "private": "text"
}

{
  "message": "string"
}

List Flow Version Metrics

get

Retrieves paginated metrics for a flow's versions. Results can be filtered by time interval, metric type, and key.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flowstringRequired

The flow identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flows/{flow}/version-metrics

HTTPcURLJavaScriptPython

GET /api/v1/flows/{flow}/version-metrics HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 0,
      "flow_version_id": 0,
      "metric": "string",
      "key": "string",
      "value": 0,
      "recorded_at": "2024-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://core.wearepatchworks.com/api/v1/flows/4/version-metrics",
    "per_page": 15,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://core.wearepatchworks.com/api/v1/flows/4/version-metrics?page=1",
    "last": "https://core.wearepatchworks.com/api/v1/flows/4/version-metrics?page=1",
    "prev": null,
    "next": null
  }
}

List Flow Version Schedules

get

Retrieves a paginated list of all schedules for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/schedules

HTTPcURLJavaScriptPython

GET /api/v1/flow-versions/{flow_version}/schedules HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 0,
      "flow_version_id": 0,
      "cron_string": "string",
      "flow_template_schedule_id": null,
      "deleted_at": null,
      "created_at": "2024-01-01T00:00:00.000000Z",
      "updated_at": "2024-01-01T00:00:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://core.wearepatchworks.com/api/v1/flow-versions/6/schedules",
    "per_page": 15,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://core.wearepatchworks.com/api/v1/flow-versions/6/schedules?page=1",
    "last": "https://core.wearepatchworks.com/api/v1/flow-versions/6/schedules?page=1",
    "prev": null,
    "next": null
  }
}

Create Flow Version Schedule

post

Creates a new schedule for a flow version using a cron_string.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flow_versionstringRequired

The flow version identifier.

Body

application/json

cron_stringstringRequired

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/schedules

HTTPcURLJavaScriptPython

POST /api/v1/flow-versions/{flow_version}/schedules HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "cron_string": "string",
  "deployed_at": null
}

ExamplesHourly schedule

{
  "data": {
    "id": 0,
    "flow_version_id": 0,
    "cron_string": "string",
    "flow_template_schedule_id": null,
    "deleted_at": null,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Update Flow Version Schedule

put

Updates the cron_string for an existing flow version schedule.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flow_versionstringRequired

The flow version identifier.

schedulestringRequired

The schedule identifier.

Body

application/json

cron_stringstringOptional

deployed_atstring · date-time · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/flow-versions/{flow_version}/schedules/{schedule}

HTTPcURLJavaScriptPython

PUT /api/v1/flow-versions/{flow_version}/schedules/{schedule} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "cron_string": "string",
  "deployed_at": null
}

ExamplesUpdate to daily schedule

{
  "data": {
    "id": 0,
    "flow_version_id": 0,
    "cron_string": "string",
    "flow_template_schedule_id": null,
    "deleted_at": null,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
}

Delete Flow Version Schedule

delete

Permanently deletes a specific flow version schedule.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

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

Path parameters

flow_versionstringRequired

The flow version identifier.

schedulestringRequired

The schedule identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/schedules/{schedule}

HTTPcURLJavaScriptPython

DELETE /api/v1/flow-versions/{flow_version}/schedules/{schedule} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "string"
}