Help Page Home - Payroll
GET Payroll/Employees
Returns a list of all employees in file including inactive.
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
EmployeeListResponseName | 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", "IsActive": true, "_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", "IsActive": true, "_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> </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> </EmployeeSummary> </Employees> </EmployeeListResponse>