{"article":{"id":360033729713,"url":"https://appraisd.zendesk.com/api/v2/help_center/en-us/articles/360033729713.json","html_url":"https://help.appraisd.com/hc/en-us/articles/360033729713-Appraisd-API-Information","author_id":375072833974,"comments_disabled":false,"draft":false,"promoted":false,"position":11,"vote_sum":0,"vote_count":0,"upvote_count":0,"downvote_count":0,"section_id":360005057113,"created_at":"2019-07-29T16:49:41Z","updated_at":"2024-02-20T16:47:09Z","name":"Appraisd API Information","title":"Appraisd API Information","source_locale":"en-us","locale":"en-us","outdated":false,"outdated_locales":[],"edited_at":"2024-02-20T16:47:08Z","user_segment_id":null,"permission_group_id":852334,"content_tag_ids":[],"label_names":["api","integration","integrations"],"body":"

An API is a way for another system such as your HRIS to communicate with Appraisd over the internet.

\n
\n
\n
\n
\n
\n
\n
\n
\n
\n

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.

\n

 

\n
\n
\n

Can I integrate Appraisd with my HRIS / HRMS?

\n
\n
\n\n

If your HRIS is not included on the help page above, read on.

\n

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.

\n
\n
\n

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.

\n
\n
\n

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 .

\n
\n
\n

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.

\n
\n
\n

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.

\n
\n
\n


What's available?

\n
\n
\n

At the moment, the API includes the following areas:

\n
\n
\n

Activity Log

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

Users

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

Your account

\n
\n
\n\n
\n
\n

Reviews

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

Responses

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

Objectives

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

Recognition

\n
    \n
  • Add new recognition
    • \n
  • Delete recognition
    • \n
  • Update recognition
    • \n
  • Get a list of recognition
    • \n
  • Get a specific piece of recognition
    • \n
\n
\n


Sandbox

\n
\n

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

\n
\n
\n

\n
Documentation\n

\n
\n
\n

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

\n

Please also refer to User provisioning using the Appraisd API.

\n
\n
\n


Authorisation

\n
\n
\n

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

\n
\n
\n
Authorization: Bearer {token}
\n
\n
To generate your token, you will need to have admin access on your Appraisd account and then follow this link: https://app.appraisd.com/token\n
\n
Tokens will have an expiry date so please make sure you make a note of this so you remember to generate a new one.
\n
We often use Postman to configure and send the request to the Appraisd API.
\n
 
\n
Note: we do not endorse or guarantee external tools.
\n
\n
\n
\n
\n
\n
\n
\n
"}}