15Five API

list

Answer resource - get a list of answers. Useful for creating custom reports.

Returns all 15Five's answers for all users within the company. You can filter the list by question(s), user(s), answers' creation date.

Built-in pagination, with a default limit of 50 objects.

Company-wide API key required.

Query parameters

• question_id

  • description: 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

  • required: false

  • type: integer

• user_id

  • description: 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

  • required: false

  • type: integer

• created_on_start

  • description: Only include answers having creation date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

  • required: false

  • type: date

• created_on_end

  • description: Only include answers having creation date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

  • required: false

  • type: date

• order_by

  • description: 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"

  • type: string

• name: page in: query description: Results page schema: type: integer

• name: created_after in: query description: | Only include users with creation date greater than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• name: created_before in: query description: | Only include users with creation date less than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'
• name: updated_after in: query description: | Only include users with updated date greater than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'
• name: updated_before in: query description: | Only include users with updated date less than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

Response

• id

  • type: integer
  • required: true
  • description: Answers's ID

• report_id

  • type: integer
  • required: true
  • description: Report's ID

• question

  • type: string
  • required: true
  • description: Question that this answer answers

• user

  • type: string
  • required: true
  • description: User that gave the answer

• create_ts

  • type: dateTime
  • required: true
  • description: The actual date this answer was saved (submitted) by user

• update_ts

  • type: dateTime
  • required: true
  • description: The actual date this answer was updated by user

• answer_text

  • type: string
  • required: true
  • description: Answer's content

• metrics_value

  • type: decimal
  • required: false
  • description: Answer's metrics value

Query Parameters

The following parameters should be included as part of a URL query string.

read

Answer resource - get answer object by id. Useful for creating custom reports.

Returns 15Five's answer object.

Company-wide API key required.

Response

• id

  • type: integer
  • required: true
  • description: Answers's ID

• report_id

  • type: integer
  • required: true
  • description: Report's ID

• question

  • type: string
  • required: true
  • description: Question that this answer answers

• user

  • type: string
  • required: true
  • description: User that gave the answer

• create_ts

  • type: dateTime
  • required: true
  • description: The actual date this answer was saved (submitted) by user

• answer_text

  • type: string
  • required: true
  • description: Answer's content

• metrics_value

  • type: decimal
  • required: false
  • description: Answer's metrics value

• comments

  • type: array
  • required: false
  • description: List of comments related to this answer

Path Parameters

The following parameters should be included in the URL path.

list

PeopleAttribute resource - get a list of people attributes

Returns 15Five's attributes within the company.

Built-in pagination, with a default limit of 50 objects.

Company-wide API key required.

Response

• id

  • type: integer
  • required: true
  • description: ID of the people attribute

• name

  • type: string
  • required: false
  • description: Name of the people attribute

• slug

  • type: string
  • required: false
  • description: Name representation without spaces or special characters

• datatype

  • type: string
  • required: false
  • options: ['text', 'date']
  • description: Datatype for the people attribute

Query Parameters

The following parameters should be included as part of a URL query string.

create

Endpoint for creating a People Attribute

Maximum 50 attributes per company

Returns the result of creation along with the attribute created

Request Body

The request body should be a "application/json" encoded object, containing the following items.

read

PeopleAttribute resource - get People Attribute object by id.

Returns 15Five's people attribute object.

Company-wide API key required.

Response

• id

  • type: integer
  • required: true
  • description: ID of the people attribute

• name

  • type: string
  • required: false
  • description: Name of the people attribute

• slug

  • type: string
  • required: false
  • description: Name representation without spaces or special characters

• datatype

  • type: string
  • required: false
  • options: ['text', 'date']
  • description: Datatype for the people attribute

• is_default

  • type: boolean
  • required: false
  • description: True if people attribute is a default field

• is_only_admin_editable

  • type: boolean
  • required: false
  • description: True if people attribute is editable only by company admins

Path Parameters

The following parameters should be included in the URL path.

list

PeopleAttributeValue resource - get a list of people attribute values

Returns 15Five's people attribute values

Built-in pagination, with a default limit of 50 objects.

Company-wide API key required.

Response

• id

  • type: integer
  • description: ID of the people attribute value

• attribute__is_only_admin_editable

  • type: bool
  • description: Attribute is only admin editable

• attribute__is_default

  • type: bool
  • description: Attribute is default

• attribute__id

  • type: integer
  • description: ID of the people attribute

• attribute__name

  • type: string
  • description: Name of the people attribute

• attribute__slug

  • type: string
  • description: Slug of the people attribute

• attribute__datatype

  • type: string
  • description: Datatype of the people attribute

• attribute__category

  • type: string
  • description: Category of the people attribute

• user_id

  • type: integer
  • description: User ID for whom the people attribute value is set

• value

  • type: string
  • description: Value for the people attribute

Query Parameters

The following parameters should be included as part of a URL query string.

create

Endpoint for creating a People Attribute Values

Returns the result of creation along with the attribute created

Company-wide API key required.

POST data accepted:

• name

  • type: string
  • required: true
  • description: Name of attribute to create value for

• user_id

  • type: integer
  • required: false
  • description: User ID to set value for, default to API key user

• value

  • type: string
  • required: true
  • description: Value for the People Attribute

read

PeopleAttributeValue resource - get People Attribute Value object by id.

Returns 15Five's people attribute value object.

Company-wide API key required.

Response

• id

  • type: integer
  • description: ID of the people attribute value

• value

  • type: string
  • description: Value of the people attribute value

• user

  • type: string
  • description: Hyperlink to user for people attribute value

• attribute

  • type: string
  • description: Hyperlink to attribute for people attribute value

Path Parameters

The following parameters should be included in the URL path.

create

Endpoint for uploading a bulk import file.

Returns the result of processing of the bulk import: ok, error, or queued

CSV Format:

• Fields:

  • email (This is always required if "email" is being used as the unique_identifier. If "employee_id" is being used as the unique_identifier, it is only required when creating new users.)
  • first_name
  • last_name
  • title
  • hire_date
  • due_day
  • due_day_week
  • check_in_period
  • reviewer_email
  • time_zone
  • active_group_names
  • add_to_groups
  • remove_from_groups
  • is_group_admin_for
  • is_active
  • location
  • employee_id (is required when "employee_id" is being used as the unique_identifier)
  • job_description
  • strengths
  • saml_user_id
  • send_welcome_from
  • custom_[field name]
  • additional_manager

• Notes:

  • Only the fields in the example are permitted
  • You can specify multiple groups separated by comma but ensure "active_group_names" field is wrapped with double quote
  • If you'd like to specify the group type as well, please include a tilde (~) in between the group type and group, for example, Departments~HR. Group Types feature is required to be enabled.
  • You should not use add_to_groups/remove_from_groups when using active_group_names
  • You can create and populate custom people attributes by adding the “custom_” prefix to a field name. 15Five offers people attribute support for dates (must be mm/dd/yyyy format) and text, including numbers.
  • The "due_day_week" field is only applicable to monthly and biweekly Check-in frequencies. If monthly, this indicates whether the Check-in is due on the first, second, third, fourth, or last week of the month. If the Check-in frequency is biweekly, this indicates whether the Check-in is due on odd or even weeks.
  • You can specify how frequently the Check-in is due with the "check_in_period" field. This may be weekly, biweekly (every other week), or monthly.
  • Learn more about bulk import and formatting time zones here: https://s.15five.com/s/QW-gmA

