Documents

Get documents.

GET https://clearinghouse.net/api/v2p1/documents/

Returns a paginated list of documents. All parameters are optional and can be combined.

Headers

Name	Type	Description
Authorization*	String	Authorization Token XXXXXXXXXXX where XXXXXXXXXXX is the token string

Query Parameters

Parameter	Type	Description
case_id	Integer	Filter by case ID.
docket_id	Integer	Filter by docket ID.
title	String	Case-insensitive partial match on document title.
is_core_document	Boolean	Filter by core document status. Accepts true or false.
document_type	Integer	Filter by document type ID. See supported values below.
document_status	Integer	Filter by document status ID. See supported values below.
born_digital_status	Integer	Filter by born digital status ID. See supported values below.
text	String	Full-text search across document text, document title, case name, and case summary. See Text Search below.

200 Documents successfully retrieved

400: Bad Request No results, key not found, or invalid parameter

401 Permission denied

Example

URL

https://clearinghouse.net/api/v2p1/documents/?case_id=18003&document_type=5893

python

---

Supported Filter Values

document_type

id	value
5894	Declaration/Affidavit
5908	Discovery Material/FOIA Release
5909	Docket
5905	Complaint
5906	Correspondence
38543	Executive Order
5899	FOIA Request
5910	Findings Letter/Report
5897	Internal memorandum
5895	Justification Memo
5896	Legislative Report
5891	Magistrate Report/Recommendation
5911	Monitor/Expert/Receiver Report
5913	Notice of Investigation or Suit/Demand Letter
5893	Order/Opinion
5914	Other
5915	Pleading / Motion / Brief
5898	Press Release
5900	Settlement Agreement
5892	Statute/Ordinance/Regulation
38762	Statement of Interest (DOJ)
5904	Transcript

document_status

id	value
5923	Approved
5927	Coding Complete
5928	Coding Complete, but not for Public Display
5925	Deleted
5926	Empty/Missing Document
5920	In Process

born_digital_status

id	value
39148	Born digital
39150	Mixed
39149	Scanned

---

Text Search

The text parameter uses PostgreSQL full-text search. It runs across the following fields, in descending order of relevance weight:

Field	Weight
Case name	A (highest)
Document title	B
Case summary	C
Document text	D (lowest)

Queries support natural language stemming (e.g. "running" matches "run"). Multi-word queries require all terms to match (AND logic).

Example

URL

https://clearinghouse.net/api/v2p1/documents/?text=solitary+confinement

python

---

Get a single document by Document ID (integer).

GET https://clearinghouse.net/api/v2p1/documents/ID/

Returns the full document record for the given ID, including document text.

Headers

Name	Type	Description
Authorization*	String	Authorization Token XXXXXXXXXXX where XXXXXXXXXXX is the token string

200 Document successfully retrieved

400: Bad Request No results or invalid parameter

401 Permission denied

Example

URL

https://clearinghouse.net/api/v2p1/documents/136285/

python