# Onboarded Public API Public API for Customers, Partners, and Integrations Version: 0.0.1 ## Servers Onboarded Production Server ``` https://app.onboarded.com ``` ## Security ### user_session Type: apiKey In: cookie Name: __session ### form_session Type: http Scheme: bearer ### component_session Type: apiKey In: cookie Name: __component ### component_token Type: apiKey In: header Name: x-component-auth-token ### api_token Type: http Scheme: bearer ## Download OpenAPI description [Onboarded Public API](https://docs.onboarded.com/_bundle/openapi.yaml) ## Clients API for managing clients ### List all clients - [GET /api/v1/clients](https://docs.onboarded.com/openapi/clients/clients.list.md) ### Create a new client - [POST /api/v1/clients](https://docs.onboarded.com/openapi/clients/clients.create.md) ### Get a client by ID - [GET /api/v1/clients/{client_id}](https://docs.onboarded.com/openapi/clients/clients.findbyid.md) ### Update a client - [PATCH /api/v1/clients/{client_id}](https://docs.onboarded.com/openapi/clients/clients.updatebyid.md) ### Delete a client - [DELETE /api/v1/clients/{client_id}](https://docs.onboarded.com/openapi/clients/clients.deletebyid.md) ## Components API for creating embeddable component URLs ### Create a component URL - [POST /api/v1/components/create_url](https://docs.onboarded.com/openapi/components/components.createurl.md) ## Connected Organizations API for managing connected organizations and their configuration ### List all connected organizations - [GET /api/v1/connected_organizations](https://docs.onboarded.com/openapi/connected-organizations/connected_organizations.list.md) ### Create a connected organization - [POST /api/v1/connected_organizations](https://docs.onboarded.com/openapi/connected-organizations/connected_organizations.create.md) ### Get a connected organization by ID - [GET /api/v1/connected_organizations/{uid}](https://docs.onboarded.com/openapi/connected-organizations/connected_organizations.findbyid.md) ### Update a connected organization - [PATCH /api/v1/connected_organizations/{uid}](https://docs.onboarded.com/openapi/connected-organizations/connected_organizations.updatebyid.md) ### Delete a connected organization - [DELETE /api/v1/connected_organizations/{uid}](https://docs.onboarded.com/openapi/connected-organizations/connected_organizations.deletebyid.md) ## Employees API for managing employees ### List all employees - [GET /api/v1/employees](https://docs.onboarded.com/openapi/employees/employees.list.md) ### Create a new employee - [POST /api/v1/employees](https://docs.onboarded.com/openapi/employees/employees.create.md) ### Get an employee by ID - [GET /api/v1/employees/{employee_id}](https://docs.onboarded.com/openapi/employees/employees.findbyid.md) ### Update an employee - [PATCH /api/v1/employees/{employee_id}](https://docs.onboarded.com/openapi/employees/employees.updatebyid.md) ### Delete an employee - [DELETE /api/v1/employees/{employee_id}](https://docs.onboarded.com/openapi/employees/employees.deletebyid.md) ### Get onboarding URL for an employee - [GET /api/v1/employees/{employee_id}/onboarding](https://docs.onboarded.com/openapi/employees/employees.getonboardingurl.md) ### Migrate completed task progress - [PATCH /api/v1/employees/{employee_id}/migrate_completed_tasks_progress](https://docs.onboarded.com/openapi/employees/employees.migratetaskprogress.md) ## Employers API for managing employers ### List all employers - [GET /api/v1/employers](https://docs.onboarded.com/openapi/employers/employers.list.md) ### Create a new employer - [POST /api/v1/employers](https://docs.onboarded.com/openapi/employers/employers.create.md) ### Get an employer by ID - [GET /api/v1/employers/{employer_id}](https://docs.onboarded.com/openapi/employers/employers.findbyid.md) ### Update an employer - [PATCH /api/v1/employers/{employer_id}](https://docs.onboarded.com/openapi/employers/employers.updatebyid.md) ### Delete an employer - [DELETE /api/v1/employers/{employer_id}](https://docs.onboarded.com/openapi/employers/employers.deletebyid.md) ## Files API for accessing uploaded files ### Get a file by ID - [GET /api/v1/files/{file_id}](https://docs.onboarded.com/openapi/files/files.findbyid.md) ## Forms API for accessing forms ### List all forms - [GET /api/v1/forms](https://docs.onboarded.com/openapi/forms/forms.list.md) ### Get a form by ID - [GET /api/v1/forms/{form_id}](https://docs.onboarded.com/openapi/forms/forms.findbyid.md) ## Tasks API for managing tasks ### List all tasks - [GET /api/v1/tasks](https://docs.onboarded.com/openapi/tasks/tasks.list.md) ### Create a new task - [POST /api/v1/tasks](https://docs.onboarded.com/openapi/tasks/tasks.create.md) ### Get a task by ID - [GET /api/v1/tasks/{task_id}](https://docs.onboarded.com/openapi/tasks/tasks.findbyid.md) ### Update a task - [PATCH /api/v1/tasks/{task_id}](https://docs.onboarded.com/openapi/tasks/tasks.updatebyid.md) ### Delete a task - [DELETE /api/v1/tasks/{task_id}](https://docs.onboarded.com/openapi/tasks/tasks.deletebyid.md) ### Get task fields - [GET /api/v1/tasks/{task_id}/fields](https://docs.onboarded.com/openapi/tasks/tasks.getfields.md) ### Update task fields - [PATCH /api/v1/tasks/{task_id}/fields](https://docs.onboarded.com/openapi/tasks/tasks.updatefields.md) ### Download task as PDF - [GET /api/v1/tasks/{task_id}/pdf](https://docs.onboarded.com/openapi/tasks/tasks.getpdf.md) ### Get onboarding URL for a task - [GET /api/v1/tasks/{task_id}/onboarding](https://docs.onboarded.com/openapi/tasks/tasks.getonboardingurl.md) ## Jobs API for managing jobs ### List all jobs - [GET /api/v1/jobs](https://docs.onboarded.com/openapi/jobs/jobs.list.md) ### Create a new job - [POST /api/v1/jobs](https://docs.onboarded.com/openapi/jobs/jobs.create.md) ### Get a job by ID - [GET /api/v1/jobs/{job_id}](https://docs.onboarded.com/openapi/jobs/jobs.findbyid.md) ### Update a job - [PATCH /api/v1/jobs/{job_id}](https://docs.onboarded.com/openapi/jobs/jobs.updatebyid.md) ### Delete a job - [DELETE /api/v1/jobs/{job_id}](https://docs.onboarded.com/openapi/jobs/jobs.deletebyid.md) ## Placements API for managing placements ### List all placements - [GET /api/v1/placements](https://docs.onboarded.com/openapi/placements/placements.list.md) ### Create a new placement - [POST /api/v1/placements](https://docs.onboarded.com/openapi/placements/placements.create.md) ### Get a placement by ID - [GET /api/v1/placements/{placement_id}](https://docs.onboarded.com/openapi/placements/placements.findbyid.md) ### Update a placement - [PATCH /api/v1/placements/{placement_id}](https://docs.onboarded.com/openapi/placements/placements.updatebyid.md) ### Delete a placement - [DELETE /api/v1/placements/{placement_id}](https://docs.onboarded.com/openapi/placements/placements.deletebyid.md) ### placements.preview - [POST /api/v1/placements/preview](https://docs.onboarded.com/openapi/placements/placements.preview.md): Generate a transient placement to preview form requirements without creating it ### placements.previewDeprecated (deprecated) - [GET /api/v1/placements/preview](https://docs.onboarded.com/openapi/placements/placements.previewdeprecated.md): DEPRECATED: Use POST /placements/preview instead ### placements.previewTasks (deprecated) - [POST /api/v1/placements/preview_tasks](https://docs.onboarded.com/openapi/placements/placements.previewtasks.md): DEPRECATED: Use POST /placements/preview instead ## Themes API for managing themes ### List all themes - [GET /api/v1/themes](https://docs.onboarded.com/openapi/themes/themes.list.md) ### Create a new theme - [POST /api/v1/themes](https://docs.onboarded.com/openapi/themes/themes.create.md) ### Get a theme by ID - [GET /api/v1/themes/{theme_id}](https://docs.onboarded.com/openapi/themes/themes.findbyid.md) ### Update a theme - [PATCH /api/v1/themes/{theme_id}](https://docs.onboarded.com/openapi/themes/themes.updatebyid.md) ### Delete a theme - [DELETE /api/v1/themes/{theme_id}](https://docs.onboarded.com/openapi/themes/themes.deletebyid.md) ## Custom Properties API for managing custom properties ### List all custom properties - [GET /api/v1/custom_properties](https://docs.onboarded.com/openapi/custom-properties/custom_properties.list.md) ### Create a custom property - [POST /api/v1/custom_properties](https://docs.onboarded.com/openapi/custom-properties/custom_properties.create.md) ### Get a custom property by ID - [GET /api/v1/custom_properties/{custom_property_id}](https://docs.onboarded.com/openapi/custom-properties/custom_properties.findbyid.md) ### Delete a custom property - [DELETE /api/v1/custom_properties/{custom_property_id}](https://docs.onboarded.com/openapi/custom-properties/custom_properties.deletebyid.md) ### Deprecate a custom property - [POST /api/v1/custom_properties/{custom_property_id}/deprecate](https://docs.onboarded.com/openapi/custom-properties/custom_properties.deprecatebyid.md) ## Magic Links API for creating magic links for user authentication ### Create a magic link - [POST /api/v1/magic_links](https://docs.onboarded.com/openapi/magic-links/magic_links.create.md) ## Subtasks Subtask management and file upload API ### Upload files to a subtask - [POST /api/v1/subtasks/{subtask_id}/upload](https://docs.onboarded.com/openapi/subtasks/subtasks.uploadfiles.md) ## Task Change Requests API for requesting changes to completed tasks ### Create a task change request - [POST /api/v1/tasks/{task_id}/task_change_requests](https://docs.onboarded.com/openapi/task-change-requests/task_change_requests.create.md) ## Users API for managing users ### List all users - [GET /api/v1/users](https://docs.onboarded.com/openapi/users/users.list.md) ### Create a new user - [POST /api/v1/users](https://docs.onboarded.com/openapi/users/users.create.md) ### Get a user by ID - [GET /api/v1/users/{user_id}](https://docs.onboarded.com/openapi/users/users.findbyid.md) ### Update a user - [PATCH /api/v1/users/{user_id}](https://docs.onboarded.com/openapi/users/users.updatebyid.md) ### Delete a user - [DELETE /api/v1/users/{user_id}](https://docs.onboarded.com/openapi/users/users.deletebyid.md) ## Webhooks API for managing webhooks ### List all webhooks - [GET /api/v1/webhooks](https://docs.onboarded.com/openapi/webhooks/webhooks.list.md) ### Create a new webhook - [POST /api/v1/webhooks](https://docs.onboarded.com/openapi/webhooks/webhooks.create.md) ### Get a webhook by ID - [GET /api/v1/webhooks/{webhook_id}](https://docs.onboarded.com/openapi/webhooks/webhooks.findbyid.md) ### Update a webhook - [PATCH /api/v1/webhooks/{webhook_id}](https://docs.onboarded.com/openapi/webhooks/webhooks.updatebyid.md) ### Delete a webhook - [DELETE /api/v1/webhooks/{webhook_id}](https://docs.onboarded.com/openapi/webhooks/webhooks.deletebyid.md)