Scheduled Flows

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

• flowVersion

• flowVersion_count

• flowVersionExists

• payloadMetadata

• payloadMetadata_count

• payloadMetadataExists

• flow

• flow_count

• flowExists

• virtualEnvironmentVersion

• virtualEnvironmentVersion_count

• virtualEnvironmentVersionExists

• virtualEnvironmentVersion.virtualEnvironment

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• status

• flow_version_id

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• status

• created_at

• updated_at

• flow_version_id

Authorizations

ApiKeyAuth

Query parameters

filter[status]stringOptional

Filter results by status.

filter[flow_version_id]stringOptional

Filter results by flow_version_id.

includestringOptional

Comma-separated list of relationships to include. Available: flowVersion, payloadMetadata, flow, virtualEnvironmentVersion, virtualEnvironmentVersion.virtualEnvironment

sortstringOptional

Sort field. Prefix with - for descending. Available: status, created_at, updated_at, flow_version_id

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/scheduled-flows

HTTPcURLJavaScriptPython

GET /api/v1/scheduled-flows HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "flow_version_id": 1,
      "flow_version": {},
      "virtual_environment_version_id": 1,
      "virtual_environment_version": {},
      "payload_metadata_id": 1,
      "payload_metadata": {},
      "trigger": "API",
      "status": "Draft",
      "flow": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/scheduled-flows",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/scheduled-flows?page=1",
    "last": "https://api.example.com/api/v1/scheduled-flows?page=1",
    "prev": null,
    "next": null
  }
}

Delete-All

delete

Delete-All for scheduled flows.

Authorizations

ApiKeyAuth

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/scheduled-flows

HTTPcURLJavaScriptPython

DELETE /api/v1/scheduled-flows HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Delete-By-Flow

delete

Delete-By-Flow for delete.

Authorizations

ApiKeyAuth

Path parameters

flowstringRequired

The flow identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/scheduled-flows/{flow}/delete

HTTPcURLJavaScriptPython

DELETE /api/v1/scheduled-flows/{flow}/delete HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Destroy

delete

Delete a scheduled flow.

Authorizations

ApiKeyAuth

Path parameters

scheduled_flowstringRequired

The scheduled flow identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/scheduled-flows/{scheduled_flow}

HTTPcURLJavaScriptPython

DELETE /api/v1/scheduled-flows/{scheduled_flow} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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