curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/employees/{employee_external_id}/interactions/{interaction_external_id} \
  --header 'Authorization: Bearer <token>'
{
  "external_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7",
  "interaction_type": "vacancy_liked",
  "timestamp": "2023-06-08T14:42:31.130855",
  "vacancy_id": "a3903505-eb84-42dc-a79f-5e7b1fe897b7"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
employee_external_id
string
required

Unique ID linked to an Employee, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Example:

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

​
interaction_external_id
string
required

Unique ID linked to an Employee Interaction, consisting of alphanumeric characters, hyphens and underscores.

Required string length: 1 - 100
Example:

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

Response

200
application/json
OK

Default structure of an Employee Interaction.

​
external_id
string
required

The unique Employee Interaction ID in your system, consisting of alphanumeric characters, hyphens and underscores.

Minimum length: 1
Example:

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

​
interaction_type
string
required

Type of the Employee Interaction.

Example:

"vacancy_liked"

​
timestamp

The completion date (in IS08601 format) of the Employee Interaction. This is the point in time at which the Employee interacted with a Vacancy or title. If not given, it will be automatically set to the creation time of the Employee Interaction.

​
vacancy_id
string

The ID of the Vacancy with which the Employee has interacted. Either a vacancy_id or a title should be provided, and not both.

Example:

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

​
title
string

The title with which the Employee has interacted. Either a vacancy_id or a title should be provided, but not both. A title can be any kind of free text, and does not need to be associated with an existing Vacancy.

Example:

"mechanical engineer"

Was this page helpful?

Create a new Interaction for an EmployeeDelete Employee Interaction