# Case Settlement Status

## Filter by case settlement status (integer).

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

#### Query Parameters

| Name                                                              | Type    | Description                                                                      |
| ----------------------------------------------------------------- | ------- | -------------------------------------------------------------------------------- |
| settlement\_agreement\_idpe\_id<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="400: Bad Request No results, key not found, or invalid parameter" %}

```
\\ Examples of:
\\ No results, key not found, or invalid parameter

\\ No results
\\ Example query endpoint: /api/v2/cases/?case_id=1&case_ongoing=1
["No results for {'case_id': '1', 'case_ongoing': '1'}"]

\\ Key not found
\\ Example query endpoint: /api/v2/cases?test_key=1
["API Error: Key: test_key, Value: 1 not found."]

\\ Example query endpoint: /api/v2/cases/?case_id=xyz
["API Error: zxy is not an integer."]
```

{% 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-v2/objects/case/outcome.md#settlement_agreement).

**Example**

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

```
https://clearinghouse.net/api/v2/case?settlement_agreement=5650
```

{% endtab %}

{% tab title="python" %}

```
import requests

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

print(response.text)
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api.clearinghouse.net/api-reference-v2/endpoints/outcome/case-settlement-status.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.