Skip to content
/Custom Properties

List all custom properties

Request

Security
form_session or user_session or component_session or component_token or api_token
Query
pagestring(page)

1-based page number. There is no upper bound; values below 1 are clamped to 1.

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' \
  -H 'Authorization: Bearer <YOUR_Onboarded form session token_HERE>'

Responses

Success

Bodyapplication/json
dataArray of objects(CustomProperty)required
totalnumberrequired
current_pagenumberrequired
per_pagenumberrequired
total_pagesnumber
Response
{
  "data": [
    { … }
  ],
  "total": 0,
  "current_page": 0,
  "per_page": 0,
  "total_pages": 0
}