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}

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