/
ON
onboard
/
Onboard API - Complete Specification
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Checked 6h ago · Updated 1d ago
Details
Filter operations
Activity
2
Assets
12
Billing
2
Bots
66
Comments
22
Communication Records
18
Conversations
14
Custom
14
Email
25
Forms
15
Hooks
12
Knowledge Base
23
Map
271
get
GET /history/map-tasks
options
OPTIONS /history/map-tasks
get
GET /history/map-update
options
OPTIONS /history/map-update
get
GET /options
options
OPTIONS /options
get
GET /options/{id}
put
PUT /options/{id}
delete
DELETE /options/{id}
options
OPTIONS /options/{id}
patch
PATCH /options/{id}
get
GET /get/roadmaps
options
OPTIONS /get/roadmaps
get
GET /get/roadmaps/{id}
options
OPTIONS /get/roadmaps/{id}
get
GET /roadmaps
post
POST /roadmaps
options
OPTIONS /roadmaps
get
GET /roadmaps/export
post
POST /roadmaps/export
options
OPTIONS /roadmaps/export
get
GET /roadmaps/{id}/gantt/export
post
POST /roadmaps/{id}/gantt/export
options
OPTIONS /roadmaps/{id}/gantt/export
get
GET /roadmaps/{id}
put
PUT /roadmaps/{id}
delete
DELETE /roadmaps/{id}
options
OPTIONS /roadmaps/{id}
patch
PATCH /roadmaps/{id}
get
GET /roadmaps/{id}/tasks
post
POST /roadmaps/{id}/tasks
options
OPTIONS /roadmaps/{id}/tasks
get
GET /roadmaps/{id}/tasks/{id}
put
PUT /roadmaps/{id}/tasks/{id}
delete
DELETE /roadmaps/{id}/tasks/{id}
options
OPTIONS /roadmaps/{id}/tasks/{id}
patch
PATCH /roadmaps/{id}/tasks/{id}
post
POST /roadmaps/{id}/tasks/{id}/nudge
options
OPTIONS /roadmaps/{id}/tasks/{id}/nudge
get
GET /get/roadmaps/{id}/tasks
options
OPTIONS /get/roadmaps/{id}/tasks
get
GET /get/roadmaps/{id}/tasks/dependencies
options
OPTIONS /get/roadmaps/{id}/tasks/dependencies
get
GET /get/roadmaps/{id}/tasks/{id}
options
OPTIONS /get/roadmaps/{id}/tasks/{id}
post
POST /roadmaps/{id}/tasks/{id}/move
options
OPTIONS /roadmaps/{id}/tasks/{id}/move
get
GET /roadmaps/tasks/{id}
put
PUT /roadmaps/tasks/{id}
delete
DELETE /roadmaps/tasks/{id}
options
OPTIONS /roadmaps/tasks/{id}
patch
PATCH /roadmaps/tasks/{id}
post
POST /roadmaps/tasks/{id}/nudge
options
OPTIONS /roadmaps/tasks/{id}/nudge
post
POST /roadmaps/{id}/assignment
options
OPTIONS /roadmaps/{id}/assignment
get
GET /roadmaps/{id}/members
options
OPTIONS /roadmaps/{id}/members
get
GET /roadmaps/{id}/actions
post
POST /roadmaps/{id}/actions
options
OPTIONS /roadmaps/{id}/actions
post
POST /roadmaps/{id}/preview
options
OPTIONS /roadmaps/{id}/preview
get
GET /roadmaps/{id}/preview-status
options
OPTIONS /roadmaps/{id}/preview-status
get
GET /roadmaps/preview/{id}
post
POST /roadmaps/preview/{id}
delete
DELETE /roadmaps/preview/{id}
options
OPTIONS /roadmaps/preview/{id}
get
GET /roadmaps/preview/{id}/save
post
POST /roadmaps/preview/{id}/save
delete
DELETE /roadmaps/preview/{id}/save
options
OPTIONS /roadmaps/preview/{id}/save
get
GET /roadmaps/{id}/insights/summary
options
OPTIONS /roadmaps/{id}/insights/summary
get
GET /roadmaps/{id}/assessment-history
options
OPTIONS /roadmaps/{id}/assessment-history
get
GET /roadmaps/{id}/assessment-history/export
options
OPTIONS /roadmaps/{id}/assessment-history/export
get
GET /roadmaps/{roadmap_id}/onboardee-users
post
POST /roadmaps/{roadmap_id}/onboardee-users
options
OPTIONS /roadmaps/{roadmap_id}/onboardee-users
get
GET /roadmaps/{roadmap_id}/onboarder-users
post
POST /roadmaps/{roadmap_id}/onboarder-users
options
OPTIONS /roadmaps/{roadmap_id}/onboarder-users
get
GET /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}
put
PUT /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}
delete
DELETE /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}
options
OPTIONS /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}
patch
PATCH /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}
get
GET /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}
put
PUT /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}
delete
DELETE /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}
options
OPTIONS /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}
patch
PATCH /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}
post
POST /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}/invite
options
OPTIONS /roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}/invite
post
POST /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}/invite
options
OPTIONS /roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}/invite
get
GET /projects
post
POST /projects
options
OPTIONS /projects
get
GET /projects/export
post
POST /projects/export
options
OPTIONS /projects/export
get
GET /projects/{id}/gantt/export
post
POST /projects/{id}/gantt/export
options
OPTIONS /projects/{id}/gantt/export
get
GET /projects/{id}
put
PUT /projects/{id}
delete
DELETE /projects/{id}
options
OPTIONS /projects/{id}
patch
PATCH /projects/{id}
get
GET /projects/{id}/tasks
post
POST /projects/{id}/tasks
options
OPTIONS /projects/{id}/tasks
get
GET /projects/{id}/tasks/{id}
put
PUT /projects/{id}/tasks/{id}
delete
DELETE /projects/{id}/tasks/{id}
options
OPTIONS /projects/{id}/tasks/{id}
patch
PATCH /projects/{id}/tasks/{id}
post
POST /projects/{id}/tasks/{id}/nudge
options
OPTIONS /projects/{id}/tasks/{id}/nudge
post
POST /projects/{id}/tasks/{id}/move
options
OPTIONS /projects/{id}/tasks/{id}/move
get
GET /projects/{id}/actions
post
POST /projects/{id}/actions
options
OPTIONS /projects/{id}/actions
post
POST /projects/{id}/preview
options
OPTIONS /projects/{id}/preview
get
GET /projects/{id}/preview-status
options
OPTIONS /projects/{id}/preview-status
get
GET /projects/preview/{id}
post
POST /projects/preview/{id}
delete
DELETE /projects/preview/{id}
options
OPTIONS /projects/preview/{id}
get
GET /projects/preview/{id}/save
post
POST /projects/preview/{id}/save
delete
DELETE /projects/preview/{id}/save
options
OPTIONS /projects/preview/{id}/save
get
GET /projects/{id}/insights/summary
options
OPTIONS /projects/{id}/insights/summary
get
GET /projects/{id}/assessment-history
options
OPTIONS /projects/{id}/assessment-history
get
GET /projects/{id}/assessment-history/export
options
OPTIONS /projects/{id}/assessment-history/export
get
GET /projects/{project_id}/onboardee-users
post
POST /projects/{project_id}/onboardee-users
options
OPTIONS /projects/{project_id}/onboardee-users
get
GET /projects/{project_id}/onboarder-users
post
POST /projects/{project_id}/onboarder-users
options
OPTIONS /projects/{project_id}/onboarder-users
get
GET /projects/{project_id}/onboardee-users/{onboardee_user_id}
put
PUT /projects/{project_id}/onboardee-users/{onboardee_user_id}
delete
DELETE /projects/{project_id}/onboardee-users/{onboardee_user_id}
options
OPTIONS /projects/{project_id}/onboardee-users/{onboardee_user_id}
patch
PATCH /projects/{project_id}/onboardee-users/{onboardee_user_id}
get
GET /projects/{project_id}/onboarder-users/{onboarder_user_id}
put
PUT /projects/{project_id}/onboarder-users/{onboarder_user_id}
delete
DELETE /projects/{project_id}/onboarder-users/{onboarder_user_id}
options
OPTIONS /projects/{project_id}/onboarder-users/{onboarder_user_id}
patch
PATCH /projects/{project_id}/onboarder-users/{onboarder_user_id}
post
POST /projects/{project_id}/onboardee-users/{onboardee_user_id}/invite
options
OPTIONS /projects/{project_id}/onboardee-users/{onboardee_user_id}/invite
post
POST /projects/{project_id}/onboarder-users/{onboarder_user_id}/invite
options
OPTIONS /projects/{project_id}/onboarder-users/{onboarder_user_id}/invite
get
GET /get/projects
options
OPTIONS /get/projects
get
GET /get/projects/{id}
options
OPTIONS /get/projects/{id}
get
GET /get/projects/{id}/tasks
options
OPTIONS /get/projects/{id}/tasks
get
GET /get/projects/{id}/tasks/{id}
options
OPTIONS /get/projects/{id}/tasks/{id}
get
GET /get/projects/{id}/tasks/dependencies
options
OPTIONS /get/projects/{id}/tasks/dependencies
get
GET /tasks
post
POST /tasks
options
OPTIONS /tasks
get
GET /tasks/{id}
put
PUT /tasks/{id}
delete
DELETE /tasks/{id}
options
OPTIONS /tasks/{id}
patch
PATCH /tasks/{id}
post
POST /tasks/{id}/move
options
OPTIONS /tasks/{id}/move
get
GET /get/tasks
options
OPTIONS /get/tasks
get
GET /get/tasks/dependencies
options
OPTIONS /get/tasks/dependencies
get
GET /get/tasks/{id}
options
OPTIONS /get/tasks/{id}
get
GET /tasks/actions
post
POST /tasks/actions
options
OPTIONS /tasks/actions
post
POST /tasks/exports
options
OPTIONS /tasks/exports
post
POST /tasks/imports
options
OPTIONS /tasks/imports
get
GET /tasks/calendar/config
options
OPTIONS /tasks/calendar/config
get
GET /my-tasks
options
OPTIONS /my-tasks
get
GET /team-tasks
options
OPTIONS /team-tasks
get
GET /time-tracking/exports/{id}
options
OPTIONS /time-tracking/exports/{id}
get
GET /variables
post
POST /variables
options
OPTIONS /variables
get
GET /variables/{id}
put
PUT /variables/{id}
delete
DELETE /variables/{id}
options
OPTIONS /variables/{id}
patch
PATCH /variables/{id}
get
GET /variables/actions
post
POST /variables/actions
options
OPTIONS /variables/actions
get
GET /map-types
post
POST /map-types
options
OPTIONS /map-types
get
GET /map-types/{id}
put
PUT /map-types/{id}
delete
DELETE /map-types/{id}
options
OPTIONS /map-types/{id}
patch
PATCH /map-types/{id}
get
GET /project-types
post
POST /project-types
options
OPTIONS /project-types
get
GET /project-types/{id}
put
PUT /project-types/{id}
delete
DELETE /project-types/{id}
options
OPTIONS /project-types/{id}
patch
PATCH /project-types/{id}
get
GET /templates
post
POST /templates
options
OPTIONS /templates
get
GET /templates/{id}
put
PUT /templates/{id}
delete
DELETE /templates/{id}
options
OPTIONS /templates/{id}
patch
PATCH /templates/{id}
post
POST /templates/{id}/duplicate
options
OPTIONS /templates/{id}/duplicate
post
POST /templates/{id}/launch
options
OPTIONS /templates/{id}/launch
post
POST /templates/{id}/create-global-tasks
options
OPTIONS /templates/{id}/create-global-tasks
get
GET /templates/{template_id}/tasks
post
POST /templates/{template_id}/tasks
options
OPTIONS /templates/{template_id}/tasks
get
GET /templates/{template_id}/tasks/{task_id}
put
PUT /templates/{template_id}/tasks/{task_id}
delete
DELETE /templates/{template_id}/tasks/{task_id}
options
OPTIONS /templates/{template_id}/tasks/{task_id}
patch
PATCH /templates/{template_id}/tasks/{task_id}
post
POST /templates/{template_id}/tasks/{task_id}/move
options
OPTIONS /templates/{template_id}/tasks/{task_id}/move
get
GET /templates/{template_id}/tasks/actions
post
POST /templates/{template_id}/tasks/actions
options
OPTIONS /templates/{template_id}/tasks/actions
post
POST /projects/{id}/convert-to-template
options
OPTIONS /projects/{id}/convert-to-template
get
GET /project-assets
post
POST /project-assets
options
OPTIONS /project-assets
get
GET /project-assets/{id}
put
PUT /project-assets/{id}
delete
DELETE /project-assets/{id}
options
OPTIONS /project-assets/{id}
patch
PATCH /project-assets/{id}
Platform
105
Stats
46
Workflows
32
Map
GET /options/{id}
GET operation for /options/{id}
get
/options/{id}
Path parameters
id
string
required
Response
Successful response
OptionSerializer
required
id
integer
name
string
required
delete
boolean
order
integer
Changes