Skip to content

Get employee summary

Request

Returns a consolidated summary of employee-related information for the current account context.

Behavior:

  • Aggregates employee counts and statuses
  • Includes active, inactive, assigned, and unassigned employees
  • Provides key metrics for reporting or dashboard purposes
  • Logs the summary view action
curl -i -X POST \
  https://demozone.zlinkfm.com/RND/api/v1/portfolio/employees/summary

Responses

OK

Body
dataobject(zLink.Business.zOne.Portfolio.ResponseModels.EmployeeSummaryResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger, (int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
{
  "data": {
    "totals": {
      "all": 0,
      "assigned": 0,
      "unAssigned": 0,
      "byGender": [
        {
          "genderId": "75f81325-7c9a-45f2-9383-a04e731a55bd",
          "genderName": "string",
          "employees": 0
        }
      ],
      "byOrganizationalUnit": [
        {
          "levelName": "string",
          "unitIdentifier": "fef1588a-8d1a-434b-be83-95ca43e0251a",
          "unitName": "string",
          "employees": 0
        }
      ]
    }
  },
  "message": "string",
  "isError": true,
  "messageCode": 0,
  "status": "string",
  "errorType": "string",
  "traceid": "string",
  "responseDescription": "string"
}