Skip to main content
Retrieve all Custom Properties of an entity
curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/{entity_type}/{entity_type_external_id}/custom_properties \
  --header 'Authorization: Bearer <token>'
[
  {
    "property_name": "type",
    "property_value": "online"
  },
  {
    "property_name": "years_of_experience",
    "property_value": 3
  },
  {
    "property_name": "online",
    "property_value": true
  },
  {
    "property_name": "tools",
    "property_value": [
      "JIRA",
      "Git"
    ]
  },
  {
    "property_name": "creation_date",
    "property_value": "2023-04-25T17:14:30.40"
  }
]

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.

​
entity_type_external_id
string<uuid>
required

Unique external ID linked to this entity, consisting of alphanumeric characters, hyphens and underscores. Note that the endpoint taxonomy/skills uses skill_id.

Required string length: 1 - 100
Example:

"a3903505-eb84-42dc-a79f-5e7b1fe897b7"

Response

OK

A list of properties for a given entity. Property values are either strings or numbers.

​
property_name
string
required

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

Required string length: 1 - 100
​
property_value
required

Fill in the value of the property.