# Onboarded Public API

Public API for Customers, Partners, and Integrations

Version: 0.0.1

## Servers

Onboarded Production Server
```
https://app.onboarded.com
```

## Security

### form_session

Type: http
Scheme: bearer

### user_session

Type: apiKey
In: cookie
Name: __session

### 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

 - [GET /api/v1/clients](https://docs.onboarded.com/openapi/clients/clients.list.md)
 - [POST /api/v1/clients](https://docs.onboarded.com/openapi/clients/clients.create.md)
 - [GET /api/v1/clients/{client_id}](https://docs.onboarded.com/openapi/clients/clients.findbyid.md)
 - [PATCH /api/v1/clients/{client_id}](https://docs.onboarded.com/openapi/clients/clients.updatebyid.md)
 - [DELETE /api/v1/clients/{client_id}](https://docs.onboarded.com/openapi/clients/clients.deletebyid.md)
## Components

 - [POST /api/v1/components/create_url](https://docs.onboarded.com/openapi/components/components.createurl.md)
## Connected Organizations

 - [GET /api/v1/connected_organizations](https://docs.onboarded.com/openapi/connected-organizations/connected_organizations.list.md)
 - [POST /api/v1/connected_organizations](https://docs.onboarded.com/openapi/connected-organizations/connected_organizations.create.md)
 - [GET /api/v1/connected_organizations/{uid}](https://docs.onboarded.com/openapi/connected-organizations/connected_organizations.findbyid.md)
 - [PATCH /api/v1/connected_organizations/{uid}](https://docs.onboarded.com/openapi/connected-organizations/connected_organizations.updatebyid.md)
 - [DELETE /api/v1/connected_organizations/{uid}](https://docs.onboarded.com/openapi/connected-organizations/connected_organizations.deletebyid.md)
## Employees

 - [GET /api/v1/employees](https://docs.onboarded.com/openapi/employees/employees.list.md)
 - [POST /api/v1/employees](https://docs.onboarded.com/openapi/employees/employees.create.md)
 - [GET /api/v1/employees/{employee_id}](https://docs.onboarded.com/openapi/employees/employees.findbyid.md)
 - [PATCH /api/v1/employees/{employee_id}](https://docs.onboarded.com/openapi/employees/employees.updatebyid.md)
 - [DELETE /api/v1/employees/{employee_id}](https://docs.onboarded.com/openapi/employees/employees.deletebyid.md)
 - [GET /api/v1/employees/{employee_id}/onboarding](https://docs.onboarded.com/openapi/employees/employees.getonboardingurl.md)
 - [PATCH /api/v1/employees/{employee_id}/migrate_completed_tasks_progress](https://docs.onboarded.com/openapi/employees/employees.migratetaskprogress.md)
## Employers

 - [GET /api/v1/employers](https://docs.onboarded.com/openapi/employers/employers.list.md)
 - [POST /api/v1/employers](https://docs.onboarded.com/openapi/employers/employers.create.md)
 - [GET /api/v1/employers/{employer_id}](https://docs.onboarded.com/openapi/employers/employers.findbyid.md)
 - [PATCH /api/v1/employers/{employer_id}](https://docs.onboarded.com/openapi/employers/employers.updatebyid.md)
 - [DELETE /api/v1/employers/{employer_id}](https://docs.onboarded.com/openapi/employers/employers.deletebyid.md)
## Events

 - [GET /api/v1/events](https://docs.onboarded.com/openapi/events/events.list.md): List webhook event history in ascending created_at order. To avoid advancing cursors past rows from still-open transactions, events are withheld from this endpoint until they are at least 30 seconds o
 - [GET /api/v1/events/{event_id}](https://docs.onboarded.com/openapi/events/events.findbyid.md)
## Files

 - [GET /api/v1/files/{file_id}](https://docs.onboarded.com/openapi/files/files.findbyid.md)
## Forms

 - [GET /api/v1/forms](https://docs.onboarded.com/openapi/forms/forms.list.md)
 - [GET /api/v1/forms/{form_id}](https://docs.onboarded.com/openapi/forms/forms.findbyid.md)
## Tasks

 - [GET /api/v1/tasks](https://docs.onboarded.com/openapi/tasks/tasks.list.md)
 - [POST /api/v1/tasks](https://docs.onboarded.com/openapi/tasks/tasks.create.md)
 - [GET /api/v1/tasks/{task_id}](https://docs.onboarded.com/openapi/tasks/tasks.findbyid.md)
 - [PATCH /api/v1/tasks/{task_id}](https://docs.onboarded.com/openapi/tasks/tasks.updatebyid.md)
 - [DELETE /api/v1/tasks/{task_id}](https://docs.onboarded.com/openapi/tasks/tasks.deletebyid.md)
 - [GET /api/v1/tasks/{task_id}/fields](https://docs.onboarded.com/openapi/tasks/tasks.getfields.md)
 - [PATCH /api/v1/tasks/{task_id}/fields](https://docs.onboarded.com/openapi/tasks/tasks.updatefields.md)
 - [GET /api/v1/tasks/{task_id}/pdf](https://docs.onboarded.com/openapi/tasks/tasks.getpdf.md)
 - [GET /api/v1/tasks/{task_id}/onboarding](https://docs.onboarded.com/openapi/tasks/tasks.getonboardingurl.md)
## Jobs

 - [GET /api/v1/jobs](https://docs.onboarded.com/openapi/jobs/jobs.list.md)
 - [POST /api/v1/jobs](https://docs.onboarded.com/openapi/jobs/jobs.create.md)
 - [GET /api/v1/jobs/{job_id}](https://docs.onboarded.com/openapi/jobs/jobs.findbyid.md)
 - [PATCH /api/v1/jobs/{job_id}](https://docs.onboarded.com/openapi/jobs/jobs.updatebyid.md)
 - [DELETE /api/v1/jobs/{job_id}](https://docs.onboarded.com/openapi/jobs/jobs.deletebyid.md)
## Placements

 - [GET /api/v1/placements](https://docs.onboarded.com/openapi/placements/placements.list.md)
 - [POST /api/v1/placements](https://docs.onboarded.com/openapi/placements/placements.create.md)
 - [GET /api/v1/placements/{placement_id}](https://docs.onboarded.com/openapi/placements/placements.findbyid.md)
 - [PATCH /api/v1/placements/{placement_id}](https://docs.onboarded.com/openapi/placements/placements.updatebyid.md)
 - [DELETE /api/v1/placements/{placement_id}](https://docs.onboarded.com/openapi/placements/placements.deletebyid.md)
 - [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
 - [GET /api/v1/placements/preview](https://docs.onboarded.com/openapi/placements/placements.previewdeprecated.md): DEPRECATED: Use POST /placements/preview instead
 - [POST /api/v1/placements/preview_tasks](https://docs.onboarded.com/openapi/placements/placements.previewtasks.md): DEPRECATED: Use POST /placements/preview instead
## Themes

 - [GET /api/v1/themes](https://docs.onboarded.com/openapi/themes/themes.list.md)
 - [POST /api/v1/themes](https://docs.onboarded.com/openapi/themes/themes.create.md)
 - [GET /api/v1/themes/{theme_id}](https://docs.onboarded.com/openapi/themes/themes.findbyid.md)
 - [PATCH /api/v1/themes/{theme_id}](https://docs.onboarded.com/openapi/themes/themes.updatebyid.md)
 - [DELETE /api/v1/themes/{theme_id}](https://docs.onboarded.com/openapi/themes/themes.deletebyid.md)
## Custom Properties

 - [GET /api/v1/custom_properties](https://docs.onboarded.com/openapi/custom-properties/custom_properties.list.md)
 - [POST /api/v1/custom_properties](https://docs.onboarded.com/openapi/custom-properties/custom_properties.create.md)
 - [GET /api/v1/custom_properties/{custom_property_id}](https://docs.onboarded.com/openapi/custom-properties/custom_properties.findbyid.md)
 - [DELETE /api/v1/custom_properties/{custom_property_id}](https://docs.onboarded.com/openapi/custom-properties/custom_properties.deletebyid.md)
 - [POST /api/v1/custom_properties/{custom_property_id}/deprecate](https://docs.onboarded.com/openapi/custom-properties/custom_properties.deprecatebyid.md)
## Magic Links

 - [POST /api/v1/magic_links](https://docs.onboarded.com/openapi/magic-links/magic_links.create.md)
## Subtasks

 - [POST /api/v1/subtasks/{subtask_id}/upload](https://docs.onboarded.com/openapi/subtasks/subtasks.uploadfiles.md)
## Task Change Requests

 - [POST /api/v1/tasks/{task_id}/task_change_requests](https://docs.onboarded.com/openapi/task-change-requests/task_change_requests.create.md)
## Users

 - [GET /api/v1/users](https://docs.onboarded.com/openapi/users/users.list.md)
 - [POST /api/v1/users](https://docs.onboarded.com/openapi/users/users.create.md)
 - [GET /api/v1/users/{user_id}](https://docs.onboarded.com/openapi/users/users.findbyid.md)
 - [PATCH /api/v1/users/{user_id}](https://docs.onboarded.com/openapi/users/users.updatebyid.md)
 - [DELETE /api/v1/users/{user_id}](https://docs.onboarded.com/openapi/users/users.deletebyid.md)
## User Groups

 - [GET /api/v1/user_groups](https://docs.onboarded.com/openapi/user-groups/user_groups.list.md): Lists the user groups of the organization behind the API credential, ordered by name. Pass the returned `id` values in the `user_group_ids` field of `POST /users`. Platform partners can list a connect
## Webhooks

 - [GET /api/v1/webhooks](https://docs.onboarded.com/openapi/webhooks/webhooks.list.md)
 - [POST /api/v1/webhooks](https://docs.onboarded.com/openapi/webhooks/webhooks.create.md)
 - [GET /api/v1/webhooks/{webhook_id}](https://docs.onboarded.com/openapi/webhooks/webhooks.findbyid.md)
 - [PATCH /api/v1/webhooks/{webhook_id}](https://docs.onboarded.com/openapi/webhooks/webhooks.updatebyid.md)
 - [DELETE /api/v1/webhooks/{webhook_id}](https://docs.onboarded.com/openapi/webhooks/webhooks.deletebyid.md)