Workflows

List Workflows

post

Retrieves all workflows for the authenticated user.

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Responses

200Success

application/json

401

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

post

/api/workflows/list

HTTPcURLJavaScriptPython

POST /api/workflows/list HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "workflows": [
    {
      "created_by": "text",
      "creation_time": "2026-03-28T09:13:09.532Z",
      "description": "text",
      "id": "text",
      "interval": 1,
      "invalid": true,
      "last_execution_started": "2026-03-28T09:13:09.532Z",
      "last_execution_status": "text",
      "last_execution_time": "2026-03-28T09:13:09.532Z",
      "last_updated": "2026-03-28T09:13:09.532Z",
      "name": "text",
      "providers": [
        {
          "id": null,
          "installed": true,
          "name": "text",
          "type": "text"
        }
      ],
      "revision": 1,
      "triggers": [
        {
          "type": "text"
        }
      ],
      "workflow_raw": "text",
      "workflow_raw_id": "text"
    }
  ]
}

Create Workflow

post

Creates a new workflow from the provided definition.

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Body

text/plain

stringOptional

Responses

202Success

application/json

400

ErrorResponse defines a common error response structure.

application/json

401

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

post

/api/workflows/create

HTTPcURLJavaScriptPython

POST /api/workflows/create HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Content-Type: text/plain
Accept: */*
Content-Length: 6

"text"

{
  "revision": 1,
  "status": "text",
  "workflow_id": "text"
}

Delete Workflow

delete

Deletes a workflow by its unique identifier.

Required scopes

This endpoint requires the following scopes:

Authorizations

Bearer

AuthorizationstringRequired

Path parameters

idstringRequired

Unique identifier of the workflow to delete

Responses

200Success

application/json

400

ErrorResponse defines a common error response structure.

application/json

401

ErrorResponse defines a common error response structure.

application/json

500

ErrorResponse defines a common error response structure.

application/json

delete

/api/workflows/{id}

HTTPcURLJavaScriptPython

DELETE /api/workflows/{id} HTTP/1.1
Host: api.groundcover.com
Authorization: YOUR_API_KEY
Accept: */*

No content