Note about Active Groups:

Please note any changes made in the "active_group_names" will override any current group settings.

Company-wide API key required.

POST (request body) parameters

• csv_file

  • type: file upload
  • required: true
  • description: The file to upload, encoded as UTF-8. Format can be found at https://app.15five.com/company/users/bulk-import/

• unique_identifier

  • type: string
  • required: false
  • description: Field used to identify existing profiles. Can be one of the following values: 'email', 'employee_id'. If not provided, the company's "Employee identifier" setting (Company settings > Import settings) will be used.

• email

  • type: string
  • required: false
  • description: Email address where the results will be emailed.

is_active > list

Whether the authenticated company account is active in 15Five.

Company-wide API key or authenticated company admin session.

list

Get company settings for a company.

Company-wide API key required.

Response

• unique_identifier
  • type: string
  • required: true
  • description: Field used to identify existing employee profiles. Can be "email" or "employee_id"

list

Department resource - get a list of departments.

Returns 15Five's departments within the company.

Built-in pagination, with a default limit of 50 objects.

Company-wide API key required.

Warning: deprecated in favor of CompanyGroup.

Query parameters

• name
  • description: Include only departments with the specified name.
  • required: false
  • type: string

Response

• id

  • type: integer
  • required: true
  • description: Department's ID

• name

  • type: string
  • required: true
  • description: Department's name

Query Parameters

The following parameters should be included as part of a URL query string.

read

Department resource - get department object by id.

Returns 15Five's department object.

Company-wide API key required.

Warning: deprecated in favor of CompanyGroup.

Response

• id

  • type: integer
  • required: true
  • description: Department's ID

• name

  • type: string
  • required: true
  • description: Department's name

Path Parameters

The following parameters should be included in the URL path.

list

Gets current feature statuses for a company.

Company-wide API key required.

Response

• pulse
  • type: string
  • required: true
  • description: Value is 'enabled' if the company can access Pulse and 'disabled' if not
• demographic_attributes
  • type: string
  • required: true
  • description: Value is 'enabled' if the Demographic Attributes feature is enabled for the company and 'disabled' if not

list

CompanyGroup resource - get a list of groups.

Returns 15Five's groups within the company.

Built-in pagination, with a default limit of 50 objects.

Company-wide API key required.

Query parameters

• name__in
  • description: Include only groups with the specified names.
  • required: false
  • type: string

Response

• id

  • type: integer
  • required: true
  • description: ID of the company group

• name

  • type: string
  • required: false
  • description: Name of the company group

• group_type_name

  • type: string
  • required: false
  • description: Plural name of the group type

• members_count

  • type: integer
  • required: true
  • description: Count of group members

Query Parameters

The following parameters should be included as part of a URL query string.

create

CompanyGroup resource - create a group.

Returns 15Five's group.

Company-wide API key required.

POST parameters

• name

  • description: Group's name
  • required: true
  • type: string

• group_type_id

  • description: Associated GroupType's ID. Default group type "Groups" (id)
  • required: false
  • type: integer

• group_admins_ids

  • description: List of User's ID to be assigned as group admins
  • required: false
  • type: array[int]

• member_ids

  • description: List of User's ID to be assigned as group members
  • required: false
  • type: array[int]

• is_peer_drilldown

  • description: Designates if it is peer drilldown
  • required: false
  • type: boolean

• is_priorities_access_on

  • description: Designates if it priorities access is on
  • required: false
  • type: boolean

• is_peer_view

  • description: Designates if it is peer view
  • required: false
  • type: boolean

• skip_company_wide_questions

  • description: Does not answer company-wide questions
  • required: false
  • type: boolean

Response

• id

  • description: Group's ID
  • required: true
  • type: integer

• name

  • description: Group's name
  • required: true
  • type: string

• group_type_id

  • description: Associated GroupType's ID. Default group type "Groups" (id)
  • required: true
  • type: integer

• group_admins_ids

  • description: List of User's ID to be assigned as group admins
  • required: true
  • type: array[int]

• member_ids

  • description: List of User's ID to be assigned as group members
  • required: true
  • type: array[int]

• is_peer_drilldown

  • description: Designates if it is peer drilldown
  • required: true
  • type: boolean

• is_priorities_access_on

  • description: Designates if it priorities access is on
  • required: true
  • type: boolean

• is_peer_view

  • description: Designates if it is peer view
  • required: true
  • type: boolean

• skip_company_wide_questions

  • description: Does not answer company-wide questions
  • required: true
  • type: boolean

Request Body

The request body should be a "application/json" encoded object, containing the following items.

update

CompanyGroup resource - update a group.

Returns 15Five's group.

Company-wide API key required.

PUT parameters

• id

  • description: Group's ID
  • required: true
  • type: integer

• name

  • description: Group's name
  • required: true
  • type: string

• group_type_id

  • description: Associated GroupType's ID. Default group type "Groups" (id)
  • required: false
  • type: integer

• group_admins_ids

  • description: List of User's ID to be assigned as group admins
  • required: false
  • type: array[int]

• member_ids

  • description: List of User's ID to be assigned as group members
  • required: false
  • type: array[int]

• is_peer_drilldown

  • description: Designates if it is peer drilldown
  • required: false
  • type: boolean

• is_priorities_access_on

  • description: Designates if it priorities access is on
  • required: false
  • type: boolean

• is_peer_view

  • description: Designates if it is peer view
  • required: false
  • type: boolean

• skip_company_wide_questions

  • description: Does not answer company-wide questions
  • required: false
  • type: boolean

Response

• id

  • description: Group's ID
  • required: true
  • type: integer

• name

  • description: Group's name
  • required: true
  • type: string

• group_type_id

  • description: Associated GroupType's ID. Default group type "Groups" (id)
  • required: true
  • type: integer

• group_admins_ids

  • description: List of User's ID to be assigned as group admins
  • required: true
  • type: array[int]

• member_ids

  • description: List of User's ID to be assigned as group members
  • required: true
  • type: array[int]

• is_peer_drilldown

  • description: Designates if it is peer drilldown
  • required: true
  • type: boolean

• is_priorities_access_on

  • description: Designates if it priorities access is on
  • required: true
  • type: boolean

• is_peer_view

  • description: Designates if it is peer view
  • required: true
  • type: boolean

• skip_company_wide_questions

  • description: Does not answer company-wide questions
  • required: true
  • type: boolean

Request Body

The request body should be a "application/json" encoded object, containing the following items.

read

CompanyGroup resource - get company group object by id.

Returns 15Five's company group object.

Company-wide API key required.

Response

• id

  • type: integer
  • required: true
  • description: ID of the company group

• name

  • type: string
  • required: false
  • description: Name of the company group

