curl --request POST \
  --url https://{tenant_name}.{region}.techwolf.ai/export/employees/skill_profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "limit": 10,
  "starting_after": "4cbdbabe-5644-4423-8157-520f8a2f429a",
  "filters": [
    {
      "filter": "is_active",
      "is_active": true
    }
  ],
  "include": [
    "skill_validation_state",
    "sources",
    "rejected_skills",
    "low_data_availability_flag"
  ],
  "output_skills_sorting": "alphabetical"
}'
{
  "has_next": true,
  "records": [
    {
      "external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
      "num_skill_events": 2,
      "low_data_availability": false,
      "seniority": 4.290482248178559,
      "skills": [
        {
          "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
          "skill": "Python",
          "validation_state": "suggested",
          "sources": [
            "education_history"
          ],
          "source_events": [
            {
              "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
              "event_type": "education_history",
              "source": "workday"
            }
          ]
        },
        {
          "skill_id": "267d511f-26d4-4c84-b2ae-eae89627deba",
          "skill": "Unit Testing",
          "validation_state": "suggested",
          "sources": [
            "working_history"
          ],
          "source_events": [
            {
              "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
              "event_type": "working_history",
              "source": "workday"
            }
          ]
        }
      ]
    },
    {
      "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
      "num_skill_events": 5,
      "low_data_availability": false,
      "seniority": 3.389503858602185,
      "skills": [
        {
          "skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
          "skill": "Balance Sheet",
          "validation_state": "validated",
          "sources": [
            "education_history"
          ],
          "source_events": [
            {
              "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
              "event_type": "education_history",
              "source": "workday"
            }
          ]
        },
        {
          "skill_id": "bdb5ee3f-8ba0-4c40-92b2-0277431ae069",
          "skill": "IFRS",
          "validation_state": "rejected",
          "sources": [
            "working_history"
          ],
          "source_events": [
            {
              "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
              "event_type": "working_history",
              "source": "workday"
            }
          ]
        }
      ]
    }
  ],
  "next_starting_after": "5cbdbdbe-5f44-4423-8157-520f8a2f429a"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
limit
integer
required

The number of Employees shown on a single page.

Required range: 1 <= x <= 100
Example:

10

​
starting_after
string

The external_id of the Employee to continue looking from.

Maximum length: 100
Example:

"4cbdbabe-5644-4423-8157-520f8a2f429a"

​
filters
object[]

A set of filters to apply on the exported Employees.

​
include
enum<string>[]

Expand the results with extra data.

Include:

  • sources - Show the event type sources that led to this Skill Cluster.
  • seniority - Show the seniority of the Employee.
Available options:
skill_validation_state,
sources,
rejected_skills,
low_data_availability_flag
Example:
[
  "skill_validation_state",
  "sources",
  "rejected_skills",
  "low_data_availability_flag"
]
​
output_skills_sorting
enum<string>
default:alphabetical

Sort the Skills in the results alphabetically or by decreasing confidence.

Available options:
alphabetical,
confidence
Example:

"alphabetical"

Response

200
application/json
OK
​
has_next
boolean
required

True when there is more data after this page.

Example:

true

​
records
object[]
required

A list containing the requested data for each entity, limited by the limit parameter.

Example:
[
  {
    "external_id": "61a6e076-d780-11ec-9d64-0242ac120002",
    "num_skill_events": 2,
    "low_data_availability": false,
    "seniority": 4.290482248178559,
    "skills": [
      {
        "skill_id": "4b85469d-6729-4d70-9876-a0faa2a2f63b",
        "skill": "Python",
        "validation_state": "suggested",
        "sources": ["education_history"],
        "source_events": [
          {
            "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
            "event_type": "education_history",
            "source": "workday"
          }
        ]
      },
      {
        "skill_id": "267d511f-26d4-4c84-b2ae-eae89627deba",
        "skill": "Unit Testing",
        "validation_state": "suggested",
        "sources": ["working_history"],
        "source_events": [
          {
            "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
            "event_type": "working_history",
            "source": "workday"
          }
        ]
      }
    ]
  },
  {
    "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "num_skill_events": 5,
    "low_data_availability": false,
    "seniority": 3.389503858602185,
    "skills": [
      {
        "skill_id": "8313fe8a-f39e-4a35-8c82-93b46c3de9bb",
        "skill": "Balance Sheet",
        "validation_state": "validated",
        "sources": ["education_history"],
        "source_events": [
          {
            "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
            "event_type": "education_history",
            "source": "workday"
          }
        ]
      },
      {
        "skill_id": "bdb5ee3f-8ba0-4c40-92b2-0277431ae069",
        "skill": "IFRS",
        "validation_state": "rejected",
        "sources": ["working_history"],
        "source_events": [
          {
            "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
            "event_type": "working_history",
            "source": "workday"
          }
        ]
      }
    ]
  }
]
​
next_starting_after
string

The next starting_after value for pagination.

Maximum length: 100
Example:

"5cbdbdbe-5f44-4423-8157-520f8a2f429a"

Was this page helpful?

Export Employee Skill Clusters data.Overview