15Five
App · 25 actions
Read employee, engagement, objective, check-in and performance review data.
Actions
| Action | What it does |
|---|---|
| Get check in | Get check-in details. |
| Get department | Get department details. |
| Get group | Get group details. |
| Get high five | Get high five details. |
| Get objective | Get objective details. |
| Get people attribute | Get people attribute details. |
| Get question | Get question details. |
| Get review cycle | Get review cycle details. |
| Get user | Get user details. |
| List answers | List answers. |
| List attribute values | List people attribute values. |
| List check ins | List check-ins. |
| List departments | List departments. |
| List group types | List group types. |
| List groups | List groups. |
| List high fives | List high fives. |
| List objectives | List objectives. |
| List people attributes | List people attributes. |
| List priorities | List priorities. |
| List pulse answers | Retrieve pulse data. |
| List questions | List questions. |
| List review cycles | List review cycles. |
| List security audit events | List security audit events. |
| List users | List users. |
| List vacations | List vacations. |
Get check in
Get check-in details.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"accomplishments": [],
"comments": [],
"due_date": "example",
"goals": [],
"id": 1,
"pulse": [],
"questions": [],
"reporting_period": "example",
"reporting_period_end": "example",
"reporting_period_start": "example",
"reviewed_by": "example",
"reviewed_ts": "example",
"submit_ts": "example",
"user": "example",
"was_submitted_late": false
}
}Get department
Get department details.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"id": 1,
"name": "example"
}
}Get group
Get group details.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"create_ts": "example",
"group_admins": [],
"group_type": "example",
"group_type_name": "example",
"id": 1,
"is_peer_drilldown": false,
"is_peer_view": false,
"members": [],
"mention_name": "example",
"name": "example",
"skip_company_wide_questions": false
}
}Get high five
Get high five details.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"comments": [],
"create_ts": "example",
"creator": "example",
"creator_details": {
"email": "example",
"full_name": "example",
"id": 1
},
"creator_id": 1,
"id": 1,
"receivers": [],
"report": "example",
"text": "example"
}
}Get objective
Get objective details.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"children": [],
"color": "green",
"create_ts": "example",
"departments": [],
"description": "example",
"end_ts": "example",
"id": 1,
"is_active": false,
"is_archived": false,
"is_closed": false,
"is_complete": false,
"is_future": false,
"is_past_due": false,
"key_results": [],
"parent": "example",
"percentage": 1,
"result_count": 1,
"scope": "company-wide",
"start_ts": "example",
"update_ts": "example",
"user": "example",
"user_details": {
"email": "example",
"full_name": "example",
"id": 1
},
"visibility": "public",
"weight": 1.0
}
}Get people attribute
Get people attribute details.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"create_ts": "example",
"datatype": "text",
"id": 1,
"is_default": false,
"is_only_admin_editable": false,
"name": "example",
"slug": "example",
"update_ts": "example"
}
}Get question
Get question details.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"group": "example",
"id": 1,
"is_active": false,
"is_optional": false,
"metrics_params": [],
"question_frequency": "weekly",
"question_text": "example",
"question_type": "multi",
"user": "example"
}
}Get review cycle
Get review cycle details.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"actual_start_ts": "example",
"create_ts": "example",
"creator": "example",
"creator_details": {
"email": "example",
"full_name": "example",
"id": 1
},
"cycle_end_ts": "example",
"cycle_start_ts": "example",
"days_remaining": 1,
"does_manager_review": false,
"does_peer_review": false,
"does_self_review": false,
"does_upward_review": false,
"id": 1,
"lock_ts": "example",
"manager_reviews_end_ts": "example",
"name": "example",
"participants": [],
"peer_manager_approval_due_ts": "example",
"peer_review_template": {
"id": 1,
"name": "example"
},
"peer_reviews_end_ts": "example",
"peer_reviews_transparency": "fully_transparent",
"peer_selection_due_ts": "example",
"self_reviews_end_ts": "example",
"share_and_finalize_end_ts": "example",
"statistics": {
"number_of_reviews_completed": 1,
"number_of_reviews_uncompleted": 1
},
"status": "upcoming",
"template": {
"id": 1,
"name": "example"
},
"update_ts": "example",
"upward_review_template": {
"id": 1,
"name": "example"
},
"upward_reviews_end_ts": "example",
"upward_reviews_transparency": "fully_transparent",
"viewing_permissions": "hierarchy"
}
}Get user
Get user details.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"biweekly_due_day": 1,
"biweekly_due_day_which_week": "example",
"company_groups_ids": [],
"create_ts": "example",
"current_checkin_streak": 1,
"due_day": 1,
"email": "example",
"employee_id": "example",
"first_login_ts": "example",
"first_name": "example",
"global_id": 1,
"hire_date_ts": "example",
"id": 1,
"is_active": false,
"is_company_admin": false,
"is_reporter": false,
"is_reviewer": false,
"last_login_ts": "example",
"last_name": "example",
"location": "example",
"mention_name": "example",
"monthly_due_day": 1,
"monthly_due_day_which_in_month": "example",
"phone": "example",
"reporting_period": "example",
"reviewer_id": 1,
"skip_company_wide_questions": false,
"start_date_ts": "example",
"title": "example",
"update_ts": "example"
}
}List answers
List answers.
Inputs
- Question id
question_idtext - Include only answers for a question/questions with the specified ID. In order to query for answers for multiple questions, specify questions' ids as a list of parameters, eg.: ?question_id=1&question_id=2
- User
app_user_idtext - Include only answers given by a user or users with the specified ID. In order to query for answers given by multiple users, specify users' ids as a list of parameters, eg.: ?user_id=1&user_id=2
- Created on start
created_on_starttext - Only include answers having creation date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Created on end
created_on_endtext - Only include answers having creation date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Order by
order_bytext - Available sorting fields (id, user, question, create_ts), defaults to "create_ts". Add a "-" before the field name to reverse the order e.g. "-create_ts".
- Page
pagenumber - Results page
- Created after
created_aftertext - Only include users with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include users with creation date less than or equal to the value.
- Updated after
updated_aftertext - Only include users with updated date greater than or equal to the value.
- Updated before
updated_beforetext - Only include users with updated date less than or equal to the value.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List attribute values
List people attribute values.
Inputs
- Page
pagenumber - Results page
- Order by
order_bytext - Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".One of:
id,create_ts(Create ts),update_ts(Update ts). - Created after
created_aftertext - Only include attribute values with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include attribute values with creation date less than or equal to the value.
- Updated after
updated_aftertext - Only include attribute values with updated date greater than or equal to the value.
- Updated before
updated_beforetext - Only include attribute values with updated date less than or equal to the value.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List check ins
List check-ins.
Inputs
- User
app_user_idtext - Filter reports by user id.
- Due date start
due_date_starttext - Only include reports with due date greater than or equal to the date specified in the YYYY-MM-DD format.
- Due date end
due_date_endtext - Only include reports with due date less than or equal to the date specified in the YYYY-MM-DD format.
- Order by
order_bytext - Available sorting fields (id, user, due_date), defaults to "-id". Add a "-" before the field name to reverse the order e.g. "-due_date"
- Page
pagenumber - Results page
- Created after
created_aftertext - Only include users with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include users with creation date less than or equal to the value.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List departments
List departments.
Inputs
- Name
nametext - Include only departments with the specified name.
- Page
pagenumber - Results page
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List group types
List group types.
Inputs
- Name plural
name_pluraltext - Include only group_types with the specified plural name.
- Page
pagenumber - Results page
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List groups
List groups.
Inputs
- Name in
name_intext - Include only groups with the specified names.
- Page
pagenumber - Results page
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List high fives
List high fives.
Inputs
- Report id
report_idtext - Include only high fives within the report with the specified ID. In order to query for high fives given by multiple reports, specify report ids as a list of parameters, eg.: ?report_id=1&report_id=2
- Receiver id
receiver_idtext - Include only high fives received by the provided user ID(s). In order to query for high fives received by multiple IDs, specify receiver ids as a list of parameters, eg.: ?receiver_id=1&receiver_id=2
- Created on start
created_on_starttext - Only include high fives having creation date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Created on end
created_on_endtext - Only include high fives having creation date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Order by
order_bytext - Available sorting fields (id, report, create_ts), defaults to "create_ts". Add a "-" before the field name to reverse the order e.g. "-create_ts"
- Page
pagenumber - Results page
- Created after
created_aftertext - Only include users with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include users with creation date less than or equal to the value.
- Updated after
updated_aftertext - Only include users with updated date greater than or equal to the value.
- Updated before
updated_beforetext - Only include users with updated date less than or equal to the value.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List objectives
List objectives.
Inputs
- User
app_user_idtext - Include only person-specific objectives for a user with the specified ID.
- Parent id
parent_idtext - Include only objectives of a parent with the specified ID.
- Department id
department_idtext - Include only objectives for a department/departments with the specified ID. In order to query for multiple departments, specify departments' ids as a list of parameters, eg.: ?department_id=1&department_id=2
- Start after
start_aftertext - Only include objectives with start date greater than or equal to the date specified in the YYYY-MM-DD format.
- End before
end_beforetext - Only include objectives with end date less than or equal to the date specified in the YYYY-MM-DD format.
- Scope
scopetext - Include only objectives with the specified scope type: string enum: - company-wide - group-type - individual - self-development
- State
statetext - Include only objectives with the specified state; deprecated values: 'past', 'current', 'deactivated'One of:
active,future,archived,closed. - Color
colortext - Include only objectives with the specified current statusOne of:
green,yellow,red,undefined. - Page
pagenumber - Results page
- Created after
created_aftertext - Only include objectives with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include objectives with creation date less than or equal to the value.
- Updated after
updated_aftertext - Only include objectives with updated date greater than or equal to the value.
- Updated before
updated_beforetext - Only include objectives with updated date less than or equal to the value.
- Order by
order_bytext - Order results by the specified field. The default ordering is: "end_ts,sort_order,id". Add "-" prefix to the field name to reverse the order.One of:
id,end_ts(End ts),create_ts(Create ts),update_ts(Update ts),sort_order(Sort order),-id,-end_ts(-end ts),-create_ts(-create ts),-update_ts(-update ts),-sort_order(-sort order).
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List people attributes
List people attributes.
Inputs
- Page
pagenumber - Results page
- Order by
order_bytext - Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".One of:
id,name,slug,datatype,create_ts(Create ts),update_ts(Update ts). - Created after
created_aftertext - Only include attributes with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include attributes with creation date less than or equal to the value.
- Updated after
updated_aftertext - Only include attributes with updated date greater than or equal to the value.
- Updated before
updated_beforetext - Only include attributes with updated date less than or equal to the value.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List priorities
List priorities.
Inputs
- Page
pagenumber - Results page
- Order by
order_bytext - Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".One of:
id,create_ts(Create ts),update_ts(Update ts),email,employee_id(Employee id). - Created after
created_aftertext - Only include users with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include users with creation date less than or equal to the value.
- Updated after
updated_aftertext - Only include users with updated date greater than or equal to the value.
- Updated before
updated_beforetext - Only include users with updated date less than or equal to the value.
- User
app_user_idtext - Filter priorities by user id.
- Manager id
manager_idtext - Filter priorities by manager id.
- Group id
group_idtext - Filter priorities by group id.
- Include past checkins
include_past_checkinstrue/false - Include priorities from the past check-ins or just from current one.
Outputs
datalist- 15Five response data.
Example output
{
"data": []
}List pulse answers
Retrieve pulse data.
Inputs
- Page
pagenumber - Results page
- Order by
order_bytext - Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".One of:
id,create_ts(Create ts),update_ts(Update ts). - Created after
created_aftertext - Only include users with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include users with creation date less than or equal to the value.
- Updated after
updated_aftertext - Only include users with updated date greater than or equal to the value.
- Updated before
updated_beforetext - Only include users with updated date less than or equal to the value.
- Report id
report_idtext - Include only pulse values for a report/reports with the specified ID. In order to query for pulse values for multiple reports, specify reports' ids as a list of parameters, eg.: ?report_id=1&report_id=2
- User
app_user_idtext - Include only pulse values given by a user or users with the specified ID. In order to query for pulse values given by multiple users, specify users' ids as a list of parameters, eg.: ?user_id=1&user_id=2
- Created on start
created_on_starttext - Only include pulse values having creation date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Created on end
created_on_endtext - Only include pulse values having creation date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List questions
List questions.
Inputs
- User
app_user_idtext - Include only person-specific questions for a user with the specified ID.
- Group id
group_idtext - Include only group-specific questions for a group with the specified ID.
- Page
pagenumber - Results page
- Order by
order_bytext - Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".
- Created after
created_aftertext - Only include users with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include users with creation date less than or equal to the value.
- Updated after
updated_aftertext - Only include users with updated date greater than or equal to the value.
- Updated before
updated_beforetext - Only include users with updated date less than or equal to the value.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List review cycles
List review cycles.
Inputs
- Created on start
created_on_starttext - Only include review cycles having creation date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Created on end
created_on_endtext - Only include review cycles having creation date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Updated on start
updated_on_starttext - Only include review cycles having update date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Updated on end
updated_on_endtext - Only include review cycles having update date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Hierarchy updated after
hierarchy_updated_aftertext - Only include review cycles having hierarchy update date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format. Note: this filter is currently in testing phase. Please contact support if you plan to use it.
- Hierarchy updated before
hierarchy_updated_beforetext - Only include review cycles having hierarchy update date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format. Note: this filter is currently in testing phase. Please contact support if you plan to use it.
- Started on start
started_on_starttext - Only include review cycles having actual start date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Started on end
started_on_endtext - Only include review cycles having actual start date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Ended on start
ended_on_starttext - Only include review cycles having end date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Ended on end
ended_on_endtext - Only include review cycles having end date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.
- Page
pagenumber - Results page
- Order by
order_bytext - Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".One of:
id,create_ts(Create ts),update_ts(Update ts),hierarchy_update_ts(Hierarchy update ts),name.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List security audit events
List security audit events.
Inputs
- Actor id
actor_idtext - Include only security audits for the specified user.
- Page
pagenumber - Results page
- Order by
order_bytext - Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".One of:
id,create_ts(Create ts),actor,type. - Created after
created_aftertext - Only include security audits with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include security audits with creation date less than or equal to the value.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List users
List users.
Inputs
- Page
pagenumber - Results page
- Order by
order_bytext - Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".One of:
id,create_ts(Create ts),update_ts(Update ts),email,employee_id(Employee id). - Created after
created_aftertext - Only include users with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include users with creation date less than or equal to the value.
- Updated after
updated_aftertext - Only include users with updated date greater than or equal to the value.
- Updated before
updated_beforetext - Only include users with updated date less than or equal to the value.
- Email
emailtext - Filter users by email.
- Employee id
employee_idtext - Filter users by employee ID.
- First name
first_nametext - Filter users by first name.
- Last name
last_nametext - Filter users by last name.
- Location
locationtext - Filter users by location.
- Is active
is_activetrue/false - Filter users by status.
- Is company admin
is_company_admintrue/false - Filter users by company admin status.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}List vacations
List vacations.
Inputs
- User
userlist - Include only vacations for given user ids.
- Page
pagenumber - Results page
- Order by
order_bytext - Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".One of:
id,create_ts(Create ts),user,start_dt(Start dt),end_dt(End dt). - Created after
created_aftertext - Only include vacations with creation date greater than or equal to the value.
- Created before
created_beforetext - Only include vacations with creation date less than or equal to the value.
Outputs
dataobject- 15Five response data.
Example output
{
"data": {
"count": 1,
"next": "example",
"previous": "example",
"results": []
}
}