• members

  • type: array
  • required: false
  • description: Users in this company group

• group_admins

  • type: array
  • required: false
  • description: Admins for this company group

• group_type

  • type: string
  • required: false
  • description: ID of the group type

• group_type_name

  • type: string
  • required: false
  • description: Plural name of the group type

• is_peer_drilldown

  • type: boolean
  • required: true
  • description: Designates if it is peer drilldown

• is_peer_view

  • type: boolean
  • required: true
  • description: Designates if it is peer view

• skip_company_wide_questions

  • type: boolean
  • required: true
  • description: Does not answer company-wide questions

• create_ts

  • type: dateTime
  • required: true
  • description: Group's creation timestamp

Path Parameters

The following parameters should be included in the URL path.

list

Group Type resource - get a list of group types.

Returns 15Five's group types within the company.

Built-in pagination, with a default limit of 50 objects.

Company-wide API key required.

Query parameters

• name_plural
  • description: Include only group_types with the specified plural name.
  • required: false
  • type: string

Response

• id

  • type: integer
  • required: true
  • description: Group Type's ID

• plural_name

  • type: string
  • required: true
  • description: Group Type's plural name

• singular_name

  • type: string
  • required: true
  • description: Group Type's singular name

Query Parameters

The following parameters should be included as part of a URL query string.

create

Group Type resource - create a group type within a company.

Returns 15Five's created group type within the company.

Company-wide API key required.

Query parameters

• name_plural
  • description: Include only group_types with the specified plural name.
  • required: false
  • type: string

Response

• id

  • type: integer
  • required: true
  • description: Group Type's ID

• plural_name

  • type: string
  • required: true
  • description: Group Type's plural name

• singular_name

  • type: string
  • required: true
  • description: Group Type's singular name

Request Body

The request body should be a "application/json" encoded object, containing the following items.

read

CompanyGroupType resource - get company group type object by id.

Returns 15Five's company group type object.

Company-wide API key required.

Response

• id

  • type: integer
  • description: ID of the company group type

• name_singular

  • type: string
  • description: Name of the company group type

• name_plural

  • type: string
  • description: Name of the company group type

• companygroup_set

  • type: array
  • description: Groups in this company group type

• create_ts

  • type: dateTime
  • description: Group type's creation timestamp

Path Parameters

The following parameters should be included in the URL path.

update

Path Parameters

The following parameters should be included in the URL path.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

partial_update

Path Parameters

The following parameters should be included in the URL path.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

delete

Path Parameters

The following parameters should be included in the URL path.

list

Example endpoint for checking connection and api key validity.

Returns 15Five's server's current timestamp.

User or company-wide API key required.

Documentation (interact) Usage:

Add the API key to the Authentication Token panel accessible from the navigation menu,
before using the interact buttons.

Bash Usage:

$ curl -v -H "Authorization: <TOKEN>" https://<company subdomain>.15five.com/api/public/hello/

Javascript Usage:

var coreapi = window.coreapi;
var token = new coreapi.auth.TokenAuthentication({token: "<TOKEN>"})
var client = new coreapi.Client({auth: token});
client.get("https://<company subdomain>.15five.com/api/public/hello/")
    .then((data) => {
        console.log("Status: ", data);
    })
    .catch((error) => {
        console.log("Error: ", error);
    });

Python Usage:

import coreapi
auth = coreapi.auth.TokenAuthentication(token='<TOKEN>')
client = coreapi.Client(auth=auth)
response = client.get("https://<company subdomain>.15five.com/api/public/hello/")
...

Response

• timestamp
  • type: int
  • required: true
  • description: 15Five's server current timestamp

list

HighFive resource - get a list of high fives. Useful for creating custom reports.

Returns all 15Five's high fives for all users within the company. You can filter the list by report(s), receiver(s), and high fives' creation date.

Built-in pagination, with a default limit of 50 objects.

Company-wide API key required.

Query parameters

• report_id

  • description: 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

  • required: false

  • type: integer

• receiver_id

  • description: 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

  • required: false

  • type: integer

• created_on_start

  • description: 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.

  • required: false

  • type: date

• created_on_end

  • description: 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.

  • required: false

  • type: date

• order_by

  • description: 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"

  • type: string

• name: created_after in: query description: | Only include items with creation date greater than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• name: created_before in: query description: | Only include items with creation date less than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'
• name: updated_after in: query description: | Only include items with updated date greater than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'
• name: updated_before in: query description: | Only include items with updated date less than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

Response

• id

  • type: integer
  • required: true
  • description: High fives's ID

• report

  • type: string
  • required: true
  • description: Report that contains the high five

• create_ts

  • type: dateTime
  • required: true
  • description: The actual date this high five was saved (submitted) by user

• text

  • type: string
  • required: true
  • description: High Five's content

• creator_id

  • type: integer
  • required: true
  • description: High five creator's ID

• creator

  • type: string
  • required: true
  • description: Link to high five's creator

• creator_details

  • type: array
  • required: true
  • id
    • type: int
    • required: true
    • description: creator id
  • full_name
    • type: string
    • required: true
    • description: full creator name
  • email
    • type: string
    • required: true
    • description: creator email

• receivers

  • type: array
  • required: true
  • description: list of all mentioned users (incl. users mentioned by all, and groups)
  • id
  • type: int
  • required: true
  • description: user id
  • url
  • type: string
  • required: true
  • description; link to user details
  • full_name
  • type: string
  • required: true
  • description: full user name
  • email
  • type: string
  • required: true
  • description: user email

• email_receivers

  • type: array
  • required: false
  • description: list of email mentions
  • email
  • type: string
  • required: true
  • description: mentioned email

Query Parameters

The following parameters should be included as part of a URL query string.

create

High five resource - create a High five within a company.

Returns 15Five's created High five within the company.

Company-wide API key required.

POST parameters

• text

  • description: Text of the high five. SHould include the @mention of the persons, and/or the emails mention
  • required: true
  • type: string

• creator_id

  • description: ID of the user creating the high five
  • required: true
  • type: integer

Response

• id

  • type: integer
  • required: true
  • description: High fives's ID

• report

  • type: string
  • required: true
  • description: Report that contains the high five

• create_ts

  • type: dateTime
  • required: true
  • description: The actual date this high five was saved (submitted) by user

• text

  • type: string
  • required: true
  • description: High Five's content

• creator_id

  • type: integer
  • required: true
  • description: High five creator's ID

• creator

  • type: string
  • required: true
  • description: Link to high five's creator

• creator_details

  • type: array
  • required: true
  • id
    • type: int
    • required: true
    • description: creator id
  • full_name
    • type: string
    • required: true
    • description: full creator name
  • email
    • type: string
    • required: true
    • description: creator email

• receivers

  • type: array
  • required: true
  • description: list of all mentioned users (incl. users mentioned by all, groups and email)
  • id
  • type: int
  • required: true
  • description: user id
  • url
  • type: string
  • required: true
  • description; link to user details
  • full_name
  • type: string
  • required: true
  • description: full user name
  • email
  • type: string
  • required: true
  • description: user email

Request Body

