Skip to main content
GET
cURL
The employeeSummary field will be null when an employee has multiple profiles. In that case, query the individual profiles using the employeeProfiles array to retrieve the full employee data for each profile.

Authorizations

Authorization
string
header
required

Bearer token obtained from the /v1/auth/token endpoint. Send as: Authorization: Bearer .

Path Parameters

payroll_connection
string<uuid>
required

ID of the payroll connection

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

limit
integer

Maximum number of records to return

Required range: 1 <= x <= 4294967295
offset
integer

Number of records to skip from the beginning

Required range: 0 <= x <= 4294967295
sort
string

Comma-separated list of fields to sort by. Prefix with - for descending order

Pattern: ^(-?\w{1,100})(?:,(-?\w{1,100})){0,2}$

Response

Employee data retrieved successfully

data
object[]
required
meta
object
required