Skip to main content
POST
List

Body

application/json
kind_id
string<snowflake>
required

Only the "employee" kind is available at the moment.

Example:

"872815618512410358"

at_date
string<local-date>

If you do not specify a date, today's date will be used.

Example:

"2019-11-11"

attributes
string[]

Several filters can be used to narrow down the search (except for activity rate). Correct filter types should be used based on the data type of the attribute. The 'api/directory/kinds.show' endpoint gives you information about attribute types and whether you can filter or order them.

with_teams
boolean
default:false

Will give additional information about the team they are assigned to at the date provided.

with_relations
boolean | null
default:false
with_total_count
boolean
default:false
counting_mode
enum<string>
Available options:
strict,
approximate
Example:

"strict"

filters
object[]
orders
object[]
pagination
object

Response

200 - application/json
data
object[]
required
next_token
string | null
required
total_count
integer

Total number of resources matching filters in the request; only present if parameter "with_total_count" is set to "true".

total_count_approximate
boolean

TRUE if the returned number of resources is exact, FALSE if it is only an approximation; only present if parameter "with_total_count" is set to "true".