Overview
All API reference categories and endpoints in one place. Open a tag group for full schemas and the playground, or use search (⌘K / Ctrl+K) to jump to an operation quickly.
Browse every Onboard REST operation from the combined OpenAPI spec. Open any page for request and response schemas, examples, and the interactive playground.
OpenAPI spec — resources.onboard.io/openapi.json (production JSON for codegen, Postman import, and other tools).
Search — Press ⌘ K (macOS) or Ctrl K (Windows) to search across all API reference pages by title, path, or tag.
312 operations in 11 categories.
Activity
Assets
Comments
Custom
- GET/email/templates
- POST/email/templates
- GET/email/templates/{template_type}
- PUT/email/templates/{template_type}
- PATCH/email/templates/{template_type}
- DELETE/email/templates/{template_type}
- GET/email/templates/{template_type}/{custom_template_name}
- PUT/email/templates/{template_type}/{custom_template_name}
- PATCH/email/templates/{template_type}/{custom_template_name}
- DELETE/email/templates/{template_type}/{custom_template_name}
- GET/email/templates/{template_type}/default
- GET/email/templates/{template_type}/merge_tags
- POST/email/templates/{template_type}/send
- POST/email/templates/{template_type}/send/{custom_template_name}
- POST/email/templates/{template_type}/send/preview
- POST/email/templates/slugify
Forms
Hooks
Map
- GET/history/map-tasks
- GET/history/map-update
- GET/map-types
- POST/map-types
- GET/map-types/{id}
- PUT/map-types/{id}
- PATCH/map-types/{id}
- DELETE/map-types/{id}
- GET/my-tasks
- GET/options
- GET/options/{id}
- PUT/options/{id}
- PATCH/options/{id}
- DELETE/options/{id}
- GET/project-assets
- POST/project-assets
- GET/project-assets/{id}
- PUT/project-assets/{id}
- PATCH/project-assets/{id}
- DELETE/project-assets/{id}
- GET/project-types
- POST/project-types
- GET/project-types/{id}
- PUT/project-types/{id}
- PATCH/project-types/{id}
- DELETE/project-types/{id}
- GET/projects
- POST/projects
- GET/projects/{id}
- PUT/projects/{id}
- PATCH/projects/{id}
- DELETE/projects/{id}
- GET/projects/{id}/assessment-history
- GET/projects/{id}/assessment-history/export
- GET/projects/{id}/gantt/export
- POST/projects/{id}/gantt/export
- GET/projects/{id}/insights/summary
- POST/projects/{id}/preview
- GET/projects/{id}/preview-status
- GET/projects/{id}/tasks
- POST/projects/{id}/tasks
- GET/projects/{id}/tasks/{id}
- PUT/projects/{id}/tasks/{id}
- PATCH/projects/{id}/tasks/{id}
- DELETE/projects/{id}/tasks/{id}
- POST/projects/{id}/tasks/{id}/move
- POST/projects/{id}/tasks/{id}/nudge
- GET/projects/{project_id}/onboardee-users
- POST/projects/{project_id}/onboardee-users
- GET/projects/{project_id}/onboardee-users/{onboardee_user_id}
- PUT/projects/{project_id}/onboardee-users/{onboardee_user_id}
- PATCH/projects/{project_id}/onboardee-users/{onboardee_user_id}
- DELETE/projects/{project_id}/onboardee-users/{onboardee_user_id}
- POST/projects/{project_id}/onboardee-users/{onboardee_user_id}/invite
- GET/projects/{project_id}/onboarder-users
- POST/projects/{project_id}/onboarder-users
- GET/projects/{project_id}/onboarder-users/{onboarder_user_id}
- PUT/projects/{project_id}/onboarder-users/{onboarder_user_id}
- PATCH/projects/{project_id}/onboarder-users/{onboarder_user_id}
- DELETE/projects/{project_id}/onboarder-users/{onboarder_user_id}
- POST/projects/{project_id}/onboarder-users/{onboarder_user_id}/invite
- GET/projects/export
- POST/projects/export
- GET/projects/preview/{id}
- POST/projects/preview/{id}
- DELETE/projects/preview/{id}
- GET/projects/preview/{id}/save
- POST/projects/preview/{id}/save
- DELETE/projects/preview/{id}/save
- GET/roadmaps
- POST/roadmaps
- GET/roadmaps/{id}
- PUT/roadmaps/{id}
- PATCH/roadmaps/{id}
- DELETE/roadmaps/{id}
- GET/roadmaps/{id}/assessment-history
- GET/roadmaps/{id}/assessment-history/export
- POST/roadmaps/{id}/assignment
- GET/roadmaps/{id}/gantt/export
- POST/roadmaps/{id}/gantt/export
- GET/roadmaps/{id}/insights/summary
- GET/roadmaps/{id}/members
- POST/roadmaps/{id}/preview
- GET/roadmaps/{id}/preview-status
- GET/roadmaps/{id}/tasks
- POST/roadmaps/{id}/tasks
- GET/roadmaps/{id}/tasks/{id}
- PUT/roadmaps/{id}/tasks/{id}
- PATCH/roadmaps/{id}/tasks/{id}
- DELETE/roadmaps/{id}/tasks/{id}
- POST/roadmaps/{id}/tasks/{id}/move
- POST/roadmaps/{id}/tasks/{id}/nudge
- GET/roadmaps/{roadmap_id}/onboardee-users
- POST/roadmaps/{roadmap_id}/onboardee-users
- GET/roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}
- PUT/roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}
- PATCH/roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}
- DELETE/roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}
- POST/roadmaps/{roadmap_id}/onboardee-users/{onboardee_user_id}/invite
- GET/roadmaps/{roadmap_id}/onboarder-users
- POST/roadmaps/{roadmap_id}/onboarder-users
- GET/roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}
- PUT/roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}
- PATCH/roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}
- DELETE/roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}
- POST/roadmaps/{roadmap_id}/onboarder-users/{onboarder_user_id}/invite
- GET/roadmaps/export
- POST/roadmaps/export
- GET/roadmaps/preview/{id}
- POST/roadmaps/preview/{id}
- DELETE/roadmaps/preview/{id}
- GET/roadmaps/preview/{id}/save
- POST/roadmaps/preview/{id}/save
- DELETE/roadmaps/preview/{id}/save
- GET/roadmaps/tasks/{id}
- PUT/roadmaps/tasks/{id}
- PATCH/roadmaps/tasks/{id}
- DELETE/roadmaps/tasks/{id}
- POST/roadmaps/tasks/{id}/nudge
- GET/tasks
- POST/tasks
- GET/tasks/{id}
- PUT/tasks/{id}
- PATCH/tasks/{id}
- DELETE/tasks/{id}
- POST/tasks/{id}/move
- GET/tasks/calendar/config
- POST/tasks/exports
- POST/tasks/imports
- GET/team-tasks
- GET/time-tracking/exports/{id}
- GET/variables
- POST/variables
- GET/variables/{id}
- PUT/variables/{id}
- PATCH/variables/{id}
- DELETE/variables/{id}
Platform
- GET/account
- PUT/account
- PATCH/account
- GET/account/address
- PUT/account/address
- PATCH/account/address
- GET/api-accounts
- POST/api-accounts
- GET/api-accounts/{id}
- PUT/api-accounts/{id}
- PATCH/api-accounts/{id}
- DELETE/api-accounts/{id}
- GET/companies
- POST/companies
- GET/companies/{id}
- PUT/companies/{id}
- PATCH/companies/{id}
- DELETE/companies/{id}
- GET/companies/{id}/members
- POST/companies/{id}/members
- GET/companies/{id}/members/{id}
- PUT/companies/{id}/members/{id}
- PATCH/companies/{id}/members/{id}
- DELETE/companies/{id}/members/{id}
- GET/companies/members
- GET/company-members/{id}
- PUT/company-members/{id}
- PATCH/company-members/{id}
- DELETE/company-members/{id}
- GET/customers
- POST/customers
- GET/customers/{id}
- PUT/customers/{id}
- PATCH/customers/{id}
- DELETE/customers/{id}
- GET/customers/{id}/members
- POST/customers/{id}/members
- GET/customers/{id}/members/{id}
- PUT/customers/{id}/members/{id}
- PATCH/customers/{id}/members/{id}
- DELETE/customers/{id}/members/{id}
- GET/defaults
- POST/member-requests
- GET/members
- POST/members
- GET/members/{id}
- PUT/members/{id}
- PATCH/members/{id}
- DELETE/members/{id}
- POST/members/{id}/invite
- GET/onboardee-user/notifications
- PUT/onboardee-user/notifications
- PATCH/onboardee-user/notifications
- GET/onboarder-user/notifications
- PUT/onboarder-user/notifications
- PATCH/onboarder-user/notifications
- GET/roles
- POST/roles
- GET/roles/{id}
- PUT/roles/{id}
- PATCH/roles/{id}
- DELETE/roles/{id}
- GET/sso
- PUT/sso
- PATCH/sso
- DELETE/sso
- POST/sso/create
- GET/terms-acceptance
- POST/terms-acceptance
Stats
- GET/dashboard/configuration-types
- GET/dashboard/configurations
- POST/dashboard/configurations
- GET/dashboard/configurations/{id}
- PUT/dashboard/configurations/{id}
- PATCH/dashboard/configurations/{id}
- DELETE/dashboard/configurations/{id}
- POST/dashboard/configurations/{id}/set-default
- GET/dashboard/configurations/type/{config_type}
- GET/dashboard/graph/active-maps
- GET/dashboard/kpis
- GET/dashboard/kpis/detail
- GET/dashboard/kpis/export
- GET/dashboard/map-owners
- GET/dashboard/metric-thresholds
- POST/dashboard/metric-thresholds
- GET/dashboard/metric-thresholds/{id}
- PUT/dashboard/metric-thresholds/{id}
- PATCH/dashboard/metric-thresholds/{id}
- DELETE/dashboard/metric-thresholds/{id}
- GET/dashboard/metric-thresholds/{id}/history
- POST/dashboard/metric-thresholds/initialize
- GET/dashboard/metric-thresholds/metric/{metric_key}
- GET/dashboard/summary
- GET/dashboard/templates
- POST/dashboard/templates/{template_id}/create-from
- GET/dashboard/templates/type/{config_type}
Workflows
- GET/workflows
- POST/workflows
- GET/workflows/{id}
- PUT/workflows/{id}
- PATCH/workflows/{id}
- DELETE/workflows/{id}
- GET/workflows/{id}/actions
- POST/workflows/{id}/actions
- GET/workflows/{id}/actions/{id}
- PUT/workflows/{id}/actions/{id}
- PATCH/workflows/{id}/actions/{id}
- DELETE/workflows/{id}/actions/{id}
- POST/workflows/{id}/run
- GET/workflows/{id}/to-json
- POST/workflows/ai/generate
- GET/workflows/categories
- GET/workflows/filters/options
- GET/workflows/history
- GET/workflows/quick-actions
- GET/workflows/recipes
How is this guide?