Skip to main content
Get Custom Property Definition
curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/{entity_type}/custom_properties/{property_name} \
  --header 'Authorization: Bearer <token>'
{
  "property_name": "sector",
  "property_type": "text"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
entity_type
string
required

Custom Properties are supported on the following entity types: taxonomy/domains, taxonomy/subdomains, taxonomy/skill_clusters, taxonomy/skills, employees, organisational_units, job_architecture/job_families, job_architecture/jobs, vacancies, courses, skill_clusters, and companies.

​
property_name
object
required

CustomPropertyDefinition property name.

Response

OK

Default structure for CustomPropertyDefinition.

​
property_name
string
required

The name of the Custom Property. Can not contain __.

Required string length: 1 - 100
Example:

"sector"

​
property_type
enum<string>
required

Expected type of the Custom Property.

Available options:
text,
number,
boolean,
list[text],
datetime
Required string length: 1 - 10
Example:

"text"