Get Skill

🚧

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 Get Skill endpoint returns the full details of a single skill definition, including its expiration, renewal, and tracking settings.

Use Cases

  • Check a skill's settings (for example, whether it expires or allows documents) before assigning it to an employee.
  • Confirm that changes made with Update Skill (Partial) were applied.

Company Set Behavior

Skills are shared across the company set. Any Company ID in the set can be used to retrieve the skill.

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.

uuid
required

The unique identifier (UUID) of the skill definition. Get this value from List Company Skills or Create Skill.

Query Params
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. No skill with this skillKey exists in the company set.

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