List Leave Approval Flows | SalaryBox

{
  "message": "Success",
  "status": true,
  "data": {
    "flows": [
      {
        "name": "Field Staff Leave Approval",
        "assigned_staff_count": 38,
        "levels": [
          {
            "level": 1,
            "approver_roles": [
              {
                "role": "ROLE_BRANCH_ADMIN",
                "label": "Branch Admin"
              }
            ],
            "approvers": [
              {
                "salarybox_id": "SBHYBSEEIG",
                "name": "Rohit Sharma"
              }
            ],
            "no_action_mode": "AUTO_APPROVE",
            "no_action_days": 2,
            "skip_if_no_user": true
          },
          {
            "level": 2,
            "approver_roles": [
              {
                "role": "ROLE_ADMIN",
                "label": "Admin"
              }
            ],
            "approvers": [],
            "no_action_mode": "NONE",
            "no_action_days": null,
            "skip_if_no_user": false
          }
        ],
        "created_on": "2026-03-04T10:15:00+05:30",
        "updated_on": "2026-09-18T16:42:00+05:30"
      }
    ],
    "eligible_approvers": [
      {
        "role": "ROLE_ADMIN",
        "label": "Admins",
        "staff": [
          {
            "salarybox_id": "SBXDFJHVMA",
            "name": "Anita Verma"
          }
        ]
      },
      {
        "role": "ROLE_BRANCH_ADMIN",
        "label": "Branch Admins",
        "staff": [
          {
            "salarybox_id": "SBHYBSEEIG",
            "name": "Rohit Sharma"
          }
        ]
      },
      {
        "role": "ROLE_ADVANCED_ATTENDANCE_MANAGER",
        "label": "Advanced Attendance Manager",
        "staff": []
      },
      {
        "role": "ROLE_CUSTOM",
        "label": "Custom Role",
        "staff": [
          {
            "salarybox_id": "SBKLMNPQRS",
            "name": "Priya Nair"
          }
        ]
      }
    ]
  }
}

Returns your company’s multi-level leave approval flows and the people who can be chosen as approvers. Not paginated.

flows lists every flow, oldest first. Companies without multi-level approval get flows: []. assigned_staff_count counts active staff on the flow.
A request passes level 1, then level 2 and so on. At each level, any one eligible approver (a named person in approvers, or anyone with one of the approver_roles) can approve or reject.
Approvers other than admins can only act on staff who share their branch, and one of their departments if they have any. An admin can only be on a flow’s last level.
eligible_approvers has one group per role, in this order: Admins, Branch Admins, Advanced Attendance Managers, custom roles. Active people only, sorted by name.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Response

Flows and eligible approvers.

messagestring

statusboolean

dataobject

Errors

403

Forbidden Error