curl --request GET \
  --url https://{tenant_name}.{region}.techwolf.ai/employees \
  --header 'Authorization: Bearer <token>'
{
  "count": 3,
  "results": [
    {
      "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
      "active": true,
      "location": {
        "lat": 50.0216707,
        "lng": 3.6887328
      },
      "assigned_position": "HR assistant",
      "low_data_availability": true,
      "organisational_unit": "e4d3a59c-2f37-4a3f-9318-9d75e0e7a8f1",
      "last_updated": "2021-01-21T17:32:28Z"
    },
    {
      "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
      "active": true,
      "location": {
        "lat": 51.0216707,
        "lng": 2.6887328
      },
      "assigned_position": "Staffing coordinator",
      "low_data_availability": false,
      "organisational_unit": "7a9f3d72-36b4-4b39-87a2-3df1540ebf9e",
      "last_updated": "2021-01-22T15:02:00Z"
    },
    {
      "external_id": "6129e3f1-663f-44ea-aa3f-2ce1077b834c",
      "active": true,
      "location": {
        "lat": 51.0516707,
        "lng": 4.6887328
      },
      "assigned_position": "HR analyst",
      "low_data_availability": false,
      "organisational_unit": "e4d3a59c-2f37-4a3f-9318-9d75e0e7a8f1",
      "last_updated": "2021-01-21T17:46:29Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:100

The maximal number of entities returned, ordered by the last_updated field and external_id.

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

50

​
offset
integer
default:0

The applied offset for returned entities, results starting from offset up to offset + limit.

Required range: x >= 0
​
is_active
boolean
default:None

This parameter can be used to only include entities with the active attribute set to true or false. If the parameter is not set, all entities will be included.

Example:

true

​
organisational_unit
string

This parameter can be used to only include Employees linked to the specified organisational_unit. If organisational_unit="null", only Employees without a linked Organisatioanl Unit are included. If the parameter is not set, all entities will be included.

Example:

"c3903505-eb84-42dc-a79f-5d8b1fe897b7"

​
skill_id
string

The unique ID of a Skill, consisting of alphanumeric characters and hyphens. Setting this query parameter will only include Employees that have this Skill in their Skill Profile.

Required string length: 1 - 100
Example:

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

​
include
enum<string>[]

Additional entity attributes that will be included in the response body. This query parameter can be added multiple times to include more attributes.

Available options:
custom_properties
Example:
["custom_properties"]

Response

200
application/json
OK
​
count
integer
required

Total number of Employee objects stored inside the system.

Required range: x >= 0
Example:

3

​
results
object[]
required

Subset of Employees starting from offset up to offset + limit.

Default structure for Employee data.

Example:
[
  {
    "external_id": "5cbdbdbe-5f44-4423-8157-520f8a2f429a",
    "active": true,
    "location": { "lat": 50.0216707, "lng": 3.6887328 },
    "assigned_position": "HR assistant",
    "low_data_availability": true,
    "organisational_unit": "e4d3a59c-2f37-4a3f-9318-9d75e0e7a8f1",
    "last_updated": "2021-01-21T17:32:28Z"
  },
  {
    "external_id": "62d2c013-ab77-410e-b5fb-2f96eed9c1db",
    "active": true,
    "location": { "lat": 51.0216707, "lng": 2.6887328 },
    "assigned_position": "Staffing coordinator",
    "low_data_availability": false,
    "organisational_unit": "7a9f3d72-36b4-4b39-87a2-3df1540ebf9e",
    "last_updated": "2021-01-22T15:02:00Z"
  },
  {
    "external_id": "6129e3f1-663f-44ea-aa3f-2ce1077b834c",
    "active": true,
    "location": { "lat": 51.0516707, "lng": 4.6887328 },
    "assigned_position": "HR analyst",
    "low_data_availability": false,
    "organisational_unit": "e4d3a59c-2f37-4a3f-9318-9d75e0e7a8f1",
    "last_updated": "2021-01-21T17:46:29Z"
  }
]

Was this page helpful?

OverviewCreate Employee