The request body should be a "application/json" encoded object, containing the following items.

read

High five resource - get high five object by id.

Returns 15Five's high five object.

Company-wide API key required.

Response

• id

  • type: integer
  • required: true
  • description: High five's ID

• report

  • type: string
  • required: true
  • description: Report that contains the high five

• create_ts

  • type: dateTime
  • required: true
  • description: The actual date this high five was saved (submitted) by user

• text

  • type: string
  • required: true
  • description: High five's content

• comments

  • type: array
  • required: false
  • description: List of comments related to this high five

• creator_id

  • type: integer
  • required: true
  • description: High five creator's ID

• creator

  • type: string
  • required: true
  • description: Link to high five's creator

• creator_details

  • type: array
  • required: true
  • id
    • type: int
    • required: true
    • description: creator id
  • full_name
    • type: string
    • required: true
    • description: full creator name
  • email
    • type: string
    • required: true
    • description: creator email

• receivers

  • type: array
  • required: true
  • description: list of all mentioned users (incl. users mentioned by all, groups and email)
  • id
  • type: int
  • required: true
  • description: user id
  • url
  • type: string
  • required: true
  • description; link to user details
  • full_name
  • type: string
  • required: true
  • description: full user name
  • email
  • type: string
  • required: true
  • description: user email

Path Parameters

The following parameters should be included in the URL path.

programs > list

Fetch programs data from Context Store for the user's company.

programs > create

Fetch programs data from Context Store for the user's company.

programs > source-last-updated > list

Fetch the last updated timestamp for programs data source.

list

Fetch proactive insights data from Context Store for the user's company.

create

Fetch proactive insights data from Context Store for the user's company.

families > create

Fetch insight families data from Context Store for the user's company.

tiles > create

Fetch insights tiles data from Context Store for the user's company.

create

Objective key result resource - create key results.

Returns list of key results.

Company-wide API key required.

POST parameters (list)

• objective_id

  • description: Associated objective's id
  • required: true
  • type: int

• description

  • description: Key Result's description
  • required: true
  • type: string

• type

  • description: Type of Key Result. (currency/boolean/number/[percent])
  • required: false
  • type: string

• currency

  • description: Currency if key result type is "currency", default "USD"
  • required: false
  • type: string

• start_value

  • description: Start value
  • required: false
  • type: decimal

• target_value

  • description: Target value
  • required: false
  • type: decimal

• owner_id

  • description: Owner user's ID
  • required: false
  • type: int

Response (list)

• id

  • description: Key Result's id
  • required: true
  • type: int

• create_ts

  • type: datetime
  • required: true
  • description: timestamp of the creation

• update_ts

  • type: datetime
  • required: true
  • description: timestamp of the update

• objective_id

  • description: Associated objective's id
  • required: true
  • type: int

• description

  • description: Key Result's description
  • required: true
  • type: string

• type

  • description: Type of Key Result. (currency/boolean/number/[percent])
  • required: true
  • type: string

• currency

  • description: Currency if key result type is "currency", default "USD"
  • required: true
  • type: string

• start_value

  • description: Start value
  • required: true
  • type: decimal

• target_value

  • description: Target value
  • required: true
  • type: decimal

• owner_id

  • description: Owner user's ID
  • required: true
  • type: int

update

Objective key result resource - create key results.

Returns list of key results.

Company-wide API key required.

PUT parameters (list)

• id

  • description: Key Result's id
  • required: true
  • type: int

• objective_id

  • description: Associated objective's id
  • required: false
  • type: int

• description

  • description: Key Result's description
  • required: false
  • type: string

• type

  • description: Type of Key Result. (currency/boolean/number/[percent])
  • required: false
  • type: string

• currency

  • description: Currency if key result type is "currency", default "USD"
  • required: false
  • type: string

• start_value

  • description: Start value
  • required: false
  • type: decimal

• target_value

  • description: Target value
  • required: false
  • type: decimal

• owner_id

  • description: Owner user's ID
  • required: false
  • type: int

Response (list)

• id

  • description: Key Result's id
  • required: true
  • type: int

• create_ts

  • type: datetime
  • required: true
  • description: timestamp of the creation

• update_ts

  • type: datetime
  • required: true
  • description: timestamp of the update

• objective_id

  • description: Associated objective's id
  • required: true
  • type: int

• description

  • description: Key Result's description
  • required: true
  • type: string

• type

  • description: Type of Key Result. (currency/boolean/number/[percent])
  • required: true
  • type: string

• currency

  • description: Currency if key result type is "currency", default "USD"
  • required: true
  • type: string

• start_value

  • description: Start value
  • required: true
  • type: int

• target_value

  • description: Target value
  • required: true
  • type: int

• owner_id

  • description: Owner user's ID
  • required: true
  • type: int

update-value > create

Objective key result resource - update current value for key result.

Returns execution status of updating.

Company-wide API key required.

POST parameters

• current_value
  • description: New current value for key result
  • required: true
  • type: float

Response

• status
  • type: string
  • required: true
  • description: Execution status (ok, error)

Path Parameters

The following parameters should be included in the URL path.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

list

Objective resource - get a list of objectives.

Returns 15Five's objectives within the company.

Built-in pagination, with a default limit of 50 objects.

Company-wide API key required.

Query parameters

• user_id

  • description: Include only person-specific objectives for a user with the specified ID.

  • required: false

  • type: integer

• parent_id

  • description: Include only objectives of a parent with the specified ID.
  • required: false
  • type: integer

• department_id

  • description: 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

  • required: false

  • type: integer

• start_after

  • description: Only include objectives with start date greater than or equal to the date specified in the YYYY-MM-DD format.

  • required: false

  • type: date

• end_before

  • description: Only include objectives with end date less than or equal to the date specified in the YYYY-MM-DD format.

  • required: false

  • type: date

• scope

  • description: Include only objectives with the specified scope; can be one of the following values: 'company-wide', 'group-type', 'individual' or 'self-development'

  • required: false

  • type: string

• state

  • description: Include only objectives with the specified state; can be one of the following values: 'active', 'future', 'archived', or 'closed' Warning: deprecated values: 'past', 'current', 'deactivated'

  • required: false

  • type: string

• color

  • description: Include only objectives with the specified current status; can be one of the following values: 'green', 'yellow', 'red', or 'undefined'

  • required: false

  • type: string

• created_after

  • description: Only include items with creation date greater than or equal to the value.
  • required: false
  • type: string
    • pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• created_before

  • description: Only include items with creation date lower than or equal to the value.
  • required: false
  • type: string
    • pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• updated_after

  • description: Only include items with update date greater than or equal to the value.
  • required: false
  • type: string
    • pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• updated_before

  • description: Only include items with update date lower than or equal to the value.
  • required: false
  • type: string
    • pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• order_by

  • description: | Order results by the specified field. Can be one of the following values: 'id', 'create_ts', 'update_ts', 'end_ts', 'sort_order' Add "-" prefix to the field name to reverse the order.
  • required: false
  • type: string

Response

• id

  • type: integer
  • required: true
  • description: Objective's ID

