GET Payroll/Employees

Returns a list of all employees in file including inactive. Valid filters: IsActive, IncludeLeaveBalances, LeaveBalanceAsAtDate. To include leave balances for each employee, add "IncludeLeaveBalances=true" in the URI Parameters.

Request Information

URI Parameters

Name Description Type Additional information
WsAccessKey The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. string

Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
FileId Specifies the file id of the file to perform the operation upon. integer

Required

Body Parameters

None.

Response Information

Resource Description

EmployeeListResponse
Name Description Type Additional information
Employees List of employees. Collection of EmployeeSummary

None.
_links Hypermedia links. Contains contextual links to possible next actions related to this resource. Only present in responses. This data is not to be sent to the server. Collection of Link

None.

Response Formats

application/json, text/json

Sample: 
{
  "Employees": [
    {
      "Id": 1,
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "DisplayName": "sample string 2, sample string 1",
      "IsActive": true,
      "EmploymentTypeId": 4,
      "EmploymentType": "sample string 5",
      "PayFrequencyId": 6,
      "PayFrequency": "sample string 7",
      "AssignedToPayGroupId": 8,
      "PayGroupName": "sample string 9",
      "LastPaid": "2024-04-25T00:34:47.6391969+10:00",
      "LeaveBalances": [
        {
          "PayItemId": 1,
          "Name": "sample string 2",
          "Hours": 1.0
        },
        {
          "PayItemId": 1,
          "Name": "sample string 2",
          "Hours": 1.0
        }
      ],
      "_links": [
        {
          "rel": "sample string 1",
          "href": "sample string 2",
          "method": "sample string 3",
          "title": "sample string 4"
        },
        {
          "rel": "sample string 1",
          "href": "sample string 2",
          "method": "sample string 3",
          "title": "sample string 4"
        }
      ]
    },
    {
      "Id": 1,
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "DisplayName": "sample string 2, sample string 1",
      "IsActive": true,
      "EmploymentTypeId": 4,
      "EmploymentType": "sample string 5",
      "PayFrequencyId": 6,
      "PayFrequency": "sample string 7",
      "AssignedToPayGroupId": 8,
      "PayGroupName": "sample string 9",
      "LastPaid": "2024-04-25T00:34:47.6391969+10:00",
      "LeaveBalances": [
        {
          "PayItemId": 1,
          "Name": "sample string 2",
          "Hours": 1.0
        },
        {
          "PayItemId": 1,
          "Name": "sample string 2",
          "Hours": 1.0
        }
      ],
      "_links": [
        {
          "rel": "sample string 1",
          "href": "sample string 2",
          "method": "sample string 3",
          "title": "sample string 4"
        },
        {
          "rel": "sample string 1",
          "href": "sample string 2",
          "method": "sample string 3",
          "title": "sample string 4"
        }
      ]
    }
  ],
  "_links": [
    {
      "rel": "sample string 1",
      "href": "sample string 2",
      "method": "sample string 3",
      "title": "sample string 4"
    },
    {
      "rel": "sample string 1",
      "href": "sample string 2",
      "method": "sample string 3",
      "title": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample: 
<EmployeeListResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <_links>
    <Link>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
      <method>sample string 3</method>
      <title>sample string 4</title>
    </Link>
    <Link>
      <rel>sample string 1</rel>
      <href>sample string 2</href>
      <method>sample string 3</method>
      <title>sample string 4</title>
    </Link>
  </_links>
  <Employees>
    <EmployeeSummary>
      <_links>
        <Link>
          <rel>sample string 1</rel>
          <href>sample string 2</href>
          <method>sample string 3</method>
          <title>sample string 4</title>
        </Link>
        <Link>
          <rel>sample string 1</rel>
          <href>sample string 2</href>
          <method>sample string 3</method>
          <title>sample string 4</title>
        </Link>
      </_links>
      <Id>1</Id>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <IsActive>true</IsActive>
      <EmploymentTypeId>4</EmploymentTypeId>
      <EmploymentType>sample string 5</EmploymentType>
      <PayFrequencyId>6</PayFrequencyId>
      <PayFrequency>sample string 7</PayFrequency>
      <AssignedToPayGroupId>8</AssignedToPayGroupId>
      <PayGroupName>sample string 9</PayGroupName>
      <LastPaid>2024-04-25T00:34:47.6391969+10:00</LastPaid>
      <LeaveBalances>
        <LeaveBalanceDto>
          <PayItemId>1</PayItemId>
          <Name>sample string 2</Name>
          <Hours>1</Hours>
        </LeaveBalanceDto>
        <LeaveBalanceDto>
          <PayItemId>1</PayItemId>
          <Name>sample string 2</Name>
          <Hours>1</Hours>
        </LeaveBalanceDto>
      </LeaveBalances>
    </EmployeeSummary>
    <EmployeeSummary>
      <_links>
        <Link>
          <rel>sample string 1</rel>
          <href>sample string 2</href>
          <method>sample string 3</method>
          <title>sample string 4</title>
        </Link>
        <Link>
          <rel>sample string 1</rel>
          <href>sample string 2</href>
          <method>sample string 3</method>
          <title>sample string 4</title>
        </Link>
      </_links>
      <Id>1</Id>
      <FirstName>sample string 1</FirstName>
      <LastName>sample string 2</LastName>
      <IsActive>true</IsActive>
      <EmploymentTypeId>4</EmploymentTypeId>
      <EmploymentType>sample string 5</EmploymentType>
      <PayFrequencyId>6</PayFrequencyId>
      <PayFrequency>sample string 7</PayFrequency>
      <AssignedToPayGroupId>8</AssignedToPayGroupId>
      <PayGroupName>sample string 9</PayGroupName>
      <LastPaid>2024-04-25T00:34:47.6391969+10:00</LastPaid>
      <LeaveBalances>
        <LeaveBalanceDto>
          <PayItemId>1</PayItemId>
          <Name>sample string 2</Name>
          <Hours>1</Hours>
        </LeaveBalanceDto>
        <LeaveBalanceDto>
          <PayItemId>1</PayItemId>
          <Name>sample string 2</Name>
          <Hours>1</Hours>
        </LeaveBalanceDto>
      </LeaveBalances>
    </EmployeeSummary>
  </Employees>
</EmployeeListResponse>