---
title: "List team referrals"
method: GET
path: "/teams/{team_slug}/referrals"
tags: ["Teams", "Referrals"]
---

# List team referrals

`GET /teams/{team_slug}/referrals`

## Request

- Base URL: `https://api.presscart.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.presscart.com/teams/{team_slug}/referrals`
- Auth: HTTP bearer

Retrieve a list of referrals made by or received by a team.

## Path parameters

- `team_slug` string, required

## Query parameters

- `limit` number, nullable
- `page` number, nullable
- `order_by` 'asc' | 'desc'
- `sort_by` string
- `include_archived` 'true' | 'false'
- `skip_pagination` 'true' | 'false'

## Response `200`

Team referrals retrieved successfully

- object
  - `total_pages` number, required
  - `current_page` number, required
  - `next_page` number, nullable, required
  - `previous_page` number, nullable, required
  - `records` object[], required
    - `id` string, uuid, required
    - `referrer_team_id` string, uuid, nullable, required
    - `referee_team_id` string, uuid, nullable, required
    - `registration_date` union, required
      - string, nullable
      - string
      - unknown
    - `created_at` union, required
      - string, nullable
      - string
      - unknown
    - `updated_at` union, required
      - string, nullable
      - string
      - unknown
    - `deleted_at` union, required
      - string, nullable
      - string
      - unknown
    - `referrer_team` object, nullable, required
      - `id` string, required
      - `name` string, required
    - `referee_team` object, nullable, required
      - `id` string, required
      - `name` string, required
    - `orders` number, nullable, required
    - `commission_earned` number, required
    - `commission_pending` number, required
  - `total_records` number, required
  - `total_commission_earned` number, required

---

[API](https://skmtc.dev/presscart/apis/presscart-prod-api.md) · [All operations](https://skmtc.dev/presscart/apis/presscart-prod-api/llms.txt) · [OpenAPI document](https://skmtc.dev/presscart/apis/presscart-prod-api/revisions/2154581d845e?raw)