API Fundamentals

Rate Limit

Rate limits are scoped per API Key. Each API Key can make up to 5 API requests within any 1-second window (with a burst of 1). If you exceed this limit, additional requests will be rejected with a 429 (Too Many Requests) error until the rate window resets.

Pagination

All applicable endpoints return 200 objects by default. You can override this by passing the query param limit. The minimum number of objects per page is 5 while the maximum number of objects per page is 200.

Using Limit and Offset

If the resource you are retrieving (such as goals, employees, or reports) contains more than 200 records, you must use the offset parameter to paginate through the full result set.

For example, if a report contains 450 records, you would need to make three API requests to this endpoint to retrieve all of the data:

• GET https://api.talent.performyard.com/v1/reports/:report_id?limit=200&offset=0 -> returns data rows 1-200
• GET https://api.talent.performyard.com/v1/reports/:report_id?limit=200&offset=1 -> returns data rows 201-400
• GET https://api.talent.performyard.com/v1/reports/:report_id?limit=200&offset=2 -> returns data rows 401-450

Visibility

API users are assumed to have admin-level permissions and therefore have the same visibility permissions as your Billing Admin and Admin roles within the PerformYard platform.