• create_ts

  • type: datetime
  • required: true
  • description: timestamp of the creation

• update_ts

  • type: datetime
  • required: true
  • description: timestamp of the update

• parent

  • type: string
  • required: false
  • description: Link to objective's parent

• user

  • type: string
  • required: true
  • description: Link to objective's user

• user_details

  • type: array
  • required: true
  • id
    • type: int
    • required: true
    • description: user id
  • full_name
    • type: string
    • required: true
    • description: full user name
  • email
    • type: string
    • required: true
    • description: user email

• description

  • type: string
  • required: true
  • description: Objective's description

• scope

  • type: string
  • required: true
  • description: Objective's scope; can be one of the following values: 'company-wide', 'group-type', 'individual' or 'self-development'

• start_ts

  • type: dateTime
  • required: true
  • description: Objective's start date

• end_ts

  • type: dateTime
  • required: true
  • description: Objective's end date

• color

  • type: string
  • required: true
  • description: Objective's status color; can be one of the following values: 'green', 'yellow', 'red', or 'undefined'

• percentage

  • type: integer
  • required: true
  • description: Objective's composite percentage of completion

• is_active

  • type: boolean
  • required: true
  • description: Designates whether the objective is active

• is_closed

  • type: boolean
  • required: true
  • description: Designates whether the objective is closed

• is_complete

  • type: boolean
  • required: true
  • description: Designates whether the objective is closed. Warning: deprecated. Use is_closed instead.

• is_archived

  • type: boolean
  • required: true
  • description: Designates whether the objective is archived

• is_past_due

  • type: boolean
  • required: true
  • description: Designates whether the objective is past due

• is_future

  • type: boolean
  • required: true
  • description: Designates whether the objective's start date is in the future

• visibility

  • type: string
  • required: true
  • description: Objective's visibility; can be one of the following values: 'public', 'report', or 'custom'

• result_count

  • type: integer
  • required: true
  • description: Number of objective's key results

Query Parameters

The following parameters should be included as part of a URL query string.

create

Objective resource - create objectives.

Returns created 15Five's objectives.

Company-wide API key required.

The request body should be an "application/json" encoded list of objects, containing the following items.

POST parameters (list)

• description

  • description: Objective's description
  • required: true
  • type: string

• start_ts

  • description: Objective's start date
  • required: true
  • type: dateTime

• end_ts

  • description: Objective's end date
  • required: true
  • type: dateTime

• visibility

  • description: Objective's visibility; can be one of the following values: 'public', 'report', or 'custom'. Default: 'public'
  • required: false
  • type: string

• scope

  • description: Objective's scope; can be one of the following values: 'company-wide', 'department', 'individual', 'group-type' or 'self-development'
  • required: true
  • type: string

• user_id

  • description: Objective's owner id
  • required: true
  • type: integer

• parent_id

  • description: Objective's parent objective id
  • required: false
  • type: integer

• is_progress_aligned

  • description: Allow a child objective's progress to impact any aligned parent objectives
  • required: false
  • type: boolean

• tags

  • description: List of tags
  • required: false
  • type: array[string]

• group_id

  • description: Associated group id
  • required: false
  • type: integer

• viewable_by_users

  • description: List of user ids who can view objective
  • required: false
  • type: array[integer]

• viewable_by_groups

  • description: List of group ids who can view objective
  • required: false
  • type: array[integer]

• key_results

  • description

    • description: Key Result's description
    • required: true
    • type: string

  • type

    • description: Type of Key Result. (currency/boolean/number/[percent])
    • required: false
    • type: string

  • currency

    • description: Currency if key result type is "currency", default "USD"
    • required: false
    • type: string

  • start_value

    • description: Start value
    • required: false
    • type: decimal

  • target_value

    • description: Target value
    • required: false
    • type: decimal

  • owner_id

    • description: Owner user's ID
    • required: false
    • type: int

Response (list)

• id

  • type: integer
  • required: true

• create_ts

  • type: datetime
  • required: true
  • description: timestamp of the creation

• update_ts

  • type: datetime
  • required: true
  • description: timestamp of the update

• parent

  • type: string
  • required: false
  • description: Objective's parent

• user

  • type: string
  • required: true
  • description: Objective's owner

• user_details

  • type: array
  • required: true
  • id
    • type: int
    • required: true
    • description: user id
  • full_name
    • type: string
    • required: true
    • description: full user name
  • email
    • type: string
    • required: true
    • description: user email

• description

  • type: string
  • required: true
  • description: Objective's description

• scope

  • type: string
  • required: true
  • description: Objective's scope; can be one of the following values: 'company-wide', 'department', 'individual', 'group-type' or 'self-development'

• start_ts

  • type: dateTime
  • required: true
  • description: Objective's start date

• end_ts

  • type: dateTime
  • required: true
  • description: Objective's end date

• color

  • type: string
  • required: true
  • description: Objective's status color; can be one of the following values: 'green', 'yellow', 'red', or 'undefined'

• percentage

  • type: integer
  • required: true
  • description: Objective's composite percentage of completion

• is_active

  • type: boolean
  • required: true
  • description: Designates whether the objective is active

• is_closed

  • type: boolean
  • required: true
  • description: Designates whether the objective is closed

• is_complete

  • type: boolean
  • required: true
  • description: Designates whether the objective is closed. Warning: deprecated. Use is_closed instead.

• is_archived

  • type: boolean
  • required: true
  • description: Designates whether the objective is archived

• is_past_due

  • type: boolean
  • required: true
  • description: Designates whether the objective is past due

• is_future

  • type: boolean
  • required: true
  • description: Designates whether the objective's start date is in the future

• visibility

  • type: string
  • required: true
  • description: Objective's visibility; can be one of the following values: 'public', 'report', or 'custom'

• result_count

  • type: integer
  • required: true
  • description: Number of objective's key results

• departments

  • type: array
  • required: true
  • description: Objective's departments

• key_results

  • type: array
  • required: true
  • description: Array of objective's key results, consisting of 'id' (integer), 'description' (string), 'type' (string), 'currency' (string), 'start_value' (integer), 'target_value' (integer), 'current_value' (integer), 'min_value' (integer, deprecated), 'max_value' (integer, deprecated), 'percentage' (integer, deprecated)

• children

  • type: array
  • required: false
  • description: Objective's children

Request Body

The request body should be a "application/json" encoded object, containing the following items.

update

Objective resource - update objectives.

Returns updated 15Five's objectives.

Company-wide API key required.

The request body should be an "application/json" encoded list of objects, containing the following items.

PUT parameters (list)

• id

  • description: Objective's ID
  • required: true
  • type: integer

• color

  • type: string
  • required: false
  • description: Objective's status color; can be one of the following values: 'green', 'yellow', 'red', or 'undefined'

• action

  • description: An action to be performed on the Objective: 'complete', 'deactivate', 'reactivate' or 'delete'
  • required: false
  • type: string

• description

  • description: Objective's description
  • required: true
  • type: string

• start_ts

  • description: Objective's start date
  • required: true
  • type: dateTime

