# Onboarded API

Version: 0.0.1

## Servers

```
https://app.onboarded.com
```

## Security

### bearerAuth

Type: http
Scheme: bearer

## Download OpenAPI description

[Onboarded API](https://docs.onboarded.com/_spec/openapi.yaml)

## Components

Components APIs

### Create a embedded component url

 - [POST /api/v1/components/create_url](https://docs.onboarded.com/openapi/components/createtoken.md)

## Employees

Employees APIs

### List all employees

 - [GET /api/v1/employees](https://docs.onboarded.com/openapi/employees/getemployees.md)

### Create an employee

 - [POST /api/v1/employees](https://docs.onboarded.com/openapi/employees/createemployee.md)

### Get an employee by id

 - [GET /api/v1/employees/{id}](https://docs.onboarded.com/openapi/employees/getemployee.md)

### Update an employee

 - [PATCH /api/v1/employees/{id}](https://docs.onboarded.com/openapi/employees/updateemployee.md)

### Delete an employee by id

 - [DELETE /api/v1/employees/{id}](https://docs.onboarded.com/openapi/employees/deleteemployee.md)

### Get an employee onboarding url

 - [GET /api/v1/employees/{id}/onboarding](https://docs.onboarded.com/openapi/employees/getemployeeonboardingurl.md)

## Employers

Employers APIs

### List all employers

 - [GET /api/v1/employers](https://docs.onboarded.com/openapi/employers/getemployers.md)

### Create an employer

 - [POST /api/v1/employers](https://docs.onboarded.com/openapi/employers/createemployer.md)

### Get an employer by id

 - [GET /api/v1/employers/{id}](https://docs.onboarded.com/openapi/employers/getemployer.md)

### Update an employer

 - [PATCH /api/v1/employers/{id}](https://docs.onboarded.com/openapi/employers/updateemployer.md)

### Delete an employer

 - [DELETE /api/v1/employers/{id}](https://docs.onboarded.com/openapi/employers/deleteemployer.md)

## Clients

Clients APIs

### List all clients

 - [GET /api/v1/clients](https://docs.onboarded.com/openapi/clients/getclients.md)

### Create a client

 - [POST /api/v1/clients](https://docs.onboarded.com/openapi/clients/createclient.md)

### Get a client by id

 - [GET /api/v1/clients/{id}](https://docs.onboarded.com/openapi/clients/getclient.md)

### Update a client

 - [PATCH /api/v1/clients/{id}](https://docs.onboarded.com/openapi/clients/updateclient.md)

### Delete a client

 - [DELETE /api/v1/clients/{id}](https://docs.onboarded.com/openapi/clients/deleteclient.md)

## Jobs

Jobs APIs

### List all jobs

 - [GET /api/v1/jobs](https://docs.onboarded.com/openapi/jobs/getjobs.md)

### Create a job

 - [POST /api/v1/jobs](https://docs.onboarded.com/openapi/jobs/createjob.md)

### Get a job by id

 - [GET /api/v1/jobs/{id}](https://docs.onboarded.com/openapi/jobs/getjob.md)

### Update a job

 - [PATCH /api/v1/jobs/{id}](https://docs.onboarded.com/openapi/jobs/updatejob.md)

### Delete a job

 - [DELETE /api/v1/jobs/{id}](https://docs.onboarded.com/openapi/jobs/deletejob.md)

## Placements

Placements APIs

### Get a preview of a placement and its tasks

 - [POST /api/v1/placements/preview](https://docs.onboarded.com/openapi/placements/postplacementpreview.md)

### Get a placement by id

 - [GET /api/v1/placements/{id}](https://docs.onboarded.com/openapi/placements/getplacement.md)

### Update a placement

 - [PATCH /api/v1/placements/{id}](https://docs.onboarded.com/openapi/placements/updateplacement.md)

### Delete a placement by id

 - [DELETE /api/v1/placements/{id}](https://docs.onboarded.com/openapi/placements/deleteplacement.md)

### List all placements

 - [GET /api/v1/placements](https://docs.onboarded.com/openapi/placements/getplacements.md)

### Create an placement

 - [POST /api/v1/placements](https://docs.onboarded.com/openapi/placements/createplacement.md)

## Tasks

Tasks APIs

### List all tasks

 - [GET /api/v1/tasks](https://docs.onboarded.com/openapi/tasks/gettasks.md)

### Create a task

 - [POST /api/v1/tasks](https://docs.onboarded.com/openapi/tasks/createtask.md)

### Get a task

 - [GET /api/v1/tasks/{id}](https://docs.onboarded.com/openapi/tasks/gettask.md)

### Update a task

 - [PATCH /api/v1/tasks/{id}](https://docs.onboarded.com/openapi/tasks/updatetask.md)

### Delete a task

 - [DELETE /api/v1/tasks/{id}](https://docs.onboarded.com/openapi/tasks/deletetask.md)

### Get a task's fields

 - [GET /api/v1/tasks/{id}/fields](https://docs.onboarded.com/openapi/tasks/gettaskfields.md)

### Update a task's fields

 - [PATCH /api/v1/tasks/{id}/fields](https://docs.onboarded.com/openapi/tasks/updatetaskfields.md)

### Get a task pdf

 - [GET /api/v1/tasks/{id}/pdf](https://docs.onboarded.com/openapi/tasks/gettaskpdf.md)

### Get a task onboarding url

 - [GET /api/v1/tasks/{id}/onboarding](https://docs.onboarded.com/openapi/tasks/getaskonboardingurl.md)

## Task Change Requests

Task Change Requests APIs

### Request changes to a completed task

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

## Forms

Forms APIs

### List all forms

 - [GET /api/v1/forms](https://docs.onboarded.com/openapi/forms/getforms.md)

### Get a form by id

 - [GET /api/v1/forms/{id}](https://docs.onboarded.com/openapi/forms/getform.md)

## Files

Files APIs

### Get a file by id

 - [GET /api/v1/files/{id}](https://docs.onboarded.com/openapi/files/getfile.md)

## Themes

Themes APIs

### List all themes

 - [GET /api/v1/themes](https://docs.onboarded.com/openapi/themes/listthemes.md)

### Create a theme

 - [POST /api/v1/themes](https://docs.onboarded.com/openapi/themes/createtheme.md)

### Get a theme by id

 - [GET /api/v1/themes/{id}](https://docs.onboarded.com/openapi/themes/gettheme.md)

### Update a theme

 - [PATCH /api/v1/themes/{id}](https://docs.onboarded.com/openapi/themes/updatetheme.md)

### Delete a theme

 - [DELETE /api/v1/themes/{id}](https://docs.onboarded.com/openapi/themes/deletetheme.md)

## Custom Properties

Custom Properties APIs

### List all custom properties

 - [GET /api/v1/custom_properties](https://docs.onboarded.com/openapi/custom-properties/listcustomproperties.md)

### Create a custom property

 - [POST /api/v1/custom_properties](https://docs.onboarded.com/openapi/custom-properties/createcustomproperty.md)

### Get a custom property by id

 - [GET /api/v1/custom_properties/{id}](https://docs.onboarded.com/openapi/custom-properties/getcustomproperty.md)

### Delete a custom property

 - [DELETE /api/v1/custom_properties/{id}](https://docs.onboarded.com/openapi/custom-properties/deletecustomproperty.md)