---
title: "GET /v1/crm/metrics/referral/history/"
method: GET
path: "/v1/crm/metrics/referral/history/"
tags: ["v1"]
---

# GET /v1/crm/metrics/referral/history/

`GET /v1/crm/metrics/referral/history/`

## Request

- Base URL: `https://api.yume.cloud`
- URL: `https://api.yume.cloud/v1/crm/metrics/referral/history/`
- Auth: HTTP bearer

## Query parameters

- `agent` integer
- `end_at` string, required
- `ordering` string
- `page` integer
- `pageSize` integer
- `request__status` 0 | 1 | 2 | 3 | 4 | 5
- `request__status__in` integer[]
- `search` string
- `start_at` string, required
- `status` 0 | 1

## Response `200`

- PaginatedOrderRequestReferralList
  - `count` integer, required
  - `next` string, uri, nullable
  - `previous` string, uri, nullable
  - `results` OrderRequestReferral[], required
    - `id` integer, required
    - `created_at` string, date-time, required
    - `request` integer, required
    - `agent` integer, nullable
    - `amount` string, decimal
    - `status` 0 | 1, required: * `0` - paid * `1` - pending
    - `status_changed_at` string, date-time, nullable, required
    - `request_status` integer, required

---

[API](https://skmtc.dev/yume-cloud/apis/yume-api.md) - [All operations](https://skmtc.dev/yume-cloud/apis/yume-api/llms.txt) - [OpenAPI document](https://skmtc.dev/yume-cloud/apis/yume-api/revisions/90700f5abfcc?raw)