Skip to content
API Reference
/
/
Get a custom property by...

Onboarded Public API (0.0.1)

Public API for Customers, Partners, and Integrations

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

Clients

API for managing clients

Operations

Components

API for creating embeddable component URLs

Operations

Connected Organizations

API for managing connected organizations and their configuration

Operations

Employees

API for managing employees

Operations

Employers

API for managing employers

Operations

Files

API for accessing uploaded files

Operations

Forms

API for accessing forms

Operations

Tasks

API for managing tasks

Operations

Jobs

API for managing jobs

Operations

Placements

API for managing placements

Operations

Themes

API for managing themes

Operations

Custom Properties

API for managing custom properties

Operations

List all custom properties

Request

Security
user_session or form_session or component_session or component_token or api_token
Query
pagestring(between(1, 1000))

a number between 1 and 1000

per_pagestring(between(1, 100))

a number between 1 and 100

namestring
entity_typestring
Enum"employee""employer""placement""form""client""job"
pathstring
statusstring
Enum"active""deprecated"
curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/custom_properties?page=string&per_page=string&name=string&entity_type=employee&path=string&status=active' \
  -b __session=YOUR_API_KEY_HERE

Responses

Success

Bodyapplication/json
dataArray of objects(CustomProperty)required
data[].​idstring(CustomPropertyId)^cprop_required

Custom Property Identifier

data[].​namestringrequired
data[].​labelstringrequired
data[].​entity_typestringrequired
Enum"employee""employer""placement""form""client""job"
data[].​scalar_typestringrequired
Enum"string""boolean""date""datetime""integer""decimal""address"
data[].​pathstringrequired
data[].​is_sensitive_infobooleanrequired
data[].​is_permission_scopebooleanrequired
data[].​created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

data[].​updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
application/json
{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}

Create a custom property

Request

Security
user_session or form_session or component_session or component_token or api_token
Bodyapplication/jsonrequired
namestringrequired
labelstringrequired
entity_typestringrequired
Enum"employee""employer""placement""form""client""job"
scalar_typestringrequired
Enum"string""boolean""date""datetime""integer""decimal""address"
curl -i -X POST \
  https://docs.onboarded.com/_mock/openapi/api/v1/custom_properties \
  -H 'Content-Type: application/json' \
  -b __session=YOUR_API_KEY_HERE \
  -d '{
    "name": "string",
    "label": "string",
    "entity_type": "employee",
    "scalar_type": "string"
  }'

Responses

CustomProperty

Bodyapplication/json
idstring(CustomPropertyId)^cprop_required

Custom Property Identifier

namestringrequired
labelstringrequired
entity_typestringrequired
Enum"employee""employer""placement""form""client""job"
scalar_typestringrequired
Enum"string""boolean""date""datetime""integer""decimal""address"
pathstringrequired
is_sensitive_infobooleanrequired
is_permission_scopebooleanrequired
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

Response
application/json
{
  "id": "cprop_abc123def456",
  "name": "string",
  "label": "string",
  "entity_type": "employee",
  "scalar_type": "string",
  "path": "string",
  "is_sensitive_info": true,
  "is_permission_scope": true,
  "created_at": "string",
  "updated_at": "string"
}

Get a custom property by ID

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
custom_property_idstring(CustomPropertyId)^cprop_required

Custom Property Identifier

curl -i -X GET \
  'https://docs.onboarded.com/_mock/openapi/api/v1/custom_properties/{custom_property_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

CustomProperty

Bodyapplication/json
idstring(CustomPropertyId)^cprop_required

Custom Property Identifier

namestringrequired
labelstringrequired
entity_typestringrequired
Enum"employee""employer""placement""form""client""job"
scalar_typestringrequired
Enum"string""boolean""date""datetime""integer""decimal""address"
pathstringrequired
is_sensitive_infobooleanrequired
is_permission_scopebooleanrequired
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

Response
application/json
{
  "id": "cprop_abc123def456",
  "name": "string",
  "label": "string",
  "entity_type": "employee",
  "scalar_type": "string",
  "path": "string",
  "is_sensitive_info": true,
  "is_permission_scope": true,
  "created_at": "string",
  "updated_at": "string"
}

Delete a custom property

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
custom_property_idstring(CustomPropertyId)^cprop_required

Custom Property Identifier

curl -i -X DELETE \
  'https://docs.onboarded.com/_mock/openapi/api/v1/custom_properties/{custom_property_id}' \
  -b __session=YOUR_API_KEY_HERE

Responses

CustomProperty

Bodyapplication/json
idstring(CustomPropertyId)^cprop_required

Custom Property Identifier

namestringrequired
labelstringrequired
entity_typestringrequired
Enum"employee""employer""placement""form""client""job"
scalar_typestringrequired
Enum"string""boolean""date""datetime""integer""decimal""address"
pathstringrequired
is_sensitive_infobooleanrequired
is_permission_scopebooleanrequired
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

Response
application/json
{
  "id": "cprop_abc123def456",
  "name": "string",
  "label": "string",
  "entity_type": "employee",
  "scalar_type": "string",
  "path": "string",
  "is_sensitive_info": true,
  "is_permission_scope": true,
  "created_at": "string",
  "updated_at": "string"
}

Deprecate a custom property

Request

Security
user_session or form_session or component_session or component_token or api_token
Path
custom_property_idstring(CustomPropertyId)^cprop_required

Custom Property Identifier

curl -i -X POST \
  'https://docs.onboarded.com/_mock/openapi/api/v1/custom_properties/{custom_property_id}/deprecate' \
  -b __session=YOUR_API_KEY_HERE

Responses

CustomProperty

Bodyapplication/json
idstring(CustomPropertyId)^cprop_required

Custom Property Identifier

namestringrequired
labelstringrequired
entity_typestringrequired
Enum"employee""employer""placement""form""client""job"
scalar_typestringrequired
Enum"string""boolean""date""datetime""integer""decimal""address"
pathstringrequired
is_sensitive_infobooleanrequired
is_permission_scopebooleanrequired
created_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

updated_atstring(DateTimeUtc)required

a string to be decoded into a DateTime.Utc

Response
application/json
{
  "id": "cprop_abc123def456",
  "name": "string",
  "label": "string",
  "entity_type": "employee",
  "scalar_type": "string",
  "path": "string",
  "is_sensitive_info": true,
  "is_permission_scope": true,
  "created_at": "string",
  "updated_at": "string"
}

Subtasks

Subtask management and file upload API

Operations

Task Change Requests

API for requesting changes to completed tasks

Operations

Users

API for managing users

Operations

Webhooks

API for managing webhooks

Operations