PApaylocity
Employee (v1)

Get Employee

Get Employee API will return employee data currently available in Paylocity Payroll/HR solution.

🚧 Maintenance Mode

This resource version is in a limited support mode and should not be used for new integrations. Please use the latest version.

get/v1/company/{companyId}/employee/{employeeId}

Request

  • Base URL
    https://dc1demogw.paylocity.com/api
  • URL
    https://dc1demogw.paylocity.com/api/v1/company/{companyId}/employee/{employeeId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://api.paylocity.com/IdentityServer/connect/token scopes: WebLinkAPI

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max

employeeIdstring required

The Paylocity Employee ID. This is a unique value per Paylocity Company ID. Allowable Values: 10 char max

Headers

Authorizationstring required

Bearer + JWT

Response

Successfully Retrieved

address1string

Employee home 1st address line. <br />Max length: 40

address2string

Employee home 2nd address line. <br />Max length: 40

birthDatestring

Employee birthdate. Common formats are MM-DD-CCYY, CCYY-MM-DD.

citystring

Employee home city. <br />Max length: 40

companyNumberstring

Paylocity assigned company number. <br /> Max length: 9

employeeIdstring

Leave blank to have Paylocity Payroll/HR solution automatically assign the next available employee ID.<br /> Max length: 10

ethnicitystring

Employee ethnicity.<br /> Max length: 10

firstNamestring

Employee first name. <br />Max length: 40

genderstring

Employee gender. Common values M (Male), F (Female). <br />Max length: 1

highlyCompensatedEmployeeboolean

Indicates if employee meets the highly compensated employee criteria.

hireDatestring

Employee hired date. Common formats are MM-DD-CCYY, CCYY-MM-DD.

homePhonestring

Employee home phone number. <br />Max length: 12

lastNamestring

Employee last name. <br />Max length: 40

maritalStatusstring

Employee marital status. Common values D (Divorced), M (Married), S (Single), W (Widowed). <br />Max length: 10

middleNamestring

Employee middle name.<br /> Max length: 20

nicknamestring

Employee preferred display name. <br /> Max length: 20

ownerPercentnumber

Percentage of employee's ownership in the company, entered as a whole number . <br /> Decimal (12,2)

personalEmailAddressstring

Employee personal email address. <br />Max length: 50

personalMobilePhonestring

Employee personal mobile phone number. <br />Max length: 12

positionstring

Employee position code. Must match Company setup.<br />Max length: 20

postalCodestring

Employee work zip code.<br /> Max length: 10

reHireDatestring

Rehire date if employee is rehired. Common formats are MM-DD-CCYY, CCYY-MM-DD.

ssnstring

Employee social security number. Leave it blank if valid social security number not available. <br />Max length: 11

statestring

Employee home state. <br />Max length: 2

statutoryboolean

Indicates if employee is statutory.

supervisorCompanyNumberstring

Supervisor's company number. Defaults to employee company number.<br />Max length: 9

supervisorEmployeeIdstring

EmployeeId of the supervisor. <br />Max length: 10

taxFormstring

Employee tax form for reporting income. Valid values are W2, 1099M, 1099R, 1099NEC, Non-US. Default is W2. <br />Max length: 15

terminationDatestring

Date of employee termination. Common formats are MM-DD-CCYY, CCYY-MM-DD.

terminationReasonstring

Employee termination reason. Must match Company setup for employee status.<br />Max length: 15

workEmailAddressstring

Employee work email. <br />Max length: 50

workPhonestring

Employee work phone number.<br /> Max length: 12

workPhoneExtstring

Employee work phone extension number.<br /> Max length: 10

Changes

No recorded changes to this operation across all 1 revision of this API.