API Reference - Subjects

Subjects are the objects that store detailed information about the target of the investigation.  Subject collections are largely comprised of custom fields.

Listing Subjects

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

GET /api/v1/subjects

 

Available Request Parameters:

Name Type Required Description
id integer no ID of the subject.
case integer no ID of the case this subject belongs to.
is_primary integer no If yes, the subject must be a "primary" subject.
name string no Name of the subject (last, first if a proper name).
subject_type integer no ID of the subject type this subject belongs to.
created_from timestamp no Created on or after the date.
created_to timestamp no Created 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.

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

Getting a Subject

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

GET /api/v1/subjects/{subject_id}

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