# PerformYard Documentation

> Documentation for PerformYard

Append .md to any documentation page URL to get its markdown version.

## Guides
- [PerformYard API Overview](https://docs.performyard.com/docs/performyard-rest-api-capabilities.md): The PerformYard REST API offers several endpoints to manage different aspects of the PerformYard platform. Remember, to get started using the PerformYard API, you'll need to obtain a company API Key. Read our [Getting Started with the PerformYard REST API](https://performyard.readme.io/docs/getting-started) for more information.
- [API Key Setup in PerformYard](https://docs.performyard.com/docs/getting-started.md): This page will help you get started with the PerformYard REST API.
- [Authentication](https://docs.performyard.com/docs/authentication.md): Learn which headers are required on every PerformYard API request.
- [Verify Your API Key](https://docs.performyard.com/docs/verify-your-api-key.md): Learn how to validate your API Key and ID.
- [API Fundamentals](https://docs.performyard.com/docs/using-the-limit-and-offset-query-params.md): Learn about the PerformYard API, including query params and rate limiting
- [Viewing Employee Creation and Updates in Bulk User Logs](https://docs.performyard.com/docs/viewing-employee-creation-and-updates-in-bulk-user-logs.md): Learn how to use Bulk User Logs to track Public API activity, including employee creation and updates, within PerformYard
- [Sample: Creating Employees with Zapier and the PerformYard API](https://docs.performyard.com/docs/sample-creating-employees-with-zapier-and-the-performyard-api.md): Learn how to create employees using Zapier and the PerformYard REST API.

## API Reference
- [Verify your API key and retrieve usage details](https://docs.performyard.com/reference/get_v1-auth-verify-1.md): Validates your API credentials and returns current usage metrics for your account, including rate limits and request counts.
- [Retrieve a list of Compensation Cycles](https://docs.performyard.com/reference/get_v1-compensation-cycles.md): Retrieves a list of all available compensation cycles created in your PerformYard instance. Please note, this endpoint requires the Compensation feature to be enabled for your company. Requests from a company without Compensation enabled are rejected with a 403.
- [Retrieve a compensation cycle](https://docs.performyard.com/reference/get_v1-compensation-cycles-cycleid.md): Retrieves the details for a specific compensation cycle. Please note, this endpoint requires the Compensation feature to be enabled for your company. Requests from a company without Compensation enabled are rejected with a 403.
- [Retrieve a Compensation Cycle's decision information](https://docs.performyard.com/reference/get_v1-compensation-cycles-cycleid-compensation-decisions.md): Retrieves the decision information for a specific compensation cycle. Please note, this endpoint requires the Compensation feature to be enabled for your company. Requests from a company without Compensation enabled are rejected with a 403.
- [Retrieve a list of employee data fields](https://docs.performyard.com/reference/get_v1-admin-data-fields-employee-1.md): Retrieves all of the defined employee data fields configured in your PerformYard account, including field types, visibility, and editing permissions.
- [Retrieve a list of employees](https://docs.performyard.com/reference/get_v1-employees-1.md): Retrieves a list of all employees in your organization, with the option to return either basic profile data or complete employee records.
- [Create one or more employees](https://docs.performyard.com/reference/post_v1-employees-1.md): Creates one or more new employees to your PerformYard account.
- [Update multiple employees](https://docs.performyard.com/reference/patch_v1-employees-1.md): Performs bulk updates to multiple employee records in a single request.
- [Retrieve an employee](https://docs.performyard.com/reference/get_v1-employees-id-1.md): Retrieves profile information for a specific employee, with the option to retrieve either basic details or the full employee record.
- [Update an employee](https://docs.performyard.com/reference/patch_v1-employees-id-1.md): Modifies the profile information for a single employee.
- [Create one or more employees](https://docs.performyard.com/reference/post_v2-employees-1.md): Creates one or more new employees to your PerformYard account.
- [Retrieve a list of goals](https://docs.performyard.com/reference/get_v1-goals-1.md): Retrieves all public and private goals across your organization with their current status and progress. Order first by status and then by name and due date. Please note, A goal's description will be delivered with escape characters for proper formatting in your database of choice.
- [Create a goal](https://docs.performyard.com/reference/post_v1-goals-1.md): Creates a new goal for the specified assignees. Please note, just like when creating a new goal in the PerformYard interface, adding multiple goal assignees will not assign multiple users to a single goal and will instead create one goal each for every assignee included.
- [Retrieve a goal](https://docs.performyard.com/reference/get_v1-goals-id-1.md): Retrieves information for a specific goal. Please note, A goal's description will be delivered with escape characters for proper formatting in your database of choice.
- [Update a goal's details](https://docs.performyard.com/reference/patch_v1-goals-id-1.md): Modifies the properties of an existing goal, such as title, description, or due date. Does not update the goal's progress. That can be done using the endpoint entitled "Update A Goal's Progress". Please note, updates to a goal's attributes will also be recorded in the goal's activity history stream, where the label of the responsible API key will be displayed alongside the nature of the update.
- [Update a goal's progress](https://docs.performyard.com/reference/patch_v1-goals-id-update-progress-1.md): Updates the value of a goal's progress. Please note, updates to a goal's attributes will also be recorded in the goal's activity history stream, where the label of the responsible API key will be displayed alongside the nature of the update. Archived & completed goals cannot have their progress updated. Users attempting to update these goals will receive an error message indicating their status as an archived or completed goal.
- [Retrieve a list of goal categories](https://docs.performyard.com/reference/get_v1-goal-categories-1.md): Retrieves the list of goal categories configured in your organization.
- [Retrieve a list of goal outlooks](https://docs.performyard.com/reference/get_v1-goal-outlooks-1.md): Retrieves the list of goal outlooks configured in your organization.
- [Check API status](https://docs.performyard.com/reference/get_health-1.md): Checks the operational status of the PerformYard API and returns system availability information.
- [Retrieve a list of reports](https://docs.performyard.com/reference/get_v1-reports-1.md): Retrieves a list of all available reports created in your PerformYard instance.
- [Retrieve a report's data](https://docs.performyard.com/reference/get_v1-reports-id-1.md): Retrieves the data and results for a specific report, including all rows and calculated values. This endpoint returns a maximum of 200 data rows per request. For reports exceeding this limit, use the offset query parameter to retrieve all data through multiple requests. The offset value represents which page of results to return, starting at 0 for the first page. For example, a report with 450 rows requires three API calls: the first with offset=0 returns rows 1-200, the second with offset=1 returns rows 201-400, and the third with offset=2 returns the remaining rows 401-450. Continue incrementing the offset until you receive fewer than 200 rows, indicating you've reached the end of the dataset.
- [Create a review for an employee](https://docs.performyard.com/reference/post_v1-reviews-1.md): Creates a new performance review for a specific employee using the specified template.
- [Retrieve a list of review cycles](https://docs.performyard.com/reference/get_v1-review-cycles-1.md): Retrieves all performance review cycles, including their status, start dates, and types.
- [Add an employee to a review cycle](https://docs.performyard.com/reference/post_v1-review-cycles-reviewcycleid-subjects-1.md): Adds a specific employee as a review subject using the specified review cycle.
- [Retrieve a list of review templates](https://docs.performyard.com/reference/get_v1-review-templates-1.md): Retrieves all available review templates, including their name and the number of forms it contains.
- [Retrieve a list of roles](https://docs.performyard.com/reference/get_v1-roles.md): Retrieves the company's active roles, for use as valid values on the employee Role field.
- [Retrieve our Swagger JSON definition](https://docs.performyard.com/reference/get_swagger-json-1.md): Swagger JSON