🏛️
CRLCA
  • Overview
  • Quick Start
  • Change Log
  • How-To Guides
    • Querying Multiple Fields
    • Translating a Search URL into an API Query
    • Converting JSON to CSV
    • Embedding PDF Documents
  • API Reference
    • Endpoints
      • Case ID
      • Case Ongoing
      • Case Type
      • Special Collection
      • Case State
      • Case Court
      • Case Status
      • Plaintiffs
        • Public Interest Lawyer
        • Filed Pro Se
        • Class Action Sought
        • Class Action Outcome
        • Attorney Organization
        • Plaintiff Type
      • Defendants
        • Defendant Type
        • Defendant Level
        • Facility type
      • Case Details
        • Cause of Action
        • Available Documents
        • Constitutional Clause
        • Special Case Type
      • Outcome
        • Case Settlement Status
        • Case Relief Source
        • Case Relief Nature
        • Case Content of Injunction
        • Case Prevailing Party
      • Document Details
        • Document Type
      • Issues
        • Case Issue
        • Case Custom Issue
    • Objects
      • Case
        • Case Details
        • Causes of Action
        • Outcome
        • Issues
        • Key Dates
        • Parties
        • Dockets and Case Numbers
        • Documents
        • Resources
        • Summaries
        • Case Status
      • Defendant
      • Docket
      • Docket Entry
      • Document
        • Document Details
        • Citations
      • Resource
        • Resource Details
        • Related Items
  • Need Help?
Powered by GitBook
On this page
  1. API Reference
  2. Endpoints
  3. Plaintiffs

Class Action Sought

Filter cases by class action sought status

PreviousFiled Pro SeNextClass Action Outcome

Last updated 2 years ago

Filter by class action sought id (int).

GET https://clearinghouse.net/api/v1/case?class_action_sought=class_action_sought_id

Query Parameters

Name
Type
Description

relief_source_id*

integer

Relief source ID (see list below for list of integers and its mapped values)

Headers

Name
Type
Description

Authorization*

String

Authorization

Token XXXXXXXXXXX

where

XXXXXXXXXXX

is the token string

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

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

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

\\ Example query endpoint: /api/v1/cases/?case_id=xyz
["API Error: zxy is not an integer."]
{
    "detail":"Authentication credentials were not provided."
}

Supported class action sought IDs (class_action_sought_id):

5018

Yes

5019

Unknown

5017

No

For more about class action sought status, see .

Example

https://clearinghouse.net/api/v1/case?class_action_sought=5019
import requests

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

print(response.text)
class_action_sought