---
title: "GET /api/app/referrals"
method: GET
path: "/api/app/referrals"
tags: ["Referrals"]
---

# GET /api/app/referrals

`GET /api/app/referrals`

## Request

- Base URL: `https://api.khaasfood.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.khaasfood.com/api/app/referrals`
- Auth: OAuth 2
  - Authorization code: `https://api.khaasfood.com/connect/authorize`
  - Token URL: `https://api.khaasfood.com/connect/token`

## Query parameters

- `FromTime` string, date-time
- `ToTime` string, date-time
- `ReferrerCustomerKeyword` string
- `ReferredCustomerKeyword` string
- `IsOnlySuccessfulReferrals` boolean
- `Sorting` string
- `SkipCount` integer
- `MaxResultCount` integer

## Response `200`

Success

- KhaasFoodReferralsDTOsReferralReportPagedResultWithSummaryDto
  - `result` VoloAbpApplicationDtosPagedResultDto1KhaasFoodReferralsDTOsReferralRelationshipsDataDtoKhaasFoodApplicationContractsVersion1000CultureNeutralPublicKeyTokenNull
    - `items` KhaasFoodReferralsDTOsReferralRelationshipsDataDto[], nullable
      - `creationTime` string, date-time
      - `isSuccessfulReferralRelationship` boolean
      - `referredCustomerId` string, uuid
      - `referredCustomerName` string, nullable
      - `referredCustomerPhone` string, nullable
      - `referredCustomerRewardAmount` number, double
      - `isReferredCustomerRewardUsed` boolean
      - `isReferredCustomerRewardNotUsable` boolean
      - `referrerCustomerId` string, uuid
      - `referrerCustomerName` string, nullable
      - `referrerCustomerPhone` string, nullable
      - `referrerCustomerRewardAmount` number, double
    - `totalCount` integer
  - `summary` KhaasFoodReferralsDTOsReferralRelationshipSummaryDto
    - `totalReferrals` integer
    - `totalSuccessfulReferrals` integer
    - `referredRewardGiven` number, double
    - `referrerRewardGiven` number, double
    - `totalRewardGiven` number, double
    - `referredRewardUsed` number, double
    - `referrerRewardUsed` number, double
    - `totalRewardUsed` number, double

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Server Error
- `501`: Server Error

---

[API](https://skmtc.dev/khaasfood/apis/khaasfood-api.md) - [All operations](https://skmtc.dev/khaasfood/apis/khaasfood-api/llms.txt) - [OpenAPI document](https://skmtc.dev/khaasfood/apis/khaasfood-api/revisions/149b6034bea9?raw)