• end_ts

  • description: Objective's end date
  • required: true
  • type: dateTime

• visibility

  • description: Objective's visibility; can be one of the following values: 'public', 'report', or 'custom'. Default: 'public'
  • required: false
  • type: string

• scope

  • description: Objective's scope; can be one of the following values: 'company-wide', 'department', 'individual', 'group-type' or 'self-development'
  • required: true
  • type: string

• user_id

  • description: Objective's owner id
  • required: true
  • type: integer

• parent_id

  • description: Objective's parent objective id
  • required: false
  • type: integer

• is_progress_aligned

  • description: Allow a child objective's progress to impact any aligned parent objectives
  • required: false
  • type: boolean

• tags

  • description: List of tags
  • required: false
  • type: array[string]

• group_id

  • description: Associated group id
  • required: false
  • type: integer

• viewable_by_users

  • description: List of user ids who can view objective
  • required: false
  • type: array[integer]

• viewable_by_groups

  • description: List of group ids who can view objective
  • required: false
  • type: array[integer]

Response (list)

• id

  • type: integer
  • required: true
  • description: Objective's ID

• create_ts

  • type: datetime
  • required: true
  • description: timestamp of the creation

• update_ts

  • type: datetime
  • required: true
  • description: timestamp of the update

• parent

  • type: string
  • required: false
  • description: Objective's parent

• user

  • type: string
  • required: true
  • description: Objective's owner

• user_details

  • type: array
  • required: true
  • id
    • type: int
    • required: true
    • description: user id
  • full_name
    • type: string
    • required: true
    • description: full user name
  • email
    • type: string
    • required: true
    • description: user email

• description

  • type: string
  • required: true
  • description: Objective's description

• scope

  • type: string
  • required: true
  • description: Objective's scope; can be one of the following values: 'company-wide', 'department', 'individual', 'group-type' or 'self-development'

• start_ts

  • type: dateTime
  • required: true
  • description: Objective's start date

• end_ts

  • type: dateTime
  • required: true
  • description: Objective's end date

• color

  • type: string
  • required: true
  • description: Objective's status color; can be one of the following values: 'green', 'yellow', 'red', or 'undefined'

• percentage

  • type: integer
  • required: true
  • description: Objective's composite percentage of completion

• is_active

  • type: boolean
  • required: true
  • description: Designates whether the objective is active

• is_closed

  • type: boolean
  • required: true
  • description: Designates whether the objective is closed

• is_complete

  • type: boolean
  • required: true
  • description: Designates whether the objective is closed. Warning: deprecated. Use is_closed instead.

• is_archived

  • type: boolean
  • required: true
  • description: Designates whether the objective is archived

• is_past_due

  • type: boolean
  • required: true
  • description: Designates whether the objective is past due

• is_future

  • type: boolean
  • required: true
  • description: Designates whether the objective's start date is in the future

• visibility

  • type: string
  • required: true
  • description: Objective's visibility; can be one of the following values: 'public', 'report', or 'custom'

• result_count

  • type: integer
  • required: true
  • description: Number of objective's key results

• departments

  • type: array
  • required: true
  • description: Objective's departments

• key_results

  • type: array
  • required: true
  • description: Array of objective's key results, consisting of 'id' (integer), 'description' (string), 'type' (string), 'currency' (string), 'start_value' (integer), 'target_value' (integer), 'current_value' (integer), 'min_value' (integer, deprecated), 'max_value' (integer, deprecated), 'percentage' (integer, deprecated)

• children

  • type: array
  • required: false
  • description: Objective's children

Query Parameters

The following parameters should be included as part of a URL query string.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

read

Objective resource - get objective object by id.

Returns 15Five's objective object.

Company-wide API key required.

NOTE: Departments are being deprecated. Between November 15, 2019 and January 30, 2020, all accounts with Departments will be migrated to using Groups. This change is being made to allow for more complex account administration. For migrated companies, Groups will be returned for the departments field in the response to allow for backward compatibility.

Response

• id

  • type: integer
  • required: true
  • description: Objective's ID

• create_ts

  • type: datetime
  • required: true
  • description: timestamp of the creation

• update_ts

  • type: datetime
  • required: true
  • description: timestamp of the update

• parent

  • type: string
  • required: false
  • description: Objective's parent

• user

  • type: string
  • required: true
  • description: Objective's owner

• user_details

  • type: array
  • required: true
  • id
    • type: int
    • required: true
    • description: user id
  • full_name
    • type: string
    • required: true
    • description: full user name
  • email
    • type: string
    • required: true
    • description: user email

• description

  • type: string
  • required: true
  • description: Objective's description

• scope

  • type: string
  • required: true
  • description: Objective's scope; can be one of the following values: 'company-wide', 'department', 'individual', 'group-type' or 'self-development'

• start_ts

  • type: dateTime
  • required: true
  • description: Objective's start date

• end_ts

  • type: dateTime
  • required: true
  • description: Objective's end date

• color

  • type: string
  • required: true
  • description: Objective's status color; can be one of the following values: 'green', 'yellow', 'red', or 'undefined'

• percentage

  • type: integer
  • required: true
  • description: Objective's composite percentage of completion

• is_active

  • type: boolean
  • required: true
  • description: Designates whether the objective is active

• is_closed

  • type: boolean
  • required: true
  • description: Designates whether the objective is closed

• is_complete

  • type: boolean
  • required: true
  • description: Designates whether the objective is closed. Warning: deprecated. Use is_closed instead.

• is_archived

  • type: boolean
  • required: true
  • description: Designates whether the objective is archived

• is_past_due

  • type: boolean
  • required: true
  • description: Designates whether the objective is past due

• is_future

  • type: boolean
  • required: true
  • description: Designates whether the objective's start date is in the future

• visibility

  • type: string
  • required: true
  • description: Objective's visibility; can be one of the following values: 'public', 'report', or 'custom'

• result_count

  • type: integer
  • required: true
  • description: Number of objective's key results

• departments

  • type: array
  • required: true
  • description: Objective's departments

• key_results

  • type: array
  • required: true
  • description: Array of objective's key results, consisting of 'id' (integer), 'description' (string), 'type' (string), 'currency' (string), 'start_value' (integer), 'target_value' (integer), 'current_value' (integer), 'min_value' (integer, deprecated), 'max_value' (integer, deprecated), 'percentage' (integer, deprecated)

• children

  • type: array
  • required: false
  • description: Objective's children

Path Parameters

The following parameters should be included in the URL path.

history > list

Query Parameters

The following parameters should be included as part of a URL query string.

history > list_0

Path Parameters

The following parameters should be included in the URL path.

Query Parameters

The following parameters should be included as part of a URL query string.

list

1-on-1 resource - get a list of 1-on-1 objects.

Returns all 1-on-1 object for all users within the company. You can filter the list by created/scheduled/ended date range, user id, type (with anyone/manager-reporter), group id.

Company-wide API key required.

Query parameters

• type

  • description: If Manager-Reporter include only 1-on-1 objects between manager and reporter If Non-Manager-Reporter exclude 1-on-1 objects between manager and reporter

  • required: false

  • type: string

