---
title: "List referral incentives"
method: GET
path: "/api/servicereferral/incentives"
tags: ["incentives"]
---

# List referral incentives

`GET /api/servicereferral/incentives`

## Request

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

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.

## Query parameters

- `filter` object
  - `incentives.latestStatus` 'pending' | 'owed' | 'paid' | 'churned' | 'ineligible': Filter by incentive status
  - `location` string: Filter by applicant location name

## Response `200`

List of incentives successfully retrieved

- object
  - `data` object[], required
    - `uuid` string, uuid, required: Incentive UUID
    - `applicationUuid` string, uuid: UUID of the referral application this incentive belongs to
    - `applicantId` string: Hire applicant ID
    - `status` 'pending' | 'owed' | 'paid' | 'churned' | 'ineligible': Current incentive status
    - `location` string: Applicant location name
    - `referredBy` string: Display name of the referrer worker
    - `referredByLocation` string: Location of the referrer
    - `referredByWorkerUuid` string, uuid: Worker UUID of the referrer
    - `payoutCondition` string: Payout condition type (e.g. daysWorked, applicationStatus)
    - `cashValue` number: Incentive cash value
    - `currency` string: Currency code (e.g. USD)
    - `numberOfDays` number: Number of days required for payout (when applicable)
    - `payoutConditionMetOn` string, date-time, nullable: Timestamp when the payout condition was met
    - `lastUpdatedAt` string, date-time: Last update timestamp
  - `meta` ResponsesPartMeta, required
    - `timestamp` string, date-time, required
    - `verb` 'OPTION' | 'GET' | 'PUT' | 'POST' | 'PATCH' | 'DELETE'
    - `path` string
    - `jti` string
    - `rid` string
    - `count` number
    - `capped` boolean: The server lowered filter[limit] to its ceiling. Page with filter[skip] to read past it.
    - `status` string
    - `duration` number
    - `size` number

---

[API](https://skmtc.dev/fountain/apis/worker-experience-public-api.md) - [All operations](https://skmtc.dev/fountain/apis/worker-experience-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fountain/apis/worker-experience-public-api/revisions/6b9a31f79e22?raw)