Search workflows | Solvimon

curl -X POST https://test.api.solvimon.com/v1/workflows/search \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "search_fields": [
    {
      "value": "paymentStatus",
      "wildcard_start": true,
      "wildcard_end": true,
      "ignore_case": true
    }
  ],
  "filter_fields": [
    {
      "name": "workflowType",
      "values": [
        "INVOICE"
      ]
    }
  ],
  "selection_rule_fields": [
    {
      "name": "status"
    }
  ]
}'

{
  "data": [
    {
      "name": "Invoice Payment Workflow",
      "type": "INVOICE",
      "reference": "INV-WF-2024-001",
      "status": "ACTIVE",
      "object_type": "workflow_definition",
      "id": "wf_1234567890abcdef",
      "description": "Workflow to handle invoice payment processing and overdue notifications.",
      "created_at": "2023-11-01T09:15:00Z",
      "updated_at": "2024-04-20T16:45:00Z",
      "customer_ids": [
        "cust_9876543210fedcba"
      ],
      "invoice": {
        "variant": "TO_FINAL",
        "overdue": {
          "periods": [
            {
              "type": "DAY",
              "value": 30
            },
            {
              "type": "WEEK",
              "value": 1
            }
          ]
        }
      },
      "payment": {
        "variant": "FAILED_PAYMENT"
      }
    }
  ],
  "links": {
    "first": "https://api.solvimon.com/v1/workflows/search?page=1&limit=1",
    "previous": "https://api.solvimon.com/v1/workflows/search?page=0&limit=1",
    "current": "https://api.solvimon.com/v1/workflows/search?page=1&limit=1",
    "next": "https://api.solvimon.com/v1/workflows/search?page=2&limit=1"
  },
  "limit": 1,
  "page": 1,
  "total_number_of_pages": 5
}

Searches workflow definitions with the provided search body and optional query filters. 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

expand[]list of stringsOptional

The id fields of the resources that are going to be expanded.

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.

statuses[]list of stringsOptional

Filter workflows by one or more statuses such as ACTIVE, INACTIVE, DRAFT, or ARCHIVED.

Request

This endpoint expects an object.

search_fieldslist of objectsRequired

filter_fieldslist of objectsRequired

selection_rule_fieldslist of objectsRequired

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