• is_draft

  • description: If true include only draft 1-on-1. If false include only non-draft 1-on-1s.

  • required: false

  • type: boolean

• group_id

  • description: Include only 1-on-1 participated by a members of group with the specified ID.

  • required: false

  • type: integer

• user_id

  • description: Include only 1-on-1 participated by a user with the specified ID.

  • required: false

  • type: integer

• created_on_start

  • description: Only include 1-on-1 objects having creation date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

  • required: false

  • type: date

• created_on_end

  • description: Only include 1-on-1 objects having creation date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

• scheduled_on_start

  • description: Only include 1-on-1 objects having scheduled date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

  • required: false

  • type: date

• scheduled_on_end

  • description: Only include 1-on-1 objects having scheduled date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

• ended_on_start

  • description: Only include 1-on-1 objects having ended date greater than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

  • required: false

  • type: date

• ended_on_end

  • description: Only include 1-on-1 objects having ended date less than or equal to the date time specified in the YYYY-MM-DD HH:MM:SS format.

  • required: false

  • type: date

Response

• id

  • type: integer
  • required: true
  • description: 1-on-1's ID

• user_1

  • type: string
  • required: true
  • description: Link to all user_1 details

• user_1_details

  • type: array
  • required: true
  • id
    • type: int
    • required: true
    • description: User_1 id
  • full_name
    • type: string
    • required: true
    • description: Full user_1 name
  • email
    • type: string
    • required: true
    • description: User_1 email

• user_1_role

  • type: string
  • required: true
  • description: User_1 role (manager or reporter)

• user_2

  • type: string
  • required: true
  • description: Link to all user_2 details

• user_2_details

  • type: array
  • required: true
  • id
    • type: int
    • required: true
    • description: User_2 id
  • full_name
    • type: string
    • required: true
    • description: Full user_2 name
  • email
    • type: string
    • required: true
    • description: User_2 email

• user_2_role

  • type: string
  • required: required
  • description: User_2 role (manager or reporter)

• is_draft

  • type: boolean
  • required: true
  • description: Designates whether the 1-on-1 is draft

• for_date:

  • type: date
  • required: false
  • description: Scheduled date

• end_ts:

  • type: dateTime
  • required: false
  • description: Ended time

• create_ts

  • type: dateTime
  • required: true
  • description: The actual time this 1-on-1 was created

Query Parameters

The following parameters should be included as part of a URL query string.

read

1-on-1 resource - get 1-on-1 object by id.

Returns 1-on-1 object.

Company-wide API key required.

Response

• id

  • type: integer
  • required: true
  • description: 1-on-1's ID

• user_1

  • type: string
  • required: true
  • description: Link to all user_1 details

• user_1_details

  • type: array
  • required: true
  • id
    • type: int
    • required: true
    • description: User_1 id
  • full_name
    • type: string
    • required: true
    • description: Full user_1 name
  • email
    • type: string
    • required: true
    • description: User_1 email

• user_1_role

  • type: string
  • required: true
  • description: User_1 role (manager or reporter)

• user_2

  • type: string
  • required: true
  • description: Link to all user_2 details

• user_2_details

  • type: array
  • required: true
  • id
    • type: int
    • required: true
    • description: User_2 id
  • full_name
    • type: string
    • required: true
    • description: Full user_2 name
  • email
    • type: string
    • required: true
    • description: User_2 email

• user_2_role

  • type: string
  • required: required
  • description: User_2 role (manager or reporter)

• is_draft

  • type: boolean
  • required: true
  • description: Designates whether the 1-on-1 is draft

• for_date:

  • type: date
  • required: false
  • description: Scheduled date

• end_ts:

  • type: dateTime
  • required: false
  • description: Ended time

• create_ts

  • type: dateTime
  • required: true
  • description: The actual time this 1-on-1 was created

Path Parameters

The following parameters should be included in the URL path.

bulk-export > list

Bulk exporting for one-on-ones. (This view is hidden behind a feature flag. Please contact support if you need to use it.)

Company-wide API key required.

Data Returned

In the case of a normal request, a json response will be paginated, and in the case of a request with a ?format=csv query parameter, a csv file will be returned containing all results. This response may take awhile.

• reporter

  • type: string
  • description: Email address of the reporter

• reviewer

  • type: string
  • description: Email address of the reviewer

• start_ts

  • type: timestamp
  • description: Time the one-on-one was created

• end_ts

  • type: timestamp
  • description: Time the one-on-one was ended

• reporter_notes

  • type: string
  • description: Notes the reporter recorded

• reviewer_notes

  • type: string
  • description: Notes the reviewer recorded

• reviewer_private_notes

  • type: string
  • description: private notes the reviewer recorded

• reporter_private_notes

  • type: string
  • description: private notes the reporter recorded

• reporter_private_notes

  • type: string
  • description: private notes the reporter recorded

• action_item_list

  • type: array
  • description: all action items related to this one-on-one

  • values:

  • description

    • type: string
    • description: description of the action item

  • owner

    • type: string
    • description: email of the owner of the action item

  • creator

    • type: string
    • description: email of the creator of the action item

• talking_point_list

  • type: array
  • description: all talking points related to this one-on-one

  • values:

  • description

    • type: string
    • description: description of the talking point

  • owner

    • type: string
    • description: email of the creator of the talking point

Query Parameters

The following parameters should be included as part of a URL query string.

list

Priority resource - get list of priorities.

Returns list of priorities.

Company-wide API key required.

Query parameters

• name: page in: query description: Results page schema: type: integer
• name: order_by in: query description: | Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts". schema: type: string enum: - create_ts - update_ts
• name: created_after in: query description: | Only include users with creation date greater than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'
• name: created_before in: query description: | Only include users with creation date less than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'
• name: updated_after in: query description: | Only include users with updated date greater than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'
• name: updated_before in: query description: | Only include users with updated date less than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• user_id

  • description: Filter priorities by user id.
  • required: false
  • type: integer

• manager_id

  • description: Filter priorities by manager id.
  • required: false
  • type: integer

• group_id

  • description: Filter priorities by group id.
  • required: false
  • type: integer

• include_past_checkins

  • description: Include priorities from the past check-ins or just from current one.
  • required: false
  • type: bool

Response (list)

• id

  • type: integer
  • description: Priority's ID

• user_id

  • type: integer
  • description: User's id

• manager_id

  • type: integer
  • description: Manager's id

• status

  • type: string
  • description: Priority's status (unspecified, completed, not_completed)

• text

  • type: string
  • description: Priority's description

• create_ts

  • type: dateTime
  • description: Priority's creation datetime

• update_ts

  • type: dateTime
  • description: Priority's update datetime

• comments

  • type: array

  • description: Priority's non-private comments

  • user_id

    • type: integer
    • description: user's id

  • comment_text

    • type: string
    • description: text of the comment

  • create_ts

    • type: dateTime
    • description: comment creation datetime

• goal_status_comments

  • type: array

  • description: Priority's non-private goal comments

  • user_id

    • type: integer
    • description: user's id

  • comment_text

    • type: string
    • description: text of the comment

  • create_ts

    • type: dateTime
    • description: comment creation datetime

