List Employee Skills

🚧

Early Access (EA)

This API is currently in Early Access and available only to approved EA participants. Do not rely on this version for production workloads unless explicitly authorized. If you have any feedback, please share with your designated Early Adoption program representative.

Summary Description

The List Employee Skills endpoint returns a paginated list of the skills assigned to one employee, including each skill's issued date, expiration date, and current expiration status.

Use Cases

  • Show an employee's skills and certifications in your application.
  • Check whether an employee holds a required skill and whether it is Active, Up for Renewal, or Expired.
  • Get the employeeSkillKey for an assignment before updating, renewing, or deleting it.

Company Set Behavior

Employee skills are stored per person (personId), not per Employee ID. Calling this endpoint for one Employee ID returns all skills for that person, including skills that were added through the person's other Employee IDs in other Company IDs within the company set. The companyId and employeeId on each returned record are the values from the request.

Filtering and Sorting

Filtering and sorting are not supported on this endpoint.

Path Params
string
required
length ≤ 9

The Paylocity Company ID. This is the unique value provided by Paylocity to each specific payroll entity. Skills are shared across the company set, so this Company ID determines which company set is used.

string
required
length ≤ 10

The Paylocity Employee ID. This is a unique value per Paylocity Company ID. Skills are returned for the person behind this Employee ID, including skills added through their other Employee IDs in the company set.

Query Params
int32
≄ 0
Defaults to 0

The 0-based index of the first record to return. Used with limit to page through results (for example, offset=100&limit=100 returns records 101-200). Default: 0.

int32
1 to 100
Defaults to 100

The number of records to return per page. Allowable values: 1-100. Default: 100.

boolean
Defaults to false

When true, returns the total number of matching records in the X-Pcty-Total-Count response header. Default: false.

boolean
Defaults to false

When true, returns sample (mocked) responses without reading or changing any real data, and without validating the request body. Authentication and company access are still checked. Use for integration testing only. Must be true or false. Default: false.

Responses

401

Unauthorized. The bearer token is missing, invalid, or expired. Request a new access token and try again.

403

Forbidden. The token is valid, but the API client is not authorized to access this API or this company.

404

Not Found. The Employee ID was not found in the company.

429

Too Many Requests. The API client exceeded the rate limit of 3 requests per second. Wait briefly, then retry using a backoff strategy.

504

Gateway Timeout. The request did not complete within the 30-second gateway timeout. Retry the request; for list endpoints, try a smaller limit.

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json