Skip to content
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

Security
bearerAuth
Query
pagenumber>= 1
Default 1
per_pagenumber[ 1 .. 300 ]
Default 20
custom_attributesstring

Stringified JSON to filter jobs by custom attributes. Example: {"pay_rate": 12.5}

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/jobs?page=1&per_page=20&custom_attributes=string' \
  -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
data[].​custom_attributesobjectrequired

Custom attribute values

totalnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0
}

Create a job

Request

Security
bearerAuth
Bodyapplication/json

Body

namestringrequired
addressobject or null
custom_attributesobject or null

Custom attributes

property name*anyadditional property
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",
      "full_address": "string"
    },
    "custom_attributes": {}
  }'

Responses

201

Bodyapplication/json
idstringrequired
namestringrequired
addressobject or null
created_atstring(date-time)required
updated_atstring(date-time)required
custom_attributesobjectrequired

Custom attribute values

Response
application/json
{
  "id": "string",
  "name": "string",
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str",
    "full_address": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_attributes": {}
}

Get a job by id

Request

Security
bearerAuth
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
custom_attributesobjectrequired

Custom attribute values

Response
application/json
{
  "id": "string",
  "name": "string",
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str",
    "full_address": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_attributes": {}
}

Update a job

Request

Security
bearerAuth
Path
idstringrequired
Bodyapplication/json

Body

namestring
addressobject or null
custom_attributesobject or null

Custom attributes

property name*anyadditional property
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",
      "full_address": "string"
    },
    "custom_attributes": {}
  }'

Responses

200

Bodyapplication/json
idstringrequired
namestringrequired
addressobject or null
created_atstring(date-time)required
updated_atstring(date-time)required
custom_attributesobjectrequired

Custom attribute values

Response
application/json
{
  "id": "string",
  "name": "string",
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str",
    "full_address": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_attributes": {}
}

Delete a job

Request

Security
bearerAuth
Path
idstringrequired
curl -i -X DELETE \
  '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
custom_attributesobjectrequired

Custom attribute values

Response
application/json
{
  "id": "string",
  "name": "string",
  "address": {
    "street": "string",
    "secondary": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "country": "str",
    "full_address": "string"
  },
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "custom_attributes": {}
}

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

Custom Properties

Custom Properties APIs

Operations