FOfountain
incentives

List referral incentives

Returns referral incentive records for the authenticated company. Each record represents a single incentive tied to a referral application. Filterable by incentive status and location.

get/api/servicereferral/incentives

Request

  • Base URL
    https://services.fountain.com
  • URL
    https://services.fountain.com/api/servicereferral/incentives
  • Auth
    HTTP bearer

Query parameters

incentives.latestStatus'pending' | 'owed' | 'paid' | 'churned' | 'ineligible'

Filter by incentive status

locationstring

Filter by applicant location name

Response

List of incentives successfully retrieved

Example response

{
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.