Use SlapFive API to integrate with other apps

You’ve captured all this great customer voice content in SlapFive, now you want to integrate with other applications to pass content into SlapFive, pull SlapFive content out, or trigger workflows. We’ve got you covered. SlapFive has a set of simple but powerful APIs that enable this integration with just about any app you can think of. This article gives you some ideas for the types of integration use cases that are possible, and explains how to use the APIs.

Ideas for what you can do with these API endpoints

  • Your website developers can access SlapFive customer voice content and have total control over how it is presented on your site.
  • You can export your Stories and Boards to a spreadsheet.
  • You can create front-end forms that your customers can use to join your Customer Voice program and have that form data create new Customer records in SlapFive.
  • You can synchronize customer records between SlapFive and your marketing automation platform or CRM.
  • You can work with SaaS integration platforms like Zapier to build triggers and actions.

Authentication

When making requests to any SlapFive API, you must include “api-authorization” as a key in the HTTP header, with your API Key as the value. To find or generate your API Key, go to your Admin menu and click the “(Your Company Name) Client Settings” menu, and scroll down to the API Keys section, where you can copy and paste the value that appears, or generate a new one.

Available APIs

Get All Boards
Get Boards That Have Been Created or Changed in the Last XX Hours
Get a Specific Board and All its Stories
Get All Stories
Get Stories That Have Been Created or Changed in the Last XX Hours
Get a Specific Story
Get All Members
Get Members That Have Been Created or Changed in the Last XX Hours
Create or Update a Member
Get All Companies
Get All Companies That Have Been Created or Changed in the Last XX Hours
Create or Update a Company
Get All Activities
Get Activities That Have Been Created or Changed in the Last XX Hours
Create an Activity
Get All Requests
Get All Requests That Have Been Fulfilled in the Last XX Hours

Get All Boards

This API returns all Boards in an array, with the Board Name and Board ID.

Method: GET
URL: https://your_company.slapfive.com/api/api/boards/
Sample JSON output:

Get Boards That Have Been Created or Changed in the Last XX Hours

This returns Boards that have been created or changed within the specified number of hours.

Method: GET
URL: https://your_company.slapfive.com/api/api/boards/?hoursBack=XX
Sample JSON output: same as above

Get a Specific Board and All its Stories

This API accepts a Board ID as parameter and returns that Board along with all the Stories on that Board. The Stories are returned with all the data about the Customer who contributed the Story.

Method: GET
URL: https://your_company.slapfive.com/api/api/boards/<boardID>
Sample JSON output:

Get All Stories

This API returns all Stories, in an array, with all the information from the Story and the Customer who contributed the Story.

Method: GET
URL: https://your_company.slapfive.com/api/api/stories/
Sample JSON output:

Get Stories That Have Been Created or Changed in the Last XX Hours

This API returns Stories that have been created or changed within the specified number of hours.

Method: GET
URL: https://your_company.slapfive.com/api/api/stories/?hoursBack=XX
Sample JSON output: same as above

Get a Specific Story

This API accepts a Story ID as parameter and returns that Story with all the data about the Customer who contributed the Story.

Method: GET
URL: https://your_company.slapfive.com/api/api/stories/<storyID>
Sample JSON output:

Get All Members

Method: GET
URL: https://your_company.slapfive.com/api/api/customers/
Sample JSON output:

Get Members That Have Been Created or Changed in the Last XX Hours

Method: GET
URL: https://your_company.slapfive.com/api/api/customers/?hoursBack=XX
Sample JSON output: same as above

Create or Update a Member

If a Member record doesn’t exist for the email address provided, it creates a new Member. If a Member does already exist, it updates the Member record. In either case it returns the Customer ID.

Method: POST
URL: https://your_company.slapfive.com/api/api/customers/
Required for updating a Member: email
Required for creating new Member: email, fname, lname, companyName

Sample JSON request data:

Sample JSON output:

Get All Companies

Method: GET
URL: https://your_company.slapfive.com/api/api/companies/
Sample JSON output:

Get Companies That Have Been Created or Changed in the Last XX Hours

Method: GET
URL: https://your_company.slapfive.com/api/api/companies/?hoursBack=XX
Sample JSON output: same as above

Create or Update a Company

If a Company record doesn’t exist for the Company Name provided, it creates a new Company. If a Company does already exist, it updates the Company record. In either case it returns the Company ID.

Method: POST
URL: https://your_company.slapfive.com/api/api/companies/
Required for updating a Company: name
Required for creating new Member: name

Sample JSON request data:

Sample JSON output:

Get All Activities

Method: GET
URL: https://your_company.slapfive.com/api/api/activityLogs/

Sample JSON output:

Get Activities that Have Been Created or Changed in the Last XX Hours

Method: GET
URL: https://your_company.slapfive.com/api/api/activityLogs/?hoursBack=XX
Sample JSON output: same as above

Create an Activity

Method: POST
URL: https://your_company.slapfive.com/api/api/activity/
Required for creating new Activity: email, activityName, date
Optional: notes

Sample JSON request data:

Sample JSON output:

Get All Requests

Method: GET
URL: https://your_company.slapfive.com/api/api/requests/

Sample JSON output:

Get Requests That Have Been Fulfilled in the Last XX Hours

Method: GET
URL: https://your_company.slapfive.com/api/api/requests/?fulfillmentHoursBack=XX
Sample JSON output: same as above

We use cookies to analyze traffic and improve your experience. Just wanted to let you know! Learn more about cookies and similar technologies hereClick here to opt-out.
}(jQuery));