Generating your API access token
1. Click on 'Settings' from the left navigation.
2. Then click on 'Features' to expand the feature settings.
3. Last, click on 'Integrations'.
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.
9. 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 email@example.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.
Troubleshooting, Support, and FAQs
Q: Does 15Five support SFTP?
A: No, however, you can post a CSV to our API. This is technically equivalent. https://15five.15five.com/api/public#bulk-user-import-create
Q: When uploading or adding users via API will there be an option to block invite email employees? If so, what does this look like?
A: Yes, you can essentially disable the invite email by not filling out the column 'send_welcome_from'. Simply do not use that column in your CSV file.
Q: What are the API visibility settings?
A: The API key is only accessible in the application to account admins, but those admins can of course choose to give it to someone else on their team to use.
All objectives are fully available via the API and are not masked in any way, regardless of their privacy settings.
Q: When I upload employees through the API they didn't receive an email invitation, why is that?
A: In order to send the email invitation upon upload you need to have the column 'send_email_from' within the CSV file filled in with the email of the person you want to be the inviter. You can use firstname.lastname@example.org if you prefer.
Q: Can we create objects through your API?
A: Unfortunately, this is not an option through the API.
Q: What are the file specs: new users, terminated users?
A: New users will automatically be created if the email is not already in 15Five. In order to terminate users, use the 'is_active' column, and set all applicable fields to "n" for no.
Q: Do I have to create groups in 15Five before using the import 'add_to_groups' or 'active_groups' columns?
A: No. Groups can be pre-created from directly within 15Five OR groups can be created and members added simultaneously through your API. If 15Five recognizes a new group name in the columns 'add_to_groups' or 'active_groups' from your import, these groups will be created upon import.
Q: How do I set up automatic creation of groups?
A: You don’t need to change the CSV file itself. Instead, you should change the permitter for when you send the file. That is found here - https://15five.15five.com/api/public#bulk-user-import-create. There is a flag that says I want to create groups if they do not exist. In pink text under 'Create groups' in the CSV import section. This is a small modification on your end. You will need to have someone who knows how to code to do this.
Q: Do you allow automatic change of group membership when users change departments?
A: We usually recommend using the columns 'add_to_groups' and 'remove_from_groups' to change group membership. This allows 15Five unique groups to stay unaffected by any changes. Please note any changes made in the 'active_group_names' will override any current group settings. (i.e. Leaving the 'active_group_names' field empty for a user will remove them from all groups.)
Q: Can we get an option to cancel imports or view logs for them ourselves?
A: This option is only available for 15Five employees on the backend.
Q: Do we have API call limits?
A: Yes, we do. Currently, we have rate limits per server per IP address. However, we will be working in the future on more accurate rate limits for our Public API.
Q: How can we assign group admin when creating groups via the API?
A: There is no way to pass over a group admin. The field for group admin will be blank in 15Five after API push. After the groups are created in 15Five, you can add a group admins.
Q: I don’t see the updated information once I’ve uploaded the users via Import CSV in the API. Why is this?
A: The process can take between 10 to 20 minutes. For a brief period of time, you might see imported users without the correct reviewers assigned. Reviewers are assigned as next step after importing (creating) users, so after seeing that all users have been imported, please wait a few extra minutes before checking if they have correct reviewers (and smart groups) assigned.
Q: How does the API determine who the “reviewer” is? Is that auto-populated by the “manager” field in UltiPro or other third parties?
A: No. All reviewers have to be included in the API via the 'reviewer_email' field in the CSV.
Q: I have been planning on using only the 'bulk_user_import' for all imports including user updates. Is this recommended? Is there a more recommended way to update users?
A: Our Engineers recommend using User - Update https://15five.15five.com/api/public/#user-update
Q: Can we use the API to send over Vacations that employees put into People HR or other HRIS platforms?
A: Unfortunately, this is not available via the API.
Q: Where can I find the API token?
A: Here you can find information on our API. The very first step on this page covers how you can generate your API access token.
Q: What does it mean if the CSV file being uploaded via the API status is set to “Scheduled”?
A: If the file is getting stuck in scheduled then it means there’s an error. Please share your CSV with us so that we can help assist.
Q: Can I use PowerShell’s (Microsoft) “Invoke-WebRequest” cmdlet to call into 15Five’s POST bulk-user-import web service. How would I be able to do that?
A: From the Microsoft documentation, it should definitely be possible. Here's a script that should be working: $URI, $Headers, and $FilePath parameters should be modified to reflect your needs. The CSV file should NOT contain the UTF byte marker. Document of script Untitled
Q: Where can I find the export.csv so I can know the exact format to use?
A: Within 15Five, there is an example of all column headers and what information we can ingest. Go to your 'Manage people' page and click the 'Import' option.