API Reference - Cases

Cases are the core objects that store the majority of data throughout the system.  Other objects, such as subjects, cannot exist on their own without a case.

Listing Cases

Returns a collection of case records, optionally filtered by the available request parameters.

GET /api/v1/cases

 

Available Request Parameters:

Name Type Required Description
id integer no ID of the case.
client integer no ID of the root (parent) client the case is assigned to.
location integer no ID of the client location the case is assigned to.
case_region integer no ID of the case region the case is assigned to.
case_status integer no ID of the case status the case currently resides in.
created_from date no Created on or after the date, as determined by the user.  (Alias: From).
created_to date no Created on or before the date, as determined by the user.  (Alias: To).
created_from_system timestamp no Created on or after the date, as determined by the system.
created_to_system timestamp no Created on or before the date, as determined by the system.
due_from date no Due on or after the date.
due_to date no Due on or before the date.
updated_from timestamp no Updated on or after the date.
updated_to timestamp no Updated on or before the date.
is_request boolean no When true, only return case requests.  When false, only return cases.
primary_contact integer no ID of the primary client contact assigned to the case.
primary_investigator integer no ID of the primary investigator assigned to the case.
primary_manager integer no ID of the primary case manager assigned to the case.
primary_salesperson integer no ID of the primary salesperson assigned to the case.
primary_subject integer no ID of the primary subject assigned to the case.
reference_value_1 string no Value of the 1st reference on the case (e.g. a claim number).  The corresponding reference label is defined in the case type configuration.
reference_value_2 string no Value of the 2nd reference on the case (if in use).  The corresponding reference label is defined in the case type configuration.
reference_value_3 string no Value of the 3rd reference on the case (if in use).  The corresponding reference label is defined in the case type configuration.
series_number integer no The series number, as indicated by the case number.  Related/Re-Opened cases will contain the same series number.
series_instance integer no The series instance, as indicated by the case number.  Each time a case is re-opened the series instance is incremented (e.g. 01, 02, 03).
case_number string no The fully formatted Trackops case number, as it appears in your system.

Note: All timestamp parameters are queried and returned in UTC.

Getting a Case

Returns a single case record, based on the numeric ID.

GET /api/v1/cases/{case_id}

Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request