API Reference - Case Contacts

Case contacts are the people who are assigned to cases in various capacities.  Contacts are comprised of both clients and staff and fall into one of the following assignment types:

  • Client Contact
  • Additional Employee
  • Affiliate Contact
  • Case Manager
  • Client Contact
  • Investigator

Note: The terms used for the above assignment types are customizable and may be different based on your configuration.

Listing Case Contacts

Returns a collection of case contact (assignment) records, optionally filtered by the available request parameters.

GET /api/v1/case/contacts

Available Request Parameters:

Name Type Required Description
case integer no ID of the related Case.
assign_type integer no ID of the related Assign Type.
user integer no ID of the related User.
assigned_from timestamp no Assignment is on or after the date.
assigned_to timestamp no Assignment is on or before the date.
case_from date no Case is created on or after the date.
case_to date no Case is created on or before the date.
case_type integer no Case is the specified case type.

Getting a Case Contact

Returns a single case contact (assignment) record, based on the numeric case `case`, `user`, and `assign_type` IDs.

GET /api/v1/case/contacts/{case}/{user}/{assign_type}

 

Creating a Case Contact

Creates a new case contact record for a given case.

POST /api/v1/case/contacts

Available Parameters

Name Type Required Description
casefile_id integer yes ID of the case. API Reference - Cases
user_id integer yes

ID of the client contact or staff.

API Reference - Client Contacts

API Reference - Staff

assign_type_id integer yes See below for available assign types.
is_primary integer no

Indicates if the assignment should be the "primary" assignment for the designated assign type. See below for available assign types.

Available Assign Types

The required assign_type_id field (as shown above) must be the ID from one of the following choices:

Name ID Can Be Primary?
Investigator 1 Yes
Case Manager 3 Yes
Client Contact 4 Yes
Salesperson 5 Yes
Affiliate Contact 2 No
Additional Employee 6 No

Example New Case Contact 

A new case contact is created by POSTing a JSON object to the specified end point using the above criteria.  The JSON object must contain the required fields (as shown above) and must be nested under the update object.  See the following example request:

{
"case_contact": {
"casefile_id": 123,
"user_id": 1,
"assign_type_id": 3,
"is_primary": true
}
}

Note: The above request is for demonstration purposes only, your implementation will require unique data provided by your account.

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