Obtain a list of segments. The id of each segment can be used to get full engagement details using other methods in this area.

Log in to see full request history
Path Params
string
required

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

Query Params
string
Defaults to automatic

The type of rounds to include data for

filter[employee.segmentIds]
array of integers

The array of segment ids that the result should be filtered for. The segment ids should be sent comma-separated and ending with "$contains".

filter[employee.segmentIds]
string
string
integer
string
required

A text to search for in segments

Response

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json