# Case

Each endpoint returns a list of cases, where each case is a JSON dictionary.

Because cases in the Clearinghouse are being added and updated all the time, the `case_status` of a case is useful for understanding why some fields might be empty. For more information on the different statuses, see [Case Status](/api-reference-v2p1/objects/case/case-status.md#case_status).

<details>

<summary>Example: a completely blank case</summary>

```javascript
{
  "count": 0,
  "next": null,
  "previous": null,
  "results": [
    {
      "attorney_orgs": [],
      "available_documents": [],
      "case_defendants": [],
      "case_ongoing": "",
      "case_status": "",
      "case_types": [],
      "cause_other": "",
      "causes": [],
      "class_action_granted": "",
      "class_action_sought": "",
      "closing_year": null,
      "constitutional_clause": [],
      "content_of_injunction": [
        {
          "value": ""
        },
      ],
      "court": "",
      "custom_issues": [],
      "defendant_payment": "",
      "defendant_type": [
        {
          "value": ""
        }],
      "docket_status": "",
      "facility_type": [],
      "filing_date": "",
      "filing_year": null,
      "id": 0,
      "injunction_duration": "",
      "issues": [],
      "last_checked_date": "",
      "main_docket": {
        "id": 0,
        "docket_entries": [
          {
            "row_number": null,
            "id": 0,
            "entry_number": "",
            "date_filed": "",
            "attachments": [],
            "url": "",
            "recap_pdf_url": null,
            "pacer_doc_id": "",
            "description": ""
          }
        ],
        "docket_case_type": "",
        "docket_year": null,
        "docket_filing_number": null,
        "is_main_docket": true,
        "court": "",
        "state": "",
        "docket_office_number": "",
        "docket_number_manual": "",
        "scales_html": "",
        "recap_link": "",
        "is_active": true
      },
      "name": "",
      "never_filed": false,
      "non_docket_case_number": "",
      "non_docket_case_number_type": "",
      "non_docket_case_number_type_other": "",
      "order_end_year": null,
      "order_start_year": null,
      "permanent_injunction": false,
      "plaintiff_description": "",
      "plaintiff_type": [
        {
          "value": ""
        }],
      "prevailing_party": "",
      "pro_se_status": "",
      "public_interest_lawyer": "",
      "related_cases": [],
      "relief_natures": [],
      "relief_nature_other": "",
      "relief_sources": [],
      "settlement_agreement": [],
      "settlement_judgment_date": "",
      "settlement_judgment_year": null,
      "special_collections": [],
      "special_case_type": [],
      "state": "",
      "summary": "",
      "summary_published_date": "",
      "summary_short": "",
      "summary_tiny": null,
      "terminating_date": null,
      "clearinghouse_link": "",
      "is_active": true,
      "case_documents_url": "",
      "case_dockets_url": "",
      "case_resources_url": ""
    }
  ]
}
```

</details>

For more information:

| Field                                  | Type           | Documentation (link)                                                                                                                                                                                                                                                 |
| -------------------------------------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| attorney\_orgs                         | array\[string] | [Parties](/api-reference-v2p1/objects/case/parties.md#attorney_orgs)                                                                                                                                                                                                 |
| available\_documents                   | array\[string] | [Documents](/api-reference-v2p1/objects/case/documents.md#available_documents)                                                                                                                                                                                       |
| case\_defendants                       | array\[object] | [Parties](/api-reference-v2p1/objects/case/parties.md#case_defendants)                                                                                                                                                                                               |
| case\_ongoing                          | string         | [Case Details](/api-reference-v2p1/objects/case/case-details.md#case_ongoing)                                                                                                                                                                                        |
| case\_status                           | string         | [Case Status](/api-reference-v2p1/objects/case/case-status.md#case_status)                                                                                                                                                                                           |
| case\_types                            | array\[string] | [Case Details](/api-reference-v2p1/objects/case/case-details.md#case_types)                                                                                                                                                                                          |
| cause\_other                           | string         | [Causes of Action](/api-reference-v2p1/objects/case/causes-of-action.md#cause_other)                                                                                                                                                                                 |
| causes                                 | array\[string] | [Causes of Action](/api-reference-v2p1/objects/case/causes-of-action.md#causes)                                                                                                                                                                                      |
| class\_action\_granted                 | string         | [Parties](/api-reference-v2p1/objects/case/parties.md#class_action_granted)                                                                                                                                                                                          |
| class\_action\_sought                  | string         | [Parties](/api-reference-v2p1/objects/case/parties.md#class_action_sought)                                                                                                                                                                                           |
| closing\_year                          | number         | [Key Dates](/api-reference-v2p1/objects/case/key-dates.md#closing_year)                                                                                                                                                                                              |
| court                                  | string         | [Case Details](/api-reference-v2p1/objects/case/case-details.md#court)                                                                                                                                                                                               |
| custom\_issues                         | array\[string] | [Issues](/api-reference-v2p1/objects/case/issues.md#custom_issues)                                                                                                                                                                                                   |
| defendant\_payment                     | string         | [Outcome](/api-reference-v2p1/objects/case/outcome.md#defendant_payment)                                                                                                                                                                                             |
| docket\_status                         | string         | [Case Status](/api-reference-v2p1/objects/case/case-status.md#docket_status)                                                                                                                                                                                         |
| filing\_date                           | string         | [Key Dates](/api-reference-v2p1/objects/case/key-dates.md#filing_date)                                                                                                                                                                                               |
| filing\_year                           | number         | [Key Dates](/api-reference-v2p1/objects/case/key-dates.md#filing_year)                                                                                                                                                                                               |
| id                                     | number         | [Case Details](/api-reference-v2p1/objects/case/case-details.md#id)                                                                                                                                                                                                  |
| injunction\_duration                   | string         | [Key Dates](/api-reference-v2p1/objects/case/key-dates.md#injunction_duration)                                                                                                                                                                                       |
| issues                                 | array\[string] | [Issues](/api-reference-v2p1/objects/case/issues.md#issues)                                                                                                                                                                                                          |
| last\_checked\_date                    | string         | [Case Status](/api-reference-v2p1/objects/case/case-status.md#last_checked_date)                                                                                                                                                                                     |
| name                                   | string         | [Case Details](/api-reference-v2p1/objects/case/case-details.md#name)                                                                                                                                                                                                |
| never\_filed                           | boolean        | [Key Dates](/api-reference-v2p1/objects/case/key-dates.md#never_filed)                                                                                                                                                                                               |
| non\_docket\_case\_number              | string         | [Dockets and Case Numbers](/api-reference-v2p1/objects/case/dockets.md#non_docket_case_number)                                                                                                                                                                       |
| non\_docket\_case\_number\_type        | string         | [Dockets and Case Numbers](/api-reference-v2p1/objects/case/dockets.md#non_docket_case_number_type)                                                                                                                                                                  |
| non\_docket\_case\_number\_type\_other | string         | [Dockets and Case Numbers](/api-reference-v2p1/objects/case/dockets.md#non_docket_case_number_type_other)                                                                                                                                                            |
| order\_end\_year                       | number         | [Key Dates](/api-reference-v2p1/objects/case/key-dates.md#order_end_year)                                                                                                                                                                                            |
| order\_start\_year                     | number         | [Key Dates](/api-reference-v2p1/objects/case/key-dates.md#order_start_year)                                                                                                                                                                                          |
| permanent\_injunction                  | boolean        | [Key Dates](/api-reference-v2p1/objects/case/key-dates.md#permanent_injunction)                                                                                                                                                                                      |
| plaintiff\_description                 | string         | [Parties](/api-reference-v2p1/objects/case/parties.md#plaintiff_description)                                                                                                                                                                                         |
| prevailing\_party                      | string         | [Outcome](/api-reference-v2p1/objects/case/outcome.md#prevailing_party)                                                                                                                                                                                              |
| pro\_se\_status                        | string         | [Parties](/api-reference-v2p1/objects/case/parties.md#pro_se_status)                                                                                                                                                                                                 |
| public\_interest\_lawyer               | string         | [Parties](/api-reference-v2p1/objects/case/parties.md#public_interest_lawyer)                                                                                                                                                                                        |
| relief\_natures                        | array\[string] | [Outcome](/api-reference-v2p1/objects/case/outcome.md#relief_natures)                                                                                                                                                                                                |
| relief\_nature\_other                  | string         | [Outcome](/api-reference-v2p1/objects/case/outcome.md#relief_nature_other)                                                                                                                                                                                           |
| relief\_sources                        | array\[string] | [Outcome](/api-reference-v2p1/objects/case/outcome.md#relief_sources)                                                                                                                                                                                                |
| settlement\_agreement                  | array\[string] | [Outcome](/api-reference-v2p1/objects/case/outcome.md#settlement_agreement)                                                                                                                                                                                          |
| settlement\_judgment\_date             | string         | [Key Dates](/api-reference-v2p1/objects/case/key-dates.md#settlement_judgment_date)                                                                                                                                                                                  |
| settlement\_judgment\_year             | number         | [Key Dates](/api-reference-v2p1/objects/case/key-dates.md#settlement_judgment_year)                                                                                                                                                                                  |
| special\_collections                   | array\[string] | [Case Details](/api-reference-v2p1/objects/case/case-details.md#special_collections)                                                                                                                                                                                 |
| state                                  | string         | [Case Details](/api-reference-v2p1/objects/case/case-details.md#state)                                                                                                                                                                                               |
| summary                                | string         | [Summaries](/api-reference-v2p1/objects/case/summaries.md#summary)                                                                                                                                                                                                   |
| summary\_published\_date               | string         | [Summaries](/api-reference-v2p1/objects/case/summaries.md#summary_published_date)                                                                                                                                                                                    |
| summary\_short                         | string         | [Summaries](/api-reference-v2p1/objects/case/summaries.md#summary_short)                                                                                                                                                                                             |
| summary\_tiny                          | string         | [Summaries](/api-reference-v2p1/objects/case/summaries.md#summary_tiny)                                                                                                                                                                                              |
| terminating\_date                      | string         | [Key Dates](/api-reference-v2p1/objects/case/key-dates.md#terminating_date)                                                                                                                                                                                          |
| clearinghouse\_link                    | string         | [Case Details](/api-reference-v2p1/objects/case/case-details.md#clearinghouse_link)                                                                                                                                                                                  |
| is\_active                             | boolean        | [Case Status](/api-reference-v2p1/objects/case/case-status.md#is_active)                                                                                                                                                                                             |
| plaintiff\_type                        | array\[string] | [Issues](/api-reference-v2p1/objects/case/issues.md#plaintiff_type)                                                                                                                                                                                                  |
| defendant\_type                        | array\[string] | [Issues](/api-reference-v2p1/objects/case/issues.md#defendant_type)                                                                                                                                                                                                  |
| facility\_type                         | array\[string] | [Issues](/api-reference-v2p1/objects/case/issues.md#facility_type)                                                                                                                                                                                                   |
| constitutional\_clause                 | array\[string] | [Issues](/api-reference-v2p1/objects/case/issues.md#constitutional_clause)                                                                                                                                                                                           |
| special\_case\_type                    | array\[string] | [Issues](/api-reference-v2p1/objects/case/issues.md#special_case_type)                                                                                                                                                                                               |
| content\_of\_injunction                | array\[string] | [Issues](/api-reference-v2p1/objects/case/issues.md#content_of_injunction)                                                                                                                                                                                           |
| case\_documents\_url                   | array\[string] | [https://github.com/CRClearinghouse/CRLCA/blob/master/api-reference-v2p1/objects/case/pagination-urls.md#case\_documents\_url](https://github.com/CRClearinghouse/CRLCA/blob/master/api-reference-v2p1/objects/case/pagination-urls.md#case_documents_url "mention") |
| case\_dockets\_url                     | array\[string] | [https://github.com/CRClearinghouse/CRLCA/blob/master/api-reference-v2p1/objects/case/pagination-urls.md#case\_dockets\_url](https://github.com/CRClearinghouse/CRLCA/blob/master/api-reference-v2p1/objects/case/pagination-urls.md#case_dockets_url "mention")     |
| case\_resources\_url                   | array\[string] | [https://github.com/CRClearinghouse/CRLCA/blob/master/api-reference-v2p1/objects/case/pagination-urls.md#case\_resources\_url](https://github.com/CRClearinghouse/CRLCA/blob/master/api-reference-v2p1/objects/case/pagination-urls.md#case_resources_url "mention") |


---

# 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-v2p1/objects/case.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.
