Search workflow triggers | Solvimon

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

{
  "data": [
    {
      "workflow_id": "string",
      "type": "MANUAL",
      "object_type": "string",
      "id": "string",
      "customer_id": "string",
      "invoice": {
        "invoice_id": "string",
        "event": {
          "variant": "TO_FINAL",
          "overdue": {
            "period": {
              "type": "DAY",
              "value": 1
            }
          }
        },
        "manual": {
          "variant": "TO_FINAL",
          "user_id": "string",
          "overdue": {
            "period": {
              "type": "DAY",
              "value": 1
            }
          }
        }
      },
      "payment": {
        "payment_id": "string",
        "event": {
          "variant": "FAILED_PAYMENT"
        },
        "manual": {
          "variant": "FAILED_PAYMENT",
          "user_id": "string"
        }
      }
    }
  ],
  "links": {
    "first": "string",
    "previous": "string",
    "current": "string",
    "next": "string"
  },
  "limit": 1,
  "page": 1,
  "total_number_of_pages": 1
}

Searches workflow trigger records with the provided search body plus pagination and ordering query parameters. Requires the WORKFLOW_TRIGGER.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. default = name

order_directionstringOptional

The parameter for the response ordering direction (asc, desc) default asc

Request

This endpoint expects an object.

search_fieldslist of objectsRequired

filter_fieldslist of objectsRequired

selection_rule_fieldslist of objectsRequired

Response

datalist of objects

Workflow trigger records returned for the current page.

linksobject

Navigation links for related pages.

limitinteger or null

Maximum number of records included in the page.

pageinteger or null

Current page number, starting at 1.

total_number_of_pagesinteger or nullDeprecated

Legacy page count value kept for compatibility.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error