Employees

Get employees for context

get/employees/contexts/{contextId}

Request

Base URL
https://api.peakon.com/api/v1
URL
https://api.peakon.com/api/v1/employees/contexts/{contextId}
Auth
HTTP bearer

Path parameters

contextIdstring required

A company or segment context id. Param is a string formatted as company_[companyId] or segment_[segmentId].

Query parameters

filter[account.email]string

filter[accountId]integer

filter[admin]boolean

filter[employeeId]integer

filter[manager]boolean

filter[segmentIds]integer[]

Response

A JSONAPI resource of type 'employees'

Changes

No recorded changes to this operation across all 1 revision of this API.