API Reference
/
Jobs

Onboarded API (0.0.1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.onboarded.com/_mock/openapi/
https://app.onboarded.com/

Components

Components APIs

Operations

Employees

Employees APIs

Operations

Employers

Employers APIs

Operations

Clients

Clients APIs

Operations

Jobs

Jobs APIs

Operations

List all jobs

Request

Query
pagenumber>= 1
Default 1
per_pagenumber[ 1 .. 300 ]
Default 20
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/jobs?page=1&per_page=20' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
dataArray of objectsrequired
data[].​idstringrequired
data[].​namestringrequired
data[].​addressobject or null
data[].​created_atstring(date-time)required
data[].​updated_atstring(date-time)required
totalnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0
}

Create a job

Request

Bodyapplication/json

Body

namestringrequired
addressobject or null
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/jobs \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "address": {
      "street": "string",
      "secondary": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "str"
    }
  }'

Responses

201

Bodyapplication/json
idstringrequired
namestringrequired
addressobject or null
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "name": "string",
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get a job by id

Request

Path
idstringrequired
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/jobs/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
idstringrequired
namestringrequired
addressobject or null
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "name": "string",
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Update a job

Request

Path
idstringrequired
Bodyapplication/json

Body

namestringrequired
addressobject or null
curl -i -X PATCH \
  'https://docs.onboarded.com/_mock/openapi/api/v1/jobs/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "address": {
      "street": "string",
      "secondary": "string",
      "city": "string",
      "state": "string",
      "zip": "string",
      "country": "str"
    }
  }'

Responses

200

Bodyapplication/json
idstringrequired
namestringrequired
addressobject or null
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "name": "string",
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Placements

Placements APIs

Operations

Tasks

Tasks APIs

Operations

Task Change Requests

Task Change Requests APIs

Operations

Forms

Forms APIs

Operations

Files

Files APIs

Operations

Themes

Themes APIs

Operations