Skip to content
API Reference
/
Custom Properties

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

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

List all custom properties

Request

Security
bearerAuth
Query
namestring
entity_typestring
Enum"employee""employer""placement""form""client""job"
pathstring
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/custom_properties?name=string&entity_type=employee&path=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

200

Bodyapplication/json
dataArray of objectsrequired
data[].​idstringrequired
data[].​namestringrequired
data[].​labelstringrequired
data[].​entity_typestringrequired
Enum"employee""employer""placement""form""client""job"
data[].​scalar_typestringrequired
Enum"string""boolean""date""datetime""integer""decimal"
data[].​pathstringrequired
data[].​created_atstring(date-time)required
data[].​updated_atstring(date-time)required
totalnumberrequired
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0
}

Create a custom property

Request

Security
bearerAuth
Bodyapplication/json

Body

entity_typestringrequired
Enum"employee""employer""placement""form""client""job"
namestringrequired
labelstringrequired
scalar_typestringrequired
Enum"string""boolean""date""datetime""integer""decimal"
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/custom_properties \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "entity_type": "employee",
    "name": "string",
    "label": "string",
    "scalar_type": "string"
  }'

Responses

201

Bodyapplication/json
idstringrequired
namestringrequired
labelstringrequired
entity_typestringrequired
Enum"employee""employer""placement""form""client""job"
scalar_typestringrequired
Enum"string""boolean""date""datetime""integer""decimal"
pathstringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "name": "string",
  "label": "string",
  "entity_type": "employee",
  "scalar_type": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Get a custom property by id

Request

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

Responses

200

Bodyapplication/json
idstringrequired
namestringrequired
labelstringrequired
entity_typestringrequired
Enum"employee""employer""placement""form""client""job"
scalar_typestringrequired
Enum"string""boolean""date""datetime""integer""decimal"
pathstringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "name": "string",
  "label": "string",
  "entity_type": "employee",
  "scalar_type": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Delete a custom property

Request

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

Responses

200

Bodyapplication/json
idstringrequired
namestringrequired
labelstringrequired
entity_typestringrequired
Enum"employee""employer""placement""form""client""job"
scalar_typestringrequired
Enum"string""boolean""date""datetime""integer""decimal"
pathstringrequired
created_atstring(date-time)required
updated_atstring(date-time)required
Response
application/json
{
  "id": "string",
  "name": "string",
  "label": "string",
  "entity_type": "employee",
  "scalar_type": "string",
  "path": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}