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