List Workflows | Coperniq API

const url = 'https://api.coperniq.io/v1/workflows';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

[
  {
    "id": 1,
    "name": "string",
    "description": "string",
    "type": "PROJECT",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "createdBy": {
      "id": 1,
      "firstName": "string",
      "lastName": "string",
      "avatarUrl": "string"
    },
    "phases": [
      {
        "id": 1,
        "name": "string",
        "type": "string",
        "description": "string",
        "redSla": 1,
        "yellowSla": 1
      }
    ]
  }
]

Retrieve a paginated list of workflows.

Supports:

Pagination (page_size, page)
Sorting (order_by, default: asc)

Retrieve a paginated list of workflows. Supports: - Pagination (`page_size`, `page`) - Sorting (`order_by`, default: asc)

Authentication

x-api-keystring

API Key authentication via header

Response

List of workflows

idinteger

Workflow identifier

namestring

Workflow name

descriptionstring or null

Workflow description

typeenum

Workflow type

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

createdByobject or null

phaseslist of objects