# 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](https://api.clearinghouse.net/api-reference-v2p1/objects/resource "mention")).

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/cases/case\_id/documents/\` 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": null,
      "has_text": false,
      "text_url": ""
    }
  ]
}

```

</details>

For more information:

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