API

Want to export your data through our 15Five Public API so you can import this into your own HR system? You can set up tokens through your dashboard.

Generating your API access token

1. Click on your avatar in the upper right-hand corner, then select 'Manage features'.

2. On your left side navigation under 'Features', click on 'Integrations'.

3. Click on 'Configure' to the right of Public API.

4. Click 'Create new key'.

5. Add in a short name for your API key. This name can be anything; usually a name that is easily identifiable from your server side. If you would like to limit the API access to High Fives only, check that box before saving.

6. Click 'Save' to save your name and setting.

7. You will be redirected back to this page to verify your API key and access token.

The Public API key is 32 characters long. Not to be confused with the SCIM key, which is 30 characters long.

The endpoint for your API, assuming you do not have a unique subdomain, is my.15five.com .

8. Use the access token to link 15Five's API to your server.

Features supported by 15Five's API

Be sure to read over the Public API Documentation to see what features in 15Five we support for API.  If you have any issues seeing this list, please reach out to support@15five.com. Below are the options that you can include in your API exports. For example reports of each export, see the  Public API Documentation page. 

answer: 

• list 
  GET /api/public/answer/

  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.

• read 
  GET /api/public/answer/{id}/

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

  Returns 15Five's answer object.

  Company-wide API key required.

bulk-user-import:

• create 
  POST /api/public/bulk-user-import/

  Endpoint for uploading a bulk import file.

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

department:

• list 
  GET /api/public/department/

  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.

• read 
  GET /api/public/department/{id}/

  Department resource - get department object by id.

  Returns 15Five's department object.

  Company-wide API key required.

group:

• list 
  GET /api/public/group/

  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.

• read 
  GET /api/public/group/{id}/

  CompanyGroup resource - get company group object by id.

  Returns 15Five's company group object.

  Company-wide API key required.

hello:

• list 
  GET /api/public/hello/

  Example endpoint for checking connection and api key validity.

  Returns 15Five's server's current timestamp.

  User or company-wide API key required.

high-five:

• list 
  GET /api/public/high-five/

  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), high fives' creation date.

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

  Company-wide API key required.

one-on-one:

• list 
  GET /api/public/one-on-one/

  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.

• read 
  GET /api/public/pulse/{id}/

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

  Returns 15Five's pulse object.

  Company-wide API key required.

objective:

• list 
  GET /api/public/objective/

  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.

• read
  GET /api/public/objective/{id}/

  Objective resource - get objective object by id.

  Returns 15Five's objective object.

  Company-wide API key required.

• history > list 💥💥💥NEW! NEW! NEW!💥💥💥
  GET /api/public/objective/{objective_id}/history/

  URL: /api/public/objective//history/

  Objective history resource - get history of changes for an objective.

  Company-wide API key required.

pulse:

• list
  GET /api/public/pulse/

  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.

• read
  GET /api/public/pulse/{id}/

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

  Returns 15Five's pulse object.

  Company-wide API key required.

question:

• list 
  GET /api/public/question/

  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.

• read 
  GET /api/public/question/{id}/

  Question resource - get question object by id.

  Returns 15Five's question object.

  Company-wide API key required.

report:

• list 
  GET /api/public/report/

  Report resource - get a list of reports.

  Returns all 15Five's reports for all users within the company. You can filter the list by user and/or report's due date range.

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

  Company-wide API key required.

• read 
  GET /api/public/report/{id}/

  Report resource - get report object by id.

  Returns 15Five's report object.

  Company-wide API key required.

security-audit:

• list 
  GET /api/public/security-audit/

  Security audit resource - get a list of security audit events.

  Returns 15Five's security audit events within the company.

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

  Company-wide API key required.

user:

• list 
  GET /api/public/user/

  User resource - get a list of users.

  Returns 15Five's users within the company.

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

  Company-wide API key required.

• read 
  GET /api/public/user/{id}/

  User resource - get user object by id.

  Returns 15Five's user object.

  Company-wide API key required.

• update 
  PUT /api/public/user/{id}/

  User resource - change user object by id.

  Returns 15Five's user object.

  Company-wide API key required.

• change > update 
  PUT /api/public/user/change/{id}/

  User resource - change user object by id.

  Returns 15Five's user object.

  Company-wide API key required.