Skip to main content
GET
/
v1-preview
/
connections
/
{connection}
/
employees
/
{employee}
Get connection employee (preview)
curl --request GET \
  --url https://demo1-api.payrollintegrationsdemo.com/v1-preview/connections/{connection}/employees/{employee} \
  --header 'Authorization: Bearer <token>'
{
  "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"
      }
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

connection
string<uuid>
required
employee
string<uuid>
required

Response

Employee details

id
string<uuid>
required
payrollPlatformEmployeeId
string
required

The payroll platform specific unique employee identifier.

connectionId
string<uuid>
required
profiles
object[] | null