Get Employees [Batch]
Get Employees [Batch]
Summary Description
The GET Employee List by Company ID API endpoint provides a list of up to 20 employees per call from the Paylocity system. Designed for the initial population of user systems with Paylocity’s employee data, it supports pagination for easy navigation through results. The ‘include’ parameter enables selective retrieval of payload elements, while the ‘Active Only’ filter helps obtain only those employees with an ‘Active’ Employee Status Type. This makes the endpoint highly flexible and capable of delivering tailored listings to meet specific user requirements.
GET Employee List by Company ID - Use Cases:
-
The ‘Get Employee List by Company ID’ endpoint empowers API users to fetch a comprehensive list of employees alongside their relevant data. Ideal for initial data loads.
-
The recommended best practice to track employee demographic changes is not through regular polling of this endpoint. Instead, utilize our employee webhooks in conjunction with the ‘GET Single Employee by Company and Employee ID’ endpoint.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
Paylocity company identifier (COID): up to 9 alphanumeric characters for the target company.
Headers
Media type(s) the client can accept in the response (typically application/json).
Query parameters
Number of employees per page.
Default Value: 20
Maximum Value: 20 Used together with offset for offset/limit pagination.
Opaque pagination cursor returned by a previous response; pass this token to retrieve the next page of results.
Comma separated list of data to be included. Allowable Values: info, position, status and payrate.
Filter only active emplooyes. Allowable Values: true, false