Scopes

Welcome Kit uses OAuth scopes to protect its API endpoints.
Depending on the level of access you need, please ask us for the required scopes from the list below.
Scope
Description
me_r
Read access on your personal information
organizations_rw
Read and Write access on your organization(s)
organizations_r
Read access on your organization(s)
jobs_rw
Read and Write access on your job offers
jobs_r
Read access on your job offers
offices_rw
Read and Write access on your offices
offices_r
Read access on your offices
departments_rw
Read and Write access on your departments
departments_r
Read access on your departments
candidates_rw
Read and Write access on all candidates (limited to user's role)
candidates_r
Read access on all candidates (limited to user's role)
my_candidates_rw
Read and Write access on all candidates this user created through the API 
(mainly useful for synchronization with external services without giving access to all your candidates)
documents_rw
Read and Write access on your candidate files
documents_r
Read access on your candidate files
emails_rw
Read and Write access on your candidate emails
emails_r
Read access on your candidate emails
comments_w
Write access on your candidate comments
images_r
Read access to your images
moves_r
Read access on candidates moves
videos_r
Read access on your video files
Scopes below need a dedicated partnership - Contact us for more informations
Scope
Description
su_offices_r
Read access on offices of a company
su_jobs_r
Read access on jobs of a company
su_departments_r
Read access on departments of a company
su_organizations_r
Read access on organizations information of a company
su_offices_r
Read access on offices of a company
su_images_r
Read access to images of a company
su_videos_r
Read access to videos of a company
cms_articles_r
Read access to WTTJ articles
cms_collections_r
Read access to WTTJ collections
cms_collection_categories_r
Read acces to WTTJ collection categories

Authentication

Errors and Status

Last modified 11mo ago

Copy link