List Workflows

GET

https://api.coperniq.io/v1/workflows

GET

/v1/workflows

1 const url = 'https://api.coperniq.io/v1/workflows';
2 const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

200Retrieved

1 [
2   {
3     "id": 1,
4     "name": "string",
5     "description": "string",
6     "type": "PROJECT",
7     "createdAt": "2024-01-15T09:30:00Z",
8     "updatedAt": "2024-01-15T09:30:00Z",
9     "createdBy": {
10       "id": 1,
11       "firstName": "string",
12       "lastName": "string",
13       "avatarUrl": "string"
14     },
15     "phases": [
16       {
17         "id": 1,
18         "name": "string",
19         "type": "string",
20         "description": "string",
21         "redSla": 1,
22         "yellowSla": 1
23       }
24     ]
25   }
26 ]

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

idintegerOptional

Workflow identifier

namestringOptional

Workflow name

descriptionstring or nullOptional

Workflow description

typeenumOptional

Workflow type

createdAtstringOptionalformat: "date-time"

Creation timestamp

updatedAtstringOptionalformat: "date-time"

Last update timestamp

createdByobject or nullOptional

phaseslist of objectsOptional