Retrieve Case Relationships

get

https://example.com/case_relationships/

Returns a list of Case Relationships applicable to the scope of the API auth token

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

case

integer

Filter via case ID. Must supply integer value, cannot search by case name or other field information.

order_by

string

Order results by a field name. Prefix with - for descending order. eg. order_by=mod_date for ascending or order_by=-mod_date for descending. Must be a valid field on the resource; an invalid field returns a 400 error.

from_case

integer

Filter by the originating case ID.

to_case

integer

Filter by the related case ID.

relationship

string

Filter by relationship type string. e.g. relationship=Parent.

reverse_relationship

string

Filter by reverse relationship type string. e.g. reverse_relationship=Child.

dependant

boolean

Filter by dependant status. Returns relationships matching the supplied boolean value.

reverse_dependant

boolean

Filter by reverse dependant status. Returns relationships matching the supplied boolean value.

Response

200search results matching criteria