curl --request GET \
--url https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/employee-data{
"data": [
{
"id": "11111111-1111-1111-1111-111111111111",
"employeeSummary": {
"payrollConnectionId": "880e8400-e29b-41d4-a716-446655440003",
"payrollPlatformEmployeeIdentifier": "PPL-98765",
"payrollPlatformDisplayIdentifier": "EMP-12345",
"ssn": "123-45-6789",
"addresses": [
{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "San Francisco",
"countryCode": "US",
"state": "CA",
"zip": "94102"
}
],
"contact": {
"emailPersonal": null,
"emailWork": "john.doe@example.com",
"phoneNumberPersonal": null,
"phoneNumberPersonalHome": null,
"phoneNumberPersonalMobile": "+11235550123",
"phoneNumberWork": null,
"phoneNumberWorkHome": null,
"phoneNumberWorkMobile": null
},
"dateOfBirth": "1985-06-15",
"firstName": "John",
"lastName": "Doe",
"middleName": "Robert",
"maritalStatus": "M",
"sex": "M",
"adjustedServiceDate": null,
"hireDate": "2020-03-15",
"isContractor": false,
"leaveStartDate": null,
"leaveEndDate": null,
"rehireDate": null,
"seniorityDate": "2020-03-15",
"employmentStatus": "A",
"terminationDate": null,
"employmentType": "F",
"payRates": [
{
"amount": "75000.00",
"default": true,
"type": "ANNUAL"
}
],
"payFrequency": "BI_WEEKLY",
"payType": "S"
},
"employeeProfiles": [
{
"employeeProfileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
]
},
{
"id": "22222222-2222-2222-2222-222222222222",
"employeeSummary": null,
"employeeProfiles": [
{
"id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
{
"id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
}
]
}
],
"meta": {
"limit": 20,
"offset": 0,
"sort": "lastName",
"totalCount": 2
}
}Returns a list of employee data for a payroll connection
curl --request GET \
--url https://api.payrollintegrationsapp.com/v1/payroll-connections/{payroll_connection}/employee-data{
"data": [
{
"id": "11111111-1111-1111-1111-111111111111",
"employeeSummary": {
"payrollConnectionId": "880e8400-e29b-41d4-a716-446655440003",
"payrollPlatformEmployeeIdentifier": "PPL-98765",
"payrollPlatformDisplayIdentifier": "EMP-12345",
"ssn": "123-45-6789",
"addresses": [
{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "San Francisco",
"countryCode": "US",
"state": "CA",
"zip": "94102"
}
],
"contact": {
"emailPersonal": null,
"emailWork": "john.doe@example.com",
"phoneNumberPersonal": null,
"phoneNumberPersonalHome": null,
"phoneNumberPersonalMobile": "+11235550123",
"phoneNumberWork": null,
"phoneNumberWorkHome": null,
"phoneNumberWorkMobile": null
},
"dateOfBirth": "1985-06-15",
"firstName": "John",
"lastName": "Doe",
"middleName": "Robert",
"maritalStatus": "M",
"sex": "M",
"adjustedServiceDate": null,
"hireDate": "2020-03-15",
"isContractor": false,
"leaveStartDate": null,
"leaveEndDate": null,
"rehireDate": null,
"seniorityDate": "2020-03-15",
"employmentStatus": "A",
"terminationDate": null,
"employmentType": "F",
"payRates": [
{
"amount": "75000.00",
"default": true,
"type": "ANNUAL"
}
],
"payFrequency": "BI_WEEKLY",
"payType": "S"
},
"employeeProfiles": [
{
"employeeProfileId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
]
},
{
"id": "22222222-2222-2222-2222-222222222222",
"employeeSummary": null,
"employeeProfiles": [
{
"id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
{
"id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
}
]
}
],
"meta": {
"limit": 20,
"offset": 0,
"sort": "lastName",
"totalCount": 2
}
}TheDocumentation Index
Fetch the complete documentation index at: https://developer.payrollintegrations.com/llms.txt
Use this file to discover all available pages before exploring further.
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.