curl --request GET \
--url https://demo1-api.payrollintegrationsdemo.com/v1-preview/connections/{connection}/employees \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "11111111-1111-1111-1111-111111111111",
"payrollPlatformEmployeeId": "PPL-98765",
"connectionId": "880e8400-e29b-41d4-a716-446655440003",
"profiles": [
{
"payrollPlatformDisplayId": "EMP-12345",
"socialSecurityNumber": null,
"census": {
"addresses": [
{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "San Francisco",
"countryCode": "US",
"state": "CA",
"zip": "94102"
}
],
"contact": {
"emailPersonal": null,
"emailWork": "[email protected]",
"phoneNumberPersonal": null,
"phoneNumberPersonalHome": null,
"phoneNumberPersonalMobile": "555-0123",
"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",
"employeeId": "EMP-12345",
"payRates": [
{
"amount": "75000.00",
"default": true,
"type": "ANNUAL"
}
],
"payFrequency": "BI_WEEKLY",
"paymentType": "S"
}
}
]
},
{
"id": "22222222-2222-2222-2222-222222222222",
"payrollPlatformEmployeeId": "PPL-98766",
"connectionId": "880e8400-e29b-41d4-a716-446655440003",
"profiles": [
{
"payrollPlatformDisplayId": "EMP-67890",
"socialSecurityNumber": null,
"census": {
"addresses": [
{
"address1": "456 Oak Ave",
"address2": null,
"city": "Los Angeles",
"countryCode": "US",
"state": "CA",
"zip": "90001"
}
],
"contact": {
"emailPersonal": "[email protected]",
"emailWork": "[email protected]",
"phoneNumberPersonal": null,
"phoneNumberPersonalHome": null,
"phoneNumberPersonalMobile": "555-0456",
"phoneNumberWork": null,
"phoneNumberWorkHome": null,
"phoneNumberWorkMobile": null
},
"dateOfBirth": "1990-09-20",
"firstName": "Jane",
"lastName": "Smith",
"middleName": null,
"maritalStatus": "S",
"sex": "F",
"adjustedServiceDate": null,
"hireDate": "2021-07-01",
"isContractor": false,
"leaveStartDate": null,
"leaveEndDate": null,
"rehireDate": null,
"seniorityDate": "2021-07-01",
"employmentStatus": "A",
"terminationDate": null,
"employmentType": "F",
"employeeId": "EMP-67890",
"payRates": [
{
"amount": "32.50",
"default": true,
"type": "HOURLY"
}
],
"payFrequency": "BI_WEEKLY",
"paymentType": "H"
}
}
]
}
],
"meta": {
"limit": 20,
"offset": 0,
"sort": "lastName",
"totalCount": 2
}
}Returns a list of employees for a connection
curl --request GET \
--url https://demo1-api.payrollintegrationsdemo.com/v1-preview/connections/{connection}/employees \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "11111111-1111-1111-1111-111111111111",
"payrollPlatformEmployeeId": "PPL-98765",
"connectionId": "880e8400-e29b-41d4-a716-446655440003",
"profiles": [
{
"payrollPlatformDisplayId": "EMP-12345",
"socialSecurityNumber": null,
"census": {
"addresses": [
{
"address1": "123 Main St",
"address2": "Apt 4B",
"city": "San Francisco",
"countryCode": "US",
"state": "CA",
"zip": "94102"
}
],
"contact": {
"emailPersonal": null,
"emailWork": "[email protected]",
"phoneNumberPersonal": null,
"phoneNumberPersonalHome": null,
"phoneNumberPersonalMobile": "555-0123",
"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",
"employeeId": "EMP-12345",
"payRates": [
{
"amount": "75000.00",
"default": true,
"type": "ANNUAL"
}
],
"payFrequency": "BI_WEEKLY",
"paymentType": "S"
}
}
]
},
{
"id": "22222222-2222-2222-2222-222222222222",
"payrollPlatformEmployeeId": "PPL-98766",
"connectionId": "880e8400-e29b-41d4-a716-446655440003",
"profiles": [
{
"payrollPlatformDisplayId": "EMP-67890",
"socialSecurityNumber": null,
"census": {
"addresses": [
{
"address1": "456 Oak Ave",
"address2": null,
"city": "Los Angeles",
"countryCode": "US",
"state": "CA",
"zip": "90001"
}
],
"contact": {
"emailPersonal": "[email protected]",
"emailWork": "[email protected]",
"phoneNumberPersonal": null,
"phoneNumberPersonalHome": null,
"phoneNumberPersonalMobile": "555-0456",
"phoneNumberWork": null,
"phoneNumberWorkHome": null,
"phoneNumberWorkMobile": null
},
"dateOfBirth": "1990-09-20",
"firstName": "Jane",
"lastName": "Smith",
"middleName": null,
"maritalStatus": "S",
"sex": "F",
"adjustedServiceDate": null,
"hireDate": "2021-07-01",
"isContractor": false,
"leaveStartDate": null,
"leaveEndDate": null,
"rehireDate": null,
"seniorityDate": "2021-07-01",
"employmentStatus": "A",
"terminationDate": null,
"employmentType": "F",
"employeeId": "EMP-67890",
"payRates": [
{
"amount": "32.50",
"default": true,
"type": "HOURLY"
}
],
"payFrequency": "BI_WEEKLY",
"paymentType": "H"
}
}
]
}
],
"meta": {
"limit": 20,
"offset": 0,
"sort": "lastName",
"totalCount": 2
}
}