ZUzuper

Get Workflow

Changed on

Lists workflow automation rules.

get/workflow

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/workflow
  • Auth
    API key in header x-api-key

Query parameters

pageinteger
countinteger
sort'"ASC"' | '"DESC"'
sort_by'"workflow_name"' | '"created_at"'
filter.keywordstring
filter.trigger_modulestring
filter.trigger_eventstring
filter.workflow_accessstring
filter.created_bystring
filter.is_activeboolean

Response

200

typestring
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "workflow_name": "Rquest note",
      "workflow_description": "Rquest note",
      "workflow_uid": "f7abcbba-113f-4344-9b2e-952c02149e75",
      "trigger_module": "REQUEST",
      "workflow_access": "COMPANY_WIDE",
      "trigger_event": "request.new_note",
      "trigger_event_name": "Request New Note",
      "created_by": {
        "user_uid": "b9c91ee7-850f-47b7-b2cd-a6b78f4254d3",
        "first_name": "Tom",
        "last_name": "R",
        "email": "tom.r@zuper.co",
        "home_phone_number": "9898989898",
        "designation": "Admin",
        "emp_code": "001",
        "work_phone_number": "9898989898",
        "profile_picture": "https://s3.ap-south-1.amazonaws.com/staging.in.pro.zuper/attachments/4ddf323f-9ed-4b56-81cc-70d0bdf628c5/ea2602d9-0379-4ffb-a2c0-916dc2558c56.JPG",
        "is_active": true,
        "created_at": "2024-06-14T07:34:28.000Z",
        "updated_at": "2024-09-18T04:03:31.000Z"
      },
      "allow_workflow_to_trigger": true,
      "is_active": true,
      "created_at": "2024-07-17T06:08:43.957Z",
      "id": "undefined"
    }
  ],
  "total_records": 2,
  "current_page": 1,
  "total_pages": 1
}

Changes