GET v1/cases
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| CaseId | integer |
None. |
|
| EntityId | integer |
None. |
|
| CaseNumber | string |
None. |
|
| Jurisdiction | Jurisdiction_Id |
None. |
|
| CaseType | CaseType_Id |
None. |
|
| CaseTypeId | integer |
None. |
|
| CaseStatusType | Case_Status |
None. |
|
| CaseStateId | integer |
None. |
|
| CaseStateIds | Collection of integer |
None. |
|
| FromFiledOnDate | string |
None. |
|
| EndFiledOnDate | string |
None. |
|
| CaseChapterType | BankruptcyCase_Chapter |
None. |
|
| FromCreatedOnDate | string |
None. |
|
| EndCreatedOnDate | string |
None. |
|
| CaseCreatedByUserId | integer |
None. |
|
| CasePartiesId | integer |
None. |
|
| JurisdictionIds | Collection of integer |
None. |
|
| CaseTypes | Collection of integer |
None. |
|
| CaseStatusTypes | Collection of integer |
None. |
|
| CaseChapterTypes | Collection of integer |
None. |
|
| SelectedMattersPeriod | MattersFilter |
None. |
|
| EventHistoryType | CaseEventHistory_Type |
None. |
|
| FilingType | FormFile_Type |
None. |
|
| LatestOnly | boolean |
None. |
|
| IsBusiness | boolean |
None. |
|
| TaxId | string |
None. |
|
| Address | string |
None. |
|
| Zip | string |
None. |
|
| string |
None. |
||
| Phone | string |
None. |
|
| IncludeRoles | boolean |
None. |
|
| IncludeDetails | boolean |
None. |
|
| IncludeActive | boolean |
None. |
|
| IncludeInactive | boolean |
None. |
|
| IncludeDeleted | boolean |
None. |
|
| ForManagement | boolean |
None. |
|
| IncludeInactiveOnly | boolean |
None. |
|
| IncludeFilingAttorney | boolean |
None. |
|
| IncludeCaseManager | boolean |
None. |
|
| IncludeAssociatedInvoiceStatus | boolean |
None. |
|
| IncludeUrgentIssues | boolean |
None. |
|
| ForExport | boolean |
None. |
|
| IncludePhone | boolean |
None. |
|
| IncludeLastPaymentDate | boolean |
None. |
|
| LastPaymentBefore | string |
None. |
|
| columns | Collection of Column |
None. |
|
| order | Collection of SearchOrder |
None. |
|
| searchColumns | Collection of Column |
None. |
|
| search | RegExSearch |
None. |
|
| draw | integer |
None. |
|
| start | integer |
None. |
|
| length | integer |
None. |
|
| searchTerm | string |
None. |
|
| term | string |
None. |
|
| sortBy | string |
None. |
|
| sortDirection | string |
None. |
|
| ClientEntityId | integer |
None. |
|
| ForHost | boolean |
None. |
|
| ForSearch | boolean |
None. |
|
| ForSearchList | boolean |
None. |
|
| UseAzureSearch | boolean |
None. |
|
| VendorId | string |
None. |
|
| VendorType | Vendor_Type |
None. |
|
| IsExternal | boolean |
None. |
|
| IncludeExternal | boolean |
None. |
|
| IncludeExternalOnly | boolean |
None. |
|
| ExportToCSV | boolean |
None. |
|
| SearchTermConditionOption | SearchTermCondition_Option |
None. |
|
| SearchTermFilterType | SearchFilter_Type |
None. |
Body Parameters
None.
Response Information
Resource Description
SearchResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Draw | integer |
None. |
|
| RecordsTotal | integer |
None. |
|
| RecordsFiltered | integer |
None. |
|
| Data | Object |
None. |
|
| NextPageUrl | string |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.