Skip to main content
GET
List poll evaluations of the company

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

evaluationId
string<uuid>

Find Evaluation by evaluationId

title
string

Find Evaluation by name

formType
enum<string>

Supported form types:

Available options:
degree_360,
engagement,
enps,
killer_question,
leadership,
nine_box,
nom_35_mx,
nom_37_mx,
performance,
ranking,
request_type,
satisfaction,
standard,
template,
work_environment
officeIds[in]
string

Filter evaluations by the office of the employee who answers. Comma-separated list of UUIDs. Omit the parameter to apply no filter. Several values behave as OR between them, and this dimension is combined with the other organizational dimensions using AND. An unknown or malformed value returns 200 with an empty list, never an error.

departmentIds[in]
string

Filter evaluations by the department of the employee who answers. Comma-separated list of UUIDs. Omit the parameter to apply no filter. Several values behave as OR between them, and this dimension is combined with the other organizational dimensions using AND. An unknown or malformed value returns 200 with an empty list, never an error.

entityGroupIds[in]
string

Filter evaluations by the organizational group of the employee who answers. Comma-separated list of UUIDs. Omit the parameter to apply no filter. Several values behave as OR between them, and this dimension is combined with the other organizational dimensions using AND. An unknown or malformed value returns 200 with an empty list, never an error. Groups are matched literally: selecting a parent group does not include the members of its children.

view
enum<string>

View for the poll

Available options:
recruitment,
admin,
employee
limit
integer
default:20

Limit evaluations

Required range: 1 <= x <= 100
page
integer
default:1

Request a specific page

Required range: x >= 1
orderBy
string

Sort evaluations by one or more fields in ascending (asc) or descending (desc) order. Format: 'field1 asc, field2 desc'. Valid fields are: updateAt, title, publishType, hasRecurrence, hasAnswers, employees, evaluated, evaluators, answers, lastSendDate

Response

200 - application/json

Array of objects

data
object[]
required
meta
object
required