PerformYard API Overview
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 for more information.
API Status
Provides the ability to check on the availability of the PerformYard REST API.
API Authentication & Usage
Provides the ability to verify API Keys' validity and retrieve your account's current API usage levels.
Employee Management
Provides the ability to create, update, deactivate, and retrieve employee details from PerformYard programmatically.
Goals
Provides the ability to retrieve a list of goals, outlooks, and goal categories as well as the ability to create or update goals and update a goal's progress. The Goals API can interact with both public and private goals. API users are assumed to have admin-level permissions and therefore have the same visibility permissions as your Billing Admin and Admin roles.
Creating Goals
Similar to creating a goal in the PerformYard interface, specifying multiple assignees does not assign multiple users to a single goal. Instead, the system creates a separate goal for each assignee provided.
Updating Goal Details
Updates to a goal's fields will also overwrite the current field value instead of appending new values to the existing field entry. For example, the description of a goal needs to be updated to include a link to outside documentation, the entire existing goal description in addition to the new link should be included in the PATCH request.
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.
Updating Goal Progress
Just as in the PerformYard platform, archived or 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.
Progress updates made to a goal via the API will be recorded in the Activity Stream and Goal Progress side panel just as they would be if made via the PerformYard interface. Updates will also be associated with the name of the API key that was responsible for providing the update.
Reporting & Analytics
Provides the ability to retrieve the list of available reports and run and retrieve the resulting data for a report.
Reviews
Provides the ability to retrieve a list of review templates as well as the ability to create an "ad-hoc" review for an employee.
Review Cycles
Provides the ability to retrieve a list of review cycles as well as the ability to add a subject to a review cycle.
Updated about 2 months ago