---
title: "Show referral program information for a client"
method: GET
path: "/referral_program_information"
tags: ["Referral Program Information"]
---

# Show referral program information for a client

`GET /referral_program_information`

Returns referral program information for a client sent in the request

## Query parameters

- `client_id` integer, required

## Headers

- `X-Subdomain` string

## Response `200`

Shows referral program information for a given client

- ReferralProgramInformation — Statistics and details about the referral program
  - `statistics` object — Aggregated statistics for the referral program
    - `total_referrals` integer
    - `total_referees` integer
    - `total_activated_referrals` integer
    - `total_earned_credit` number, float
    - `total_activated_credit` number, float
  - `referral_bonus` ReferralBonus
    - `id` integer
    - `client_id` integer
    - `coupon_id` integer
    - `created_at` string
    - `updated_at` string
    - `errors` object
    - `code` string
    - `value` number, float
    - `balance` number, float
  - `referral_credit_balance` number, float
  - `credit_used` number, float
  - `credit_refunded` number, float
  - `referrer` ClientReferral — Referrer and their referral details
    - `id` integer
    - `activated_at` string
    - `data_type` string
    - `deleted_at` string
    - `earned_referee_credit` number
    - `earned_referrer_credit` number
    - `non_null_deleted` integer
    - `referee_credit` number
    - `referrer_credit` number
    - `ticket_amount` number
    - `created_at` string
    - `updated_at` string
    - `coupon_id` integer
    - `location_id` integer
    - `pos_ticket_id` integer
    - `referee_id` integer
    - `referrer_id` integer
  - `referral_link` string
  - `referees` ClientReferral[] — List of referees and their referral details
    - `id` integer
    - `activated_at` string
    - `data_type` string
    - `deleted_at` string
    - `earned_referee_credit` number
    - `earned_referrer_credit` number
    - `non_null_deleted` integer
    - `referee_credit` number
    - `referrer_credit` number
    - `ticket_amount` number
    - `created_at` string
    - `updated_at` string
    - `coupon_id` integer
    - `location_id` integer
    - `pos_ticket_id` integer
    - `referee_id` integer
    - `referrer_id` integer
  - `accepted_referees` ClientReferral[] — List of accepted referees and their referral details
    - `id` integer
    - `activated_at` string
    - `data_type` string
    - `deleted_at` string
    - `earned_referee_credit` number
    - `earned_referrer_credit` number
    - `non_null_deleted` integer
    - `referee_credit` number
    - `referrer_credit` number
    - `ticket_amount` number
    - `created_at` string
    - `updated_at` string
    - `coupon_id` integer
    - `location_id` integer
    - `pos_ticket_id` integer
    - `referee_id` integer
    - `referrer_id` integer
  - `pending_referees` ClientReferral[] — List of pending referees and their referral details
    - `id` integer
    - `activated_at` string
    - `data_type` string
    - `deleted_at` string
    - `earned_referee_credit` number
    - `earned_referrer_credit` number
    - `non_null_deleted` integer
    - `referee_credit` number
    - `referrer_credit` number
    - `ticket_amount` number
    - `created_at` string
    - `updated_at` string
    - `coupon_id` integer
    - `location_id` integer
    - `pos_ticket_id` integer
    - `referee_id` integer
    - `referrer_id` integer

## Other responses

- `401` — Unauthorized
- `422` — Invalid parameters
- `500` — Internal Server Error
- `504` — Gateway Timeout

---

[API](https://skmtc.net/mytime/apis/mytime-partners-api.md) · [All operations](https://skmtc.net/mytime/apis/mytime-partners-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mytime/mytime-partners-api/versions/65d3a27fcb1a/schema)