> 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-v2/objects/document.md).

# Document

A case will contain many more documents than are uploaded to the Clearinghouse. We generally add documents that provide additional information that help someone understand what is going on in the case, such as complaints, opinions, orders, and settlement agreements. We also add documents that we find particularly interesting, such as letters between lawyers about how to litigate the case. Particularly interesting documents that apply more broadly, such as memoranda explaining a complex litigation strategy involving multiple cases, are uploaded as resources (see [Resource](/api-reference-v2/objects/resource.md)).

Each document url endpoint returns a list of documents, where each document is a JSON dictionary.

<details>

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

When accessing the \`api/v2p1/documents/?case=case\_id\` endpoint.

```javascript
{
  "next": null,
  "previous": null,
  "results": [
    {
      "id": null,
      "title": "",
      "no_title": false,
      "description": "",
      "public_note": "",
      "date": "",
      "date_is_estimate": false,
      "date_not_available": false,
      "document_type": "",
      "document_type_other": null,
      "document_status": "",
      "document_source": null,
      "order_type": null,
      "is_core_document": false,
      "court": "",
      "citation_paren": null,
      "citation_status": null,
      "cite_1_vol": null,
      "cite_1_reporter": null,
      "cite_1_page": null,
      "cite_2_vol": null,
      "cite_2_reporter": null,
      "cite_2_page": null,
      "cite_3_vol": null,
      "cite_3_reporter": null,
      "cite_3_page": null,
      "party_types": [],
      "per_curium": false,
      "ecf_number": "",
      "external_url": "",
      "clearinghouse_link": "",
      "file": "",
      "has_text": false,
      "text_url": ""
    }
  ]
}

```

</details>

For more information:

| Field                 | Type           | Documentation (link)                                                                           |
| --------------------- | -------------- | ---------------------------------------------------------------------------------------------- |
| date                  | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#date)                |
| date\_is\_estimate    | boolean        | [Document Details](/api-reference-v2/objects/document/document-details.md#date_is_estimate)    |
| date\_not\_available  | boolean        | [Document Details](/api-reference-v2/objects/document/document-details.md#date_not_available)  |
| description           | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#description)         |
| document\_source      | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#document_source)     |
| document\_type        | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#document_type)       |
| order\_type           | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#order_type)          |
| citation\_paren       | string         | [Citations](/api-reference-v2/objects/document/citations.md#citation_paren)                    |
| cite\_1\_page         | number         | [Citations](/api-reference-v2/objects/document/citations.md#cite_1_page)                       |
| cite\_1\_reporter     | string         | [Citations](/api-reference-v2/objects/document/citations.md#cite_1_reporter)                   |
| cite\_1\_vol          | number         | [Citations](/api-reference-v2/objects/document/citations.md#cite_1_vol)                        |
| cite\_2\_page         | number         | [Citations](/api-reference-v2/objects/document/citations.md#cite_2_page)                       |
| cite\_2\_reporter     | string         | [Citations](/api-reference-v2/objects/document/citations.md#cite_2_reporter)                   |
| cite\_2\_vol          | number         | [Citations](/api-reference-v2/objects/document/citations.md#cite_2_vol)                        |
| cite\_3\_page         | number         | [Citations](/api-reference-v2/objects/document/citations.md#cite_3_page)                       |
| cite\_3\_reporter     | string         | [Citations](/api-reference-v2/objects/document/citations.md#cite_3_reporter)                   |
| cite\_3\_vol          | number         | [Citations](/api-reference-v2/objects/document/citations.md#cite_3_vol)                        |
| citation\_status      | string         | [Citations](/api-reference-v2/objects/document/citations.md#citation_status)                   |
| court                 | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#court)               |
| no\_title             | boolean        | [Document Details](/api-reference-v2/objects/document/document-details.md#no_title)            |
| party\_types          | array\[string] | [Document Details](/api-reference-v2/objects/document/document-details.md#party_types)         |
| per\_curium           | boolean        | [Citations](/api-reference-v2/objects/document/citations.md#per_curium)                        |
| is\_core\_document    | boolean        | [Document Details](/api-reference-v2/objects/document/document-details.md#is_core_document)    |
| file                  | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#file)                |
| title                 | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#title)               |
| public\_note          | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#public_note)         |
| document\_type\_other | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#document_type_other) |
| external\_url         | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#external_url)        |
| ecf\_number           | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#ecf_number)          |
| clearinghouse\_link   | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#clearinghouse_link)  |
| id                    | number         | [Document Details](/api-reference-v2/objects/document/document-details.md#id)                  |
| document\_status      | string         | [Document Details](/api-reference-v2/objects/document/document-details.md#document_status)     |
| has\_text             | boolean        | [Document Details](/api-reference-v2p1/objects/document/document-details.md#has_text)          |
| text\_url             | string         | [Document Details](/api-reference-v2p1/objects/document/document-details.md#text_url)          |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://api.clearinghouse.net/api-reference-v2/objects/document.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.