# Returns

> Lead Returns

## Get Returns

`GET https://api.leadspedia.com/core/v2/leads/getReturns.do`

### Parameters

- `fromDate` (date, required)
  Format: `YYYY-MM-DD`.

- `toDate` (date, optional)
  Format: `YYYY-MM-DD`.

- `verticalID` (integer, optional)

- `advertiserID` (integer, optional)

- `contractID` (integer, optional)

- `affiliateID` (integer, optional)

- `campaignID` (integer, optional)

- `status` (enum, optional)
  Allowed values: `Pending`, `Approved`, `Rejected`, `Attempted Contact`, `Researching`.

- `returnReasonID` (integer, optional)

- `start` (integer, optional)
  Offset of the first row to return. Default: `0`.

- `limit` (integer, optional)
  Maximum number of rows to return. Cannot be greater than 1000. Default: `100`.


## Return Lead

`POST https://api.leadspedia.com/core/v2/leads/returnLead.do`

### Parameters

- `leadID` (string, required)

- `contractID` (integer, required)

- `returnReasonID` (integer, required)

- `replaceReturns` (enum, optional)
  Allowed values: `Yes`, `No`.

- `scrub` (enum, optional)
  Allowed values: `Yes`, `No`.


## Return Lead From All Contracts

`POST https://api.leadspedia.com/core/v2/leads/returnLeadFromAllContracts.do`

### Parameters

- `leadID` (string, required)

- `returnReasonID` (integer, required)

- `replaceReturns` (enum, optional)
  Allowed values: `Yes`, `No`.

- `scrub` (enum, optional)
  Allowed values: `Yes`, `No`.


## Unreturn Lead

`POST https://api.leadspedia.com/core/v2/leads/unreturnLead.do`

### Parameters

- `leadID` (string, required)

- `contractID` (integer, required)

- `rejectReasonID` (integer, required)


## Request Return

`POST https://api.leadspedia.com/core/v2/leads/requestReturn.do`

### Parameters

- `leadID` (string, required)

- `contractID` (integer, required)

- `returnReasonID` (integer, required)

- `returnNotes` (string, optional)


## Approve Return Request

`POST https://api.leadspedia.com/core/v2/leads/approveReturn.do`

### Parameters

- `leadID` (string, required)

- `contractID` (integer, required)


## Reject Return Request

`POST https://api.leadspedia.com/core/v2/leads/rejectReturn.do`

### Parameters

- `leadID` (string, required)

- `contractID` (integer, required)

- `rejectReasonID` (integer, required)