List Discard Reasons
GET/external/v1/discard-reasonsReturns the catalog of loss/discard reasons configured in your account. Opportunities reference these via discard_reason_id.
Authentication
Requires discard_reasons:read permission.
Request
bash
curl --request GET \
--url "https://app.getraze.com/external/v1/discard-reasons" \
--header "X-API-Key: YOUR_API_KEY"javascript
const axios = require('axios');
const response = await axios.get('https://app.getraze.com/external/v1/discard-reasons', {
headers: { 'X-API-Key': 'YOUR_API_KEY' }
});
console.log(response.data);python
import requests
response = requests.get(
'https://app.getraze.com/external/v1/discard-reasons',
headers={'X-API-Key': 'YOUR_API_KEY'}
)
print(response.json())Response
json
{
"success": true,
"data": [
{
"id": "dr_01",
"name": "Price",
"description": "Lead found the price too high",
"is_active": true,
"display_order": 0,
"created_at": "2026-01-10T08:00:00Z"
}
]
}Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Discard reason identifier |
name | string | Reason label |
description | string | Optional description (nullable) |
is_active | boolean | Whether the reason is active |
display_order | integer | Ordering of the reason |
created_at | string | ISO 8601 creation timestamp |