Get a custom property by ID

Request

Security

form_session or user_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}' \
  -H 'Authorization: Bearer <YOUR_Onboarded form session token_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""enum"

pathstringrequired

auto_distribute_to_connectedbooleanrequired

is_sensitive_infobooleanrequired

is_permission_scopebooleanrequired

enum_optionsArray of stringsrequired

Allowed values for enum type properties. Empty for other types.

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

{
  "id": "cprop_abc123def456",
  "name": "string",
  "label": "string",
  "entity_type": "employee",
  "scalar_type": "string",
  "path": "string",
  "auto_distribute_to_connected": true,
  "is_sensitive_info": true,
  "is_permission_scope": true,
  "enum_options": [
    "string"
  ],
  "created_at": "string",
  "updated_at": "string"
}