List Company 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 Company Employee Skills endpoint returns a paginated list of skill assignments for all employees in the company set. Each record is a lightweight summary showing which employee has which skill, and when it was issued and expires.

This summary does not include employeeSkillKey or expirationStatus. To get, update, or delete an individual assignment, call List Employee Skills for the employee to get its employeeSkillKey.

Use Cases

  • Pull every employee's skills in one feed to sync a compliance or workforce system.
  • Build an expiration report across the company by reviewing expirationDate on each record.
  • Identify which employees hold a particular skill by matching skillKey.

Company Set Behavior

Skill assignments are returned for every employee in the company set, not only employees of the Company ID you call. Employee skills are stored per person (personId), so a person with Employee IDs in more than one Company ID in the set is returned once for each of those Employee IDs, with the same skill details. Use companyId and employeeId on each record to see which employee record it belongs to.

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.

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 Company ID was not found.

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