15Five

App · 25 actions

Read employee, engagement, objective, check-in and performance review data.

Actions

ActionWhat it does
Get check inGet check-in details.
Get departmentGet department details.
Get groupGet group details.
Get high fiveGet high five details.
Get objectiveGet objective details.
Get people attributeGet people attribute details.
Get questionGet question details.
Get review cycleGet review cycle details.
Get userGet user details.
List answersList answers.
List attribute valuesList people attribute values.
List check insList check-ins.
List departmentsList departments.
List group typesList group types.
List groupsList groups.
List high fivesList high fives.
List objectivesList objectives.
List people attributesList people attributes.
List prioritiesList priorities.
List pulse answersRetrieve pulse data.
List questionsList questions.
List review cyclesList review cycles.
List security audit eventsList security audit events.
List usersList users.
List vacationsList vacations.

Get check in

Get check-in details.

Inputs

IdidtextRequired
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

IdidtextRequired
Id.

Outputs

dataobject
15Five response data.
Example output
{
  "data": {
    "id": 1,
    "name": "example"
  }
}

Get group

Get group details.

Inputs

IdidtextRequired
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

IdidtextRequired
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

IdidtextRequired
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

IdidtextRequired
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

IdidtextRequired
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

IdidtextRequired
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

IdidtextRequired
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 idquestion_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
Userapp_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 startcreated_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 endcreated_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 byorder_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".
Pagepagenumber
Results page
Created aftercreated_aftertext
Only include users with creation date greater than or equal to the value.
Created beforecreated_beforetext
Only include users with creation date less than or equal to the value.
Updated afterupdated_aftertext
Only include users with updated date greater than or equal to the value.
Updated beforeupdated_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

Pagepagenumber
Results page
Order byorder_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 aftercreated_aftertext
Only include attribute values with creation date greater than or equal to the value.
Created beforecreated_beforetext
Only include attribute values with creation date less than or equal to the value.
Updated afterupdated_aftertext
Only include attribute values with updated date greater than or equal to the value.
Updated beforeupdated_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

Userapp_user_idtext
Filter reports by user id.
Due date startdue_date_starttext
Only include reports with due date greater than or equal to the date specified in the YYYY-MM-DD format.
Due date enddue_date_endtext
Only include reports with due date less than or equal to the date specified in the YYYY-MM-DD format.
Order byorder_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"
Pagepagenumber
Results page
Created aftercreated_aftertext
Only include users with creation date greater than or equal to the value.
Created beforecreated_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

Namenametext
Include only departments with the specified name.
Pagepagenumber
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 pluralname_pluraltext
Include only group_types with the specified plural name.
Pagepagenumber
Results page

Outputs

dataobject
15Five response data.
Example output
{
  "data": {
    "count": 1,
    "next": "example",
    "previous": "example",
    "results": []
  }
}

List groups

List groups.

Inputs

Name inname_intext
Include only groups with the specified names.
Pagepagenumber
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 idreport_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 idreceiver_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 startcreated_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 endcreated_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 byorder_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"
Pagepagenumber
Results page
Created aftercreated_aftertext
Only include users with creation date greater than or equal to the value.
Created beforecreated_beforetext
Only include users with creation date less than or equal to the value.
Updated afterupdated_aftertext
Only include users with updated date greater than or equal to the value.
Updated beforeupdated_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

Userapp_user_idtext
Include only person-specific objectives for a user with the specified ID.
Parent idparent_idtext
Include only objectives of a parent with the specified ID.
Department iddepartment_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 afterstart_aftertext
Only include objectives with start date greater than or equal to the date specified in the YYYY-MM-DD format.
End beforeend_beforetext
Only include objectives with end date less than or equal to the date specified in the YYYY-MM-DD format.
Scopescopetext
Include only objectives with the specified scope type: string enum: - company-wide - group-type - individual - self-development
Statestatetext
Include only objectives with the specified state; deprecated values: 'past', 'current', 'deactivated'One of: active, future, archived, closed.
Colorcolortext
Include only objectives with the specified current statusOne of: green, yellow, red, undefined.
Pagepagenumber
Results page
Created aftercreated_aftertext
Only include objectives with creation date greater than or equal to the value.
Created beforecreated_beforetext
Only include objectives with creation date less than or equal to the value.
Updated afterupdated_aftertext
Only include objectives with updated date greater than or equal to the value.
Updated beforeupdated_beforetext
Only include objectives with updated date less than or equal to the value.
Order byorder_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

Pagepagenumber
Results page
Order byorder_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 aftercreated_aftertext
Only include attributes with creation date greater than or equal to the value.
Created beforecreated_beforetext
Only include attributes with creation date less than or equal to the value.
Updated afterupdated_aftertext
Only include attributes with updated date greater than or equal to the value.
Updated beforeupdated_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

Pagepagenumber
Results page
Order byorder_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 aftercreated_aftertext
Only include users with creation date greater than or equal to the value.
Created beforecreated_beforetext
Only include users with creation date less than or equal to the value.
Updated afterupdated_aftertext
Only include users with updated date greater than or equal to the value.
Updated beforeupdated_beforetext
Only include users with updated date less than or equal to the value.
Userapp_user_idtext
Filter priorities by user id.
Manager idmanager_idtext
Filter priorities by manager id.
Group idgroup_idtext
Filter priorities by group id.
Include past checkinsinclude_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

Pagepagenumber
Results page
Order byorder_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 aftercreated_aftertext
Only include users with creation date greater than or equal to the value.
Created beforecreated_beforetext
Only include users with creation date less than or equal to the value.
Updated afterupdated_aftertext
Only include users with updated date greater than or equal to the value.
Updated beforeupdated_beforetext
Only include users with updated date less than or equal to the value.
Report idreport_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
Userapp_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 startcreated_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 endcreated_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

Userapp_user_idtext
Include only person-specific questions for a user with the specified ID.
Group idgroup_idtext
Include only group-specific questions for a group with the specified ID.
Pagepagenumber
Results page
Order byorder_bytext
Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts".
Created aftercreated_aftertext
Only include users with creation date greater than or equal to the value.
Created beforecreated_beforetext
Only include users with creation date less than or equal to the value.
Updated afterupdated_aftertext
Only include users with updated date greater than or equal to the value.
Updated beforeupdated_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 startcreated_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 endcreated_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 startupdated_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 endupdated_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 afterhierarchy_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 beforehierarchy_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 startstarted_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 endstarted_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 startended_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 endended_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.
Pagepagenumber
Results page
Order byorder_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 idactor_idtext
Include only security audits for the specified user.
Pagepagenumber
Results page
Order byorder_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 aftercreated_aftertext
Only include security audits with creation date greater than or equal to the value.
Created beforecreated_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

Pagepagenumber
Results page
Order byorder_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 aftercreated_aftertext
Only include users with creation date greater than or equal to the value.
Created beforecreated_beforetext
Only include users with creation date less than or equal to the value.
Updated afterupdated_aftertext
Only include users with updated date greater than or equal to the value.
Updated beforeupdated_beforetext
Only include users with updated date less than or equal to the value.
Emailemailtext
Filter users by email.
Employee idemployee_idtext
Filter users by employee ID.
First namefirst_nametext
Filter users by first name.
Last namelast_nametext
Filter users by last name.
Locationlocationtext
Filter users by location.
Is activeis_activetrue/false
Filter users by status.
Is company adminis_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

Useruserlist
Include only vacations for given user ids.
Pagepagenumber
Results page
Order byorder_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 aftercreated_aftertext
Only include vacations with creation date greater than or equal to the value.
Created beforecreated_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": []
  }
}

On this page