Departments

Operation HTTP Request Description
post
POST /v3/units
Create a new department
delete
DELETE /v3/units/{unitId}
Delete a department
delete
DELETE /v3/units-code/{unitCode}
Delete a department based on code
get
GET /v3/units-code/{unitCode}
Get a department based on code
get
GET /v3/units/{unitId}
Get a specific department
get
GET /v3/units
List all departments
patch
PATCH /v3/units/{unitId}
Update a department
patch
PATCH /v3/units-code/{unitCode}
Update a department based on code

Authentication

Operation HTTP Request Description
post
POST /oauth/token
Create access token

Users

Operation HTTP Request Description
post
POST /v3/users
Create a new user
delete
DELETE /v3/users/{userId}
Delete a user
delete
DELETE /v3/users-email/{email}
Delete a user by email
delete
DELETE /v3/users-employee_id/{employeeId}
Delete a user by employee id
delete
DELETE /v3/users-email/{email}/teams/{teamId}
Delete user's team by email
delete
DELETE /v3/users-employee_id/{employeeId}/teams/{teamId}
Delete user's team by employee id
delete
DELETE /v3/users/{userId}/teams/{teamId}
Delete user's team by id
get
GET /v3/users-email/{email}
Get user by email
get
GET /v3/users-employee_id/{employeeId}
Get user by employee id
get
GET /v3/users/{userId}
Get user by id
get
GET /v3/users
List all users
patch
PATCH /v3/users-email/{email}
Update a user by Email
patch
PATCH /v3/users-employee_id/{employeeId}
Update a user by EmployeeId
patch
PATCH /v3/users/{userId}
Update a user by ID
put
PUT /v3/users-email/{email}/teams/{teamId}
Update user's team by email
put
PUT /v3/users-employee_id/{employeeId}/teams/{teamId}
Update user's team by employee id
put
PUT /v3/users/{userId}/teams/{teamId}
Update user's team by id

Teams

Operation HTTP Request Description
post
POST /v3/teams
Create a new team
get
GET /v3/teams/{teamId}
Get team by id
get
GET /v3/teams
List all teams
patch
PATCH /v3/teams/{teamId}
Update a team

Appraisal process

Operation HTTP Request Description
post
POST /v3/paths/{pathId}/assign
Assign user to appraisal process

Goals

Operation HTTP Request Description
post
POST /v3/goals/evaluations
Bulk create goal evaluations
delete
DELETE /v3/goals/{maingoalId}/{subgoalId}/users/{userId}
Delete assignment of user to goal
get
GET /v3/goals/user/{userId}
Get goals assigned to a user
get
GET /v3/goals/user/{userId}/userSubgoals
Get subgoals assigned to a user
get
GET /v3/goals/{maingoalId}/{subgoalId}/users
Get users assigned to subgoal
get
GET /v3/goals/{maingoalId}/users
Get users directly assigned to goal
get
GET /v3/goals
List all goals
patch
PATCH /v3/goals/{maingoalId}/{subgoalId}
Update a subgoal

Access groups

Operation HTTP Request Description
get
GET /v3/groups
List all access groups

Courses

Operation HTTP Request Description
post
POST /v3/courses/{courseId}/course-categories/{categoryId}
Assign a category from a course
post
POST /v3/courses/{courseId}/participants/{userId}
Assign user to course
post
POST /v3/courses
Create a new course
delete
DELETE /v3/courses/{courseId}
Delete a course
delete
DELETE /v3/courses/{courseId}/participants/{userId}
Delete an assignment
get
GET /v3/courses/{courseId}/poll
Get a course poll
get
GET /v3/courses/{courseId}
Get a specific course
get
GET /v3/courses/{courseId}/participants/{userId}
Get a specific participant
get
GET /v3/courses/{courseId}/participants
Get all participants for a course
get
GET /v3/courses/{courseId}/course-categories
Get the categories specific course
get
GET /v3/courses
List all courses
delete
DELETE /v3/courses/{courseId}/course-categories/{categoryId}
Remove a category from a course
patch
PATCH /v3/courses/{courseId}
Update a course
patch
PATCH /v3/courses/{courseId}/participants/{userId}
Update an assignment

Course categories

Operation HTTP Request Description
post
POST /v3/course-categories/{categoryId}/courses/{courseId}
Assign a category from a category
post
POST /v3/course-categories
Create a new category
delete
DELETE /v3/course-categories/{categoryId}
Delete a category
get
GET /v3/course-categories/{categoryId}
Get a specific category
get
GET /v3/course-categories/{categoryId}/courses
Get the courses for a specific category
get
GET /v3/course-categories
List all categories
delete
DELETE /v3/course-categories/{categoryId}/courses/{courseId}
Remove a category from a category
patch
PATCH /v3/course-categories/{categoryId}
Update a category