Query Parameters

The following parameters should be included as part of a URL query string.

create

Priority resource - create priorities.

Returns list of priorities.

Company-wide API key required.

POST parameters (list)

• user_id

  • description: ID of the user for whom the priority will be created
  • required: true
  • type: integer

• text

  • description: Priority's description
  • required: true
  • type: string

Response (list)

• id

  • type: integer
  • description: Priority's ID

• user_id

  • type: integer
  • description: User's ID

• manager_id

  • type: integer
  • description: Manager's ID

• text

  • type: string
  • description: Priority's description

• create_ts

  • type: dateTime
  • description: Priority's creation datetime

• update_ts

  • type: dateTime
  • description: Priority's update datetime

Request Body

The request body should be a "application/json" encoded object, containing the following items.

update

Priority resource - update priorities.

Returns list of priorities.

Company-wide API key required.

PUT parameters (list)

• id

  • description: Priority's id
  • required: true
  • type: integer

• text

  • description: Priority's description
  • required: true
  • type: string

• is_completed

  • description: Mark priority as completed or not completed
  • required: false
  • type: bool

Response (list)

• id

  • type: integer
  • description: Priority's ID

• user_id

  • type: integer
  • description: User's id

• manager_id

  • type: integer
  • description: Manager's id

• status

  • type: string
  • description: Priority's status (unspecified, completed, not_completed)

• text

  • type: string
  • description: Priority's description

• create_ts

  • type: dateTime
  • description: Priority's creation datetime

• update_ts

  • type: dateTime
  • description: Priority's update datetime

Query Parameters

The following parameters should be included as part of a URL query string.

Request Body

The request body should be a "application/json" encoded object, containing the following items.

list

Pulse resource - get a list of pulse values. Useful for creating custom reports.

Returns all 15Five's Pulse values for all users within the company. You can filter the list by report(s), user(s), creation date.

Built-in pagination, with a default limit of 50 objects.

Company-wide API key required.

Query parameters

• name: page in: query description: Results page schema: type: integer
• name: order_by in: query description: | Use to specify ordering. Defaults to "id". Add a "-" before the field name to reverse the order, e.g. "-create_ts". schema: type: string enum: - create_ts - update_ts
• name: created_after in: query description: | Only include users with creation date greater than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'
• name: created_before in: query description: | Only include users with creation date less than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'
• name: updated_after in: query description: | Only include users with updated date greater than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• name: updated_before in: query description: | Only include users with updated date less than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• report_id

  • description: 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

  • required: false

  • type: integer

• user_id

  • description: 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

  • required: false

  • type: integer

• created_on_start

  • description: 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.

  • required: false

  • type: date

• created_on_end

  • description: 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.

  • required: false

  • type: date

Response

• id

  • type: integer
  • required: true
  • description: Pulse's ID

• report

  • type: string
  • required: true
  • description: Report that created this pulse value

• user

  • type: string
  • required: true
  • description: User that gave the answer

• create_ts

  • type: dateTime
  • required: true
  • description: The actual date this answer was saved (submitted) by user

• value

  • type: string
  • required: true
  • description: Pulse's value

Query Parameters

The following parameters should be included as part of a URL query string.

read

Pulse resource - get pulse object by id. Useful for creating custom reports.

Returns 15Five's pulse object.

Company-wide API key required.

Response

• id

  • type: integer
  • required: true
  • description: Pulse's ID

• report

  • type: string
  • required: true
  • description: Report that created this pulse value

• user

  • type: string
  • required: true
  • description: User that gave the answer

• create_ts

  • type: dateTime
  • required: true
  • description: The actual date this answer was saved (submitted) by user

• value

  • type: string
  • required: true
  • description: Pulse's value

Path Parameters

The following parameters should be included in the URL path.

list

Question resource - get a list of questions.

Returns 15Five's questions within the company.

Built-in pagination, with a default limit of 50 objects.

Company-wide API key required.

Query parameters

• name: user_id in: query description: Include only person-specific questions for a user with the specified ID. schema: type: integer

• name: group_id in: query description: Include only group-specific questions for a group with the specified ID. schema: type: integer

• name: page in: query description: Results page schema: type: integer

• name: created_after in: query description: | Only include users with creation date greater than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• name: created_before in: query description: | Only include users with creation date less than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• name: updated_after in: query description: | Only include users with updated date greater than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

• name: updated_before in: query description: | Only include users with updated date less than or equal to the value. schema: type: string pattern: ' YYYY-MM-DD or YYYY-MM-DD HH:MM:SS'

Response

• id

  • type: integer
  • required: true
  • description: Question's ID

• question_text

  • type: string
  • required: true
  • description: Text of the question

• user

  • type: string
  • required: false
  • description: If it's person-specific question - user that this question is for

• group

  • type: string
  • required: false
  • description: If it's group-specific question - group that this question is for

• question_type

  • type: string
  • required: true
  • description: Type of the question. Can be one of the following values: 'multi' (multi-answer question), 'single' (single-answer question), 'number' (metric question) or 'goal' (Priorities question).

• question_frequency

  • type: string
  • required: true
  • description: Frequency of the question. Can be one of the following values: 'weekly', 'biweekly', 'monthly', 'quarterly' or 'other'.

• is_optional

  • type: boolean
  • required: true
  • description: Designates whether the question is optional

• is_active

  • type: boolean
  • required: true
  • description: Designates whether the question is active

• update_ts

  • type: dateTime
  • required: true
  • description: Update datetime

• create_ts

  • type: dateTime
  • required: true
  • description: Create datetime

Query Parameters

The following parameters should be included as part of a URL query string.

read

Question resource - get question object by id.

Returns 15Five's question object.

Company-wide API key required.

Response

• id

  • type: integer
  • required: true
  • description: Question's ID

• question_text

  • type: string
  • required: true
  • description: Text of the question

• user

  • type: string
  • required: false
  • description: If it's person-specific question - user that this question is for

• group

  • type: string
  • required: false
  • description: If it's group-specific question - group that this question is for

• question_type

  • type: string
  • required: true
  • description: Type of the question. Can be one of the following values: 'multi' (multi-answer question), 'single' (single-answer question), 'number' (metric question) or 'goal' (Priorities question).

• question_frequency

  • type: string
  • required: true
  • description: Frequency of the question. Can be one of the following values: 'weekly', 'biweekly', 'monthly', 'quarterly' or 'other'.

• is_optional

  • type: boolean
  • required: true
  • description: Designates whether the question is optional

• is_active

  • type: boolean
  • required: true
  • description: Designates whether the question is active

• metrics_params

  • type: dict
  • required: true

  • description: List of optional parameters about the question metrics

  • min

  • type: string
  • required: false

  • description: Minimum answer range allowed

  • max

  • type: string
  • required: false

  • description: Maximum answer range allowed

  • allow_answer_text

  • type: boolean
  • required: false
  • description: Was answer text allowed with response

Path Parameters

The following parameters should be included in the URL path.

list