List Company 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 Skills endpoint returns the skill catalog for a company: every skill, certification, and license the company tracks, along with each skill's settings (expiration, renewal window, and which details are tracked). Results are paginated and can be filtered by status, skill code, or display name.

Use Cases

  • Sync a client's full skill catalog into your system during initial setup, then periodically to pick up changes.
  • Look up the skillKey for a skill (for example, by filtering on skillCode=FORKLIFT) before assigning it to an employee.
  • Pull only active skills (active=true) to show users a list of skills they can assign.

Company Set Behavior

Skills are stored at the company set level. The response includes all skills in the company set for the Company ID you call, not only skills created under that Company ID. If you call this endpoint for more than one Company ID in the same set, you receive the same catalog each time; use skillKey to de-duplicate.

Filtering and Sorting

  • active (boolean): Return only active (true) or inactive (false) skills.
  • skillCode (string): Partial, case-insensitive match on skill code.
  • skillDisplayName (string): Partial, case-insensitive match on skill display name.
  • Filters can be combined (for example, ?active=true&skillDisplayName=cpr).
  • Sorting is not supported.
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
boolean

Filter by skill status. true = active skills only; false = inactive skills only. Omit to return both.

string

Filter by skill code. Partial match, case-insensitive (for example, fork matches FORKLIFT).

string

Filter by skill display name. Partial match, case-insensitive (for example, cpr matches CPR/AED Certification).

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