Using the Welcome Kit API πŸ‘©β€πŸ’»

Table of contents

    πŸ’‘ If you want to get an API token for Welcome Kit, this article is for you!

    πŸ”’ In order to use our Welcome Kit API, companies must have suscribed to a PRO plan.

     

    Information about the Welcome Kit API is available here: http://developers.welcomekit.co/.

    If you would like more information about this, or you want a token for your company, please contact your account manager.

     

    Here are the steps to follow to obtain your token: 

    1. Gather the scopes that you think are necessary listed in our documentation.
    2. Tell us the use cases you will implement so that we can forward them to our product team. Please note that the candidates and my_candidates scopes are not compatible: candidates gives access to all candidates while my_candidates gives access to all candidates created by you via the API.

    N.B. No token is required to display your list of vacancies on your site: you can do this via the API public endpoint (see http://developers.welcomekit.co/#embed).

    ⚠️ Your "organisation reference" is the code that follows the URL https://www.welcomekit.co/dashboard/ when you log into Welcome Kit.

    ⚠️ Please note that for privacy reasons, you must have "admin" status in order to be issued a token, or have written permission from an admin of your account.


    πŸ†˜ If you have any other questions, you can contact us on the support widget at the bottom right!