Appraisd API Information

Appraisd has an API that is available to all customers at no extra fee. Our API follows REST principles with a JSON payload and response. The technical documentation can be found here.

Can I integrate Appraisd with my HRIS / HRMS?

We have ready-made integrations with Zenefits and BambooHR. If you use either of those, then contact support@appraisd.com for information on how to get them set up. If not, read on.

If your HRIS has an API or has the capability of interacting with an API, then it's highly likely that you can sync data from your HRIS to Appraisd.

In practice this typically means whenever you add a new employee or make a change to an employee on your HRIS, the same employee will be added or modified on Appraisd almost instantly. This saves you the admin time of making the changes twice and helps to ensure your Appraisd account is always up to date.

Please note that integration is not the same as Single Sign On, which allows users to log in to Appraisd without needing a separate password .

In some cases, you may need to write a small programme to connect your HRIS with Appraisd. Thanks to our API documentation this should be straightforward.

Less straightforward is data that relates to reviews or objectives and syncing it between the two systems - that's because this data is more complex and needs to be 'translated' to suit the target system.

What's available?

At the moment, the API includes the following areas:

Activity Log

• List recent actions on Appraisd taken by your users (logged in, such as submitted a review, edited a user)

Users

• Search or list your existing users
• Add new users
• Make changes to existing users
• Deactivate users

Your account

• Get a list of questions in your review forms for your account
• Get a list of Administration Groups on your account
• Get a list of Review Groups on your account
• Get a list of Objectives templates

Reviews

• Add an appraisal/review/check-in
• Delete an appraisal/review/check-in
• Update an appraisal/review/check-in
• Get a list of appraisals/reviews/check-ins

Responses

• Get all appraisal/review/check-in responses
• Get the activity logs for all responses

Objectives

• Get all objectives in your account (or by user)
• Get all milestones/key-results attached to objectives
• Get all activity logs for an objective

We are happy to provide a sandbox that can be used for API testing. If you would like one please email support@appraisd.com

Documentation

Interactive technical documentation is available here: https://api.appraisd.com/docs/index.

Please also refer to User provisioning using the Appraisd API.

Authorisation

Access to our API is gained by passing an API token in the header of your request in this format:

Authorization: Bearer {token}