v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Insights

Get Employee Diversity Insights

Returns Diversity insights of employees of an organization

get/api/v2/insights/diversity/employees

Query parameters

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

genderDiversityobject nullable

Gender diversity of employees in an organization. Gender inferred by eightfold if not declared

ethnicDiversityobject nullable

ethenic diversity of employees in an organization. Ethnicity inferred by Eightfold if not declared