Get all workflows | Solvimon

curl https://test.api.solvimon.com/v1/workflows \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json"

{
  "data": [
    {
      "name": "Invoice Overdue Reminder",
      "type": "INVOICE",
      "reference": "INV_OVERDUE_REMINDER_2024",
      "status": "ACTIVE",
      "object_type": "workflow_definition",
      "id": "wf_9f8b7c6d5e4a3b2c1d0e",
      "description": "Workflow to send reminders for overdue invoices",
      "created_at": "2023-11-15T09:30:00Z",
      "updated_at": "2024-04-10T16:45:00Z",
      "customer_ids": [
        "cust_12345",
        "cust_67890"
      ],
      "invoice": {
        "variant": "TO_FINAL",
        "overdue": {
          "periods": [
            {
              "type": "DAY",
              "value": 7
            },
            {
              "type": "WEEK",
              "value": 2
            }
          ]
        }
      },
      "payment": {
        "variant": "FAILED_PAYMENT"
      }
    }
  ],
  "links": {
    "first": "https://api.solvimon.com/v1/workflows?limit=10&page=1",
    "current": "https://api.solvimon.com/v1/workflows?limit=10&page=1",
    "next": "https://api.solvimon.com/v1/workflows?limit=10&page=2"
  },
  "limit": 10,
  "page": 1,
  "total_number_of_pages": 5
}

Returns paginated workflow definitions for the authenticated platform. Use this to inspect workflow definitions, their target use cases, and their current status. Requires the WORKFLOW.VIEW permission.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

limitintegerOptional

The amount of records shown in the list

pageintegerOptional

The page which is going to be shown

order_bystringOptional

The parameter by which the response is ordered.

order_directionstringOptional

The order direction by which the response is ordered.

Response

datalist of objects

Page data.

linksobject

Pagination navigation links.

limitinteger or null

Page size limit used for this response.

pageinteger or null

Current page number (1-indexed).

total_number_of_pagesinteger or nullDeprecated

Deprecated. Not supported anymore.

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors