SlapFive API

SlapFive has a powerful Application Programming Interface (API) that includes webhooks, GET and POST endpoints.

Authentication

When making requests to any SlapFive API endpoint, 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 Client Settings, and scroll down to the API Keys section, where you can copy and paste the value that appears, or generate a new one.

Pagination

For using GET endpoints to retrieve more than 1,000 records, SlapFive recommends using pagination to retrieve 1,000 records at a time. To do this, include the limit and the offset parameters as URL parameters like this:

?limit=1000&offset=0

or in the body of the request, like this:

{ "limit": 1000, "offset": 0 }

Created and Last Updated Dates

The SlapFive API GET endpoints all include the Created Date and Last Updated Date for each record in their response output, like this:

{ "createdAt":"2025-03-06T20:27:45.111289+00:00", "updatedAt":"2025-03-06T20:43:45.122277+00:00" }

Get Records based on Last Updated Dates

You can append GET URLs with these two parameters to get records that have been updated within a certain period:

?since=2025-01-01 This gets all records with an updatedAt date since January 1, 2025, or whatever date you insert.

?hoursBack=1000 This gets all records with an updatedAt date within the last 1,000 hours, or whatever hours you insert.

These parameters are enabled for these objects: Activities, Boards, Companies, Members, Page Views, Requests, Request Fulfillment Companies/Members, Request Fulfillment Boards, Shares, and Stories.

Get Specific Fields

You can append GET URLs with the field names of the fields you want returned, rather than return all fields, like this example for pulling Member (customer) fields:

...api/api/customers/?fields=fname,lname,title,email

You can also specify the names of fields from related objects, like this example for pulling Company information for the Members:

...api/api/customers/?fields=fname,lname,title,email,company.name,company.location

Available API endpoints

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/

Get Boards created or changed in 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

Get specific Board and 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>

Webhook for new or changed Board

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when a Board is created/updated ‘webhook_id’: ‘board’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Create or update Board

If a Board record exists for the id provided, it updates that record, otherwise it creates a new record. In either case it returns the id.

Method: POST URL: https://your_company.slapfive.com/api/api/boards/ Required: name Sample JSON request data:

{ “id”:”cjy4vfgam01eq8357xg4uihd3”, “name”:”Customer Success Story for IGM”, “template_id”:”cjy4vfgam01eo0197xg4uihd3”, “headline”:”IGM transforms its customer experience with help from Sandbox”, “tagline”:″Success Story", “body”:”This is a sentence or two of text.”, “customUrl”:”https://sandbox.slapfive.com/b/435gdfw34/IGM”, “ctaHead”:”See Sandbox in Action”, “ctaCopy”:”This is a sentence or two of text.”, “ctaLink”:”https://sandbox.com/demo”, “ctaLinkText”:”Sign up for a demo”, "tags":"Large, Medium", “activityTypeOnView_id”:”cjy4vfgam01eq8357xg4uihd3”, “howToUse”:”This is a sentence or two of text.”, “useAtStages”:”Qualification”, “tokenAccessOnly”:”true”, “tokenAccessForcedExpirationDays”:”2”, “usePreMessage”:”true”, “preMessageText”:”This is a sentence or two of text.″, “preMessageButtonText”:”Agree”, “usePreMessageReceipt”:”true”, "customFieldData" [ "showInSalesforce":"Yes", "showInHighSpot":"No" ] }

Sample JSON output:

{ “board”: { “id”: “cjy4vfgam01eo0197xg4uihd3” } }

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/

Get Stories created or changed in 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

Get 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>

Webhook for new or changed Story

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when a Story is created/updated ‘webhook_id’: ‘story’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Create or update Story

If a Story record exists for the id provided, it updates that record, otherwise it creates a new record. In either case it returns the id.

Method: POST URL: https://your_company.slapfive.com/api/api/boards/ Required: name Sample JSON request data:

{ “id”:”cjy4vfgam01eq8357xg4uihd3”, “customerId”:”cjy4vfgam01eo0197xg4uihd3”, “customerEmail”:”[e-mail]”, “promptId”:”cjy4vfgam01eo0197xg4uihd3”, “type”:″Video", “url”:”https://sandbox.com/asdfsadf”, “label”:”What is your favorite thing about Sandbox?”, “text”:”See Sandbox in Action”, “summary”:”This is sentences of text.”, “transcript”:”This is sentences of text.”, “permission”:””, "reviewStatus":"Released", “source”:”Customer inteview”, “sourceUrl”:””, “tags”:”Qualification”, “language”:”true”, “capturedByUserId”:”cjy4vfgam01eo0197xg4uihd3”, “capturedByUserEmail”:”[e-mail]”, “nextReviewDate”:”2024-06-12 12:00:00″, "dynamicFields.color":"Red" }

Sample JSON output:

{ “story”: { “id”: “cjy4vfgam01eo0197xg4uihd3” } }

Get all Members

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

Get Members created or changed in last XX hours

Method: GET URL: https://your_company.slapfive.com/api/api/customers/?hoursBack=XX

Get a specific Member by ID

Method: GET URL: https://your_company.slapfive.com/api/api/customers/<memberID>

Get a specific Member by Email Address

Method: GET URL: https://your_company.slapfive.com/api/api/customers/<email>

Webhook for new or changed Member

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when a Member is created/updated ‘webhook_id’: ‘member’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Create or update Member

If a Member record exists with the Email or Salesforce Contact ID provided, it updates that record, otherwise it creates a new 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:

{ "email":"[e-mail]", "fname":"Joseph", "lname":"Smith", "companyName":"ABC Industries", "phone":"616.765.6787", "title":"VP of Marketing", "activityTypesWillingToDo":"Speak with an industry analyst, Take a Reference call, Network with peers", "linkedInUrl":"https://www.linkedin.com/in/josephsmith/", "twitterHandle":"@joejoesmitty", "salesforceContactId":"4GH876JhG9765763", "type":"Client", "trustedContacts":"[e-mail], [e-mail]", "activeStatus":"Active", "inviteStatus":"Member", "engagementNote":"This text is added to the bottom of the Engagement Note field", "engagementNoteReplace":"This text replaces what is in the engagementNote field.", "dynamicFields.tshirtsize":"Large", "companyActiveStatus":"Active", "companyProgramStatus":"Member", "companyDescription":"Global Manufacturing company", "companyPermissions": [ "These are the permissions that have been explicitely granted", "Name Drop" ] "companyPermissions_denied": [ "These are the permissions that the company has explicitely denied" ] "companyPermissions_unknown": [ "These are the permissions that have not been explicitely granted or denied" ] "companySize":"100-500 employees", "companyIndustry":"Computer Software", "companyLocation":"Boston, MA", "companySince":"July 2016", "companyProductsOwned":"Product A, Product B, Product C", "companyCompetitorsReplaced":"Competitor X", "companyBusinessGoals":"World Domination and hyper-growth", "companyEngagementNotes": "This text is added to the bottom of the Engagement Notes field", "companyEngagementNotesReplace": "This text replaces what is in the Engagement Notes field", "companySalesforceAccountId":"4GH876JhG9765763", "companyMatchingField1":"Tier 2", "companyMatchingField2":"Manufacturing", "companyMatchingField3":"Any value", "companyDynamicFields.productFamily":"Product Line X" }

Sample JSON output:

{ “customer”: { “id”: “cjy4vfgam01eo0197xg4uihd3” } }

Get all Companies

Method: GET URL: https://your_company.slapfive.com/api/api/companies/ By default, this endpoint gets Companies changed in the last 24 hours. To also get Companies changed more than 24 hours ago, append the URL with /?hoursBack=XX as described in Get Companies That Have Been Created or Changed in the Last XX Hours.

Get a specific Company by ID

Method: GET URL: https://your_company.slapfive.com/api/api/companies/<companyID>

Get Companies created or changed in last XX hours

Method: GET URL: https://your_company.slapfive.com/api/api/companies/?hoursBack=XX

Webhook for new or changed Company

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when a Company is created/updated ‘webhook_id’: ‘company’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Create or update Company

If a Company record exists with the Company Name or Salesforce Account ID provided, it updates that record, otherwise it creates a new 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:

{ "name": "ABC Company", "description": "Large Manufacturing Company", "size": "100 employees", "industry": "Manufacturing", "location": “Houston, TX", "since": "1995", "productsOwned": "Product A", "competitorsReplaced": "Competitor A", "businessGoals": "Make more money", "salesforceAccountId": "456hg45kj64j25332", "matchingField1": "Texas", "matchingField2": "", "matchingField3": "", "engagementNotes": "This text is added to the bottom of the Engagement Notes field", "engagementNotesReplace": "This text replaces whatever is in the Engagement Notes field", "activeStatus": "Active", "programStatus": "Member", "trustedContacts": "[e-mail], [e-mail]", "anonymizedName": "", "permissions": [ "These are the permissions that have been explicitely granted", "Name Drop" ] "permissions_denied": [ "These are the permissions that the company has explicitely denied" ] "permissions_unknown": [ "These are the permissions that have not been explicitely granted or denied", "Name Drop" ] "dynamicFields.productFamily":"Product Line X" }

Sample JSON output:

{ "company": { "id": "cjy4vfgam01eo0197xg4uihd3" } }

Get all Activities

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

Get Activities created or changed in last XX hours

Method: GET URL: https://your_company.slapfive.com/api/api/activityLogs/?hoursBack=XX

Webhook for new or changed Activity

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when an Activity is created/updated ‘webhook_id’: ‘activityLog’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Create Activity

If an Activity History record exists for the id provided, it updates that record, otherwise it creates a new record. In either case it returns the id.

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:

{ “email”:”[e-mail]”, “activityName”:”Speak at a conference”, “date”:”2024-06-12 12:00:00″, “notes”:”Spoke on customer panel at ABC Customer Conference”, }

Sample JSON output:

{ “status”: “ok”, “message”: “added activity type ‘Speak at a conference’ to John Smith” }

Get all Requests

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

Get Requests updated in last XX hours

Method: GET URL: https://your_company.slapfive.com/api/api/requests/?hoursBack=XX

Get Requests fulfilled in last XX hours

Method: GET URL: https://your_company.slapfive.com/api/api/requests/?fulfillmentHoursBack=XX

Get specific Request

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

Webhook for new or changed Request

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when a Request is created/updated ‘webhook_id’: ‘request’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Create or update Request

If a Request record exists for the id provided, it updates that record, otherwise it creates a new record. In either case it returns the id.

Method: POST URL: https://your_company.slapfive.com/api/api/requests/ Required: needDescription, needByDate Sample JSON request data:

{ “id”: “53k3kj6322k45k3224”, “needDescription”: “2 manufacturing customers in EMEA using product X”, “needFor”: “Big Company sales opportunity”, “activityType”: “Take a reference call”, “needByDate”: “2024-04-29”, “requestDate”: “2024-04-20”, “dynamicFields.useCase”: “Supply Chain Optimization”, “requesterEmail”: “[e-mail]”, “requesterName”: “Bill Salesguy”, “team”: “Sales”, “requestStatus”: “Texas”, “fulfillmentDate”: “”, “assignedTo”: “[e-mail]”, “note”: “This is the note field.”, “opportunityId”: “456hg45kj64j25332”, “preferredCustomers”:”IBM, Cisco” }

Sample JSON output:

{ “request”: { “id”: “cjy4vfggds534397xg4uihd3”, "number": "455" } }

Get all Request Fulfillment Members/Companies

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

Get Request Fulfillment Members/Companies for a Request

Method: GET URL: https://your_company.slapfive.com/api/api/requestFulfillmentMembers/<requestID>

Get Request Fulfillment Members/Companies created/changed in last XX hours

Method: GET URL: https://your_company.slapfive.com/api/api/requestFulfillmentMembers/?hoursBack=XX

Get specific Request Fulfillment Member/Company

Method: GET URL: https://your_company.slapfive.com/api/api/requestFulfillmentMembers/<id>

Webhook for new or changed Request Fulfillment Member/Company

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when a Request Fulfillment Member is created/updated ‘webhook_id’: ‘fulfillmentMember’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Create or update Request Fulfillment Member/Company

If a Request Fulfillment Member record exists for the id provided, it updates that record, otherwise it creates a new record. In either case it returns the id.

Method: POST URL: https://your_company.slapfive.com/api/api/requestFulfillmentCustomers/ Required: request_number or request_id; customer_email, customer_id, or customer_salesforceContactId; company_name, company_id, or company_salesforceAccountId;

Sample JSON request data:

{ “id”: “53k3kj6322k45k3224”, “request_Number”: “223”, “request_Id”: “”, “activityType_name”: “Take a reference call”, “needByDate”: “2025-04-29”, "customer_id":"5jjfg834kjjsojeruweg", “customer_email”: “[e-mail]”, “customer_salesforceContactId”: “456hg45kj64j25332”, "company_id":"asdf7sd6fs6adf6asf6", “company_name”: “Big Company”, “company_salesforceAccountId”: “456hg45kj64j25332”, “assignedTo_email”: “[e-mail]”, “statusChange_status”: “Asked”, “statusChange_statusChangeDate”: “2025-04-29”, “note”:“IBM, Cisco” }

Sample JSON output:

{ “requestFulfillmentMember”: { “id”: “cjy4vfggds534397xg4uihd3” } }

Get all Request Fulfillment Boards

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

Get Request Fulfillment Boards for a Request

Method: GET URL: https://your_company.slapfive.com/api/api/requestFulfillmentBoards/<requestID>

Get Request Fulfillment Boards created/changed in last XX hours

Method: GET URL: https://your_company.slapfive.com/api/api/requestFulfillmentBoards/?hoursBack=XX

Get specific Request Fulfillment Board

Method: GET URL: https://your_company.slapfive.com/api/api/requestFulfillmentBoards/<id>

Webhook for new or changed Request Fulfillment Board

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when a Request Fulfillment Board is created/updated ‘webhook_id’: ‘fulfillmentBoard’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Get all Campaigns

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

Get specific Campaign

Method: GET URL: https://your_company.slapfive.com/api/api/campaigns/<id>

Webhook for new or changed Campaign

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when a Campaign is created/updated ‘webhook_id’: ‘campaign’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Get all Campaign Items for a Campaign

Method: GET URL: https://your_company.slapfive.com/api/api/campaigns/<campaignId>/items

Get specific Campaign Item

Method: GET URL: https://your_company.slapfive.com/api/api/campaign-items/<id>

Webhook for new or changed Campaign Item

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when a Request is created/updated ‘webhook_id’: ‘campaignItem’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Get all Content Shares

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

Get specific Content Share

Method: GET URL: https://your_company.slapfive.com/api/api/shares/<id>

Webhook for new Content Share

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when a Request is created/updated ‘webhook_id’: ‘share’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Get all Content Views

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

Get specific Content View

Method: GET URL: https://your_company.slapfive.com/api/api/pageViews/<id>

Webhook for new Content View

Subscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/subscribe

body: { ‘webhook_url’: the URL that the webhook calls when a Request is created/updated ‘webhook_id’: ‘pageView’ }

Unsubscribe:

Method: POST URL: https://slapfive.slapfive.com/api/webhooks/unsubscribe

body: { ‘webhook_url’: the URL that was subscribed }

Send a Prompt

Method: POST URL: https://your_company.slapfive.com/api/api/sendPrompt

Required parameters: customerId, promptId or promptGroupId Optional parameters: customGreeting, customSubject

Get Client Settings

Use this endpoint to retrieve Activity Types & Scores, Dynamic Fields, and other Client Settings.

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