List all employees

GET

/v1/employees

• Production

Returns a list of employees previously created.

Parameters

Query Parameters

select

string format: select=field,field

default: All fields

Allowed values: email firstName lastName language score identityDirectory groupIds createdAt

select=email,firstName

Comma-separated list of fields to include in the response. Field ID is always selected

filter

Fields to filter results, separated by & and operator separated by :. Fields can be repeated to filter by multiple values

object

field

string

Allowed values: language score groupIds

operator

string

Allowed values: $eq $ne $gt $lt $gte $lte

value

string

filter[score]=$lte:20&filter[groupIds]=$eq:5G53WgnmMecoeT1ZbTJU&filter[groupIds]=$eq:6eu2TUN2gSX1WvD8sT0G

sort

string format: sort[field]=direction

Allowed values: score

sort[score]=desc

Fields to sort result, separated by &. Direction can be asc or desc

page

number

default: 1

page=2

Page number to retrieve

limit

number

default: 100

limit=10

Number of item per page

Responses

200

object

status

required

string

Allowed values: success

pagination

required

object

data

required

object

employees

required

Array<object>

object

id

required

string

email

string format: email

firstName

string

lastName

string

language

string format: iso-639-1

score

The computed score of the employee based on all completed campaigns. Null if no campaign is completed.

number

nullable <= 100

identityDirectory

The identity directory provider with whom the employee is sync. Null if the employee is not synchronized.

string

nullable

Allowed values: microsoft google

groupIds

Both standard and dynamic groups to which the employee belongs.

Array<string>

createdAt

string format: date-time

400

Bad request

object

error

string

statusCode

required

number

401

Unauthorized

object

message

required

string

statusCode

required

number

408

Request timeout

object

message

required

string

statusCode

required

number

429

Too many requests

object

message

required

string

statusCode

required

number

500

Internal server error

object

message

required

string

statusCode

required

number