PEpeakon
Segments

Get segments

get/segments

Request

  • Base URL
    https://api.peakon.com/api/v1
  • URL
    https://api.peakon.com/api/v1/segments
  • Auth
    HTTP bearer

Query parameters

filter[attributeId]integer

The id of the attribute that is the source of a segment

filter[direct]boolean

Segment including only direct reports or all reports

filter[managerId]integer

The employeeId of a manager of a segment

filter[type]'employee' | 'option' | 'date' | 'number'

The type of attribute that is the source of a segment

Response

A JSONAPI resource containing an array of 'segments' objects

Changes

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