> For the complete documentation index, see [llms.txt](https://api.clearinghouse.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api.clearinghouse.net/api-reference-v2p1/endpoints/outcome/case-settlement-status.md).

# Case Settlement Agreement

## Filter by case settlement agreement ID (integer).

<mark style="color:blue;">`GET`</mark> `https://clearinghouse.net/api/v2p1/cases?settlement_agreement=settlement_agreement_id`

#### Query Parameters

| Name                                                    | Type    | Description                                                                      |
| ------------------------------------------------------- | ------- | -------------------------------------------------------------------------------- |
| settlement\_agreement<mark style="color:red;">\*</mark> | integer | Settlement status ID (see list below for list of integers and its mapped values) |

#### Headers

| Name                                            | Type   | Description                                                                                                                    |
| ----------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------ |
| Authorization<mark style="color:red;">\*</mark> | String | <p>Authorization</p><p><code>Token XXXXXXXXXXX</code></p><p>where</p><p><code>XXXXXXXXXXX</code></p><p>is the token string</p> |

{% tabs %}
{% tab title="200 Cases successfully retrieved" %}

{% endtab %}

{% tab title="401 Permission denied" %}

```javascript
{
    "detail":"Authentication credentials were not provided."
}
```

{% endtab %}
{% endtabs %}

Supported settlement status (settlement\_agreement\_id):

| **5647** | Court Approved Settlement or Consent Decree |
| -------- | ------------------------------------------- |
| **5646** | Confession of Judgment                      |
| **5649** | Voluntary Dismissal                         |
| **5648** | Private Settlement Agreement                |
| **5650** | Conditional Dismissal                       |

For more information on these settlement statuses, see [Outcome](/api-reference-v2p1/objects/case/outcome.md#settlement_agreement).

**Example**

{% tabs %}
{% tab title="URL" %}

```
https://clearinghouse.net/api/v2p1/cases?settlement_agreement=5650
```

{% endtab %}

{% tab title="python" %}

```
import requests

url = "https://clearinghouse.net/api/v2p1/cases?settlement_agreement=5650"
headers = { 'Authorization': 'Token XXXXXXXXXX',
'User-Agent': 'Chrome v22.2 Linux Ubuntu'
}
response = requests.request("GET", url, headers=headers, data={})

print(response.text)
```

{% endtab %}
{% endtabs %}