Search Filters

Criteria

Note: These criteria fields are only applicable to the search for individuals

IdTypeNotes
abilitynumber
agenumber
allergiestext
anniversarydate
anniversary_date_partsdate_parts
anniversary_monthnumber
areanumber
attendance_attendance_groupingspecialinfo
attendance_departmentspecialinfo
attendance_single_eventspecialinfo
barcodetext
birth_datedate
birth_date_partsdate_parts
birth_monthnumber
campusnumber
child_work_approved_start_datedate
child_work_approved_start_monthnumber
child_work_approved_stop_datedate
child_work_approved_stop_monthnumber
church_servicenumber
commitment_datedate
commitment_storytext
contact_phone_numbertext
creator_first_nametext
creator_last_nametext
current_storytext
date_createddate
date_created_monthnumber
date_created_partsdate_parts
date_deceaseddate
date_deceased_monthnumber
date_deceased_partsdate_parts
date_modifieddate
date_modified_monthnumber
date_modified_partsdate_parts
discussion_postsnumber
emailtext
emergency_contact_numbertext
emergency_contact_phone_numbertext
eventspecialinfo
event_legacyspecialinfo
family_childspecialinfo
family_headtext
family_idnumber
family_othertext
family_phototext
family_positiontext
family_spousetext
fax_phone_numbertext
first_nametext
form_question_answerspecialinfo
gendertext
giving_numbertext
groupspecialinfo
group_departmentspecialinfo
group_nametext
group_relationshipnumber
group_searchspecialinfo
group_typespecialinfo
group_udf_pulldown_1number
group_udf_pulldown_2number
group_udf_pulldown_3number
home_citytext
home_countrytext
home_statetext
home_streettext
home_ziptext
how_joined_churchnumber
how_they_heardnumber
individual_idnumber
is_baptizedboolean
is_confirmed_no_allergiesboolean_strict
is_home_listedboolean
is_inactiveboolean
is_limited_access_userboolean
is_listedboolean
is_other_listedboolean
is_work_listedboolean
last_attended_datedate
last_giving_datedate
last_login_datedate
last_login_date_partsdate_parts
last_nametext
last_need_assigned_datedate
legal_nametext
logintext
mailing_carrier_routetext
mailing_citytext
mailing_countrytext
mailing_statetext
mailing_streettext
mailing_ziptext
marital_statustext
membership_monthnumber
membership_start_datedate
membership_stop_datedate
membership_typenumber
middle_nametext
militarytext
mobile_carriernumber
mobile_phone_numbertext
modifier_first_nametext
modifier_last_nametext
namespecialinfo
new_giverspecialinfo
other_citytext
other_countrytext
other_idtext
other_statetext
other_streettext
other_ziptext
pager_phone_numbertext
passionnumber
personality_stylenumber
phototext
pledgenumber
positionspecialinfo
process_queuespecialinfo
process_queue_datespecialinfo
reason_left_churchnumber
schoolnumber
school_gradenumber
significant_eventspecialinfo
spiritual_giftnumber
spiritual_maturitynumber
sync_idnumber
transaction_amountspecialinfo
udf_date_1date
udf_date_2date
udf_date_3date
udf_date_4date
udf_date_5date
udf_date_6date
udf_pulldow_1number
udf_pulldow_2number
udf_pulldow_3number
udf_pulldow_4number
udf_pulldow_5number
udf_pulldow_6number
udf_text_1text
udf_text_10text
udf_text_11text
udf_text_12text
udf_text_2text
udf_text_3text
udf_text_4text
udf_text_5text
udf_text_6text
udf_text_7text
udf_text_8text
udf_text_9text
virtus_statustextinfo
virtus_status_expiration_timedate_parts
work_citytext
work_countrytext
work_statetext
work_streettext
work_ziptext

Special Criteria

Attendance: Attendance Grouping

Operator: ignored

Value:

{
attendance_grouping_id: number,
group_id: number,
from_date: date string,
to_date: date_string,
total_by: string of {"week", "day", "event"},
presence: string of {"present", "absent"},
number_of_times_value: number,
number_of_times_op: string // Operator for number_of_times_value
}

Attendance: Department

Operator: ignored

Value:

{
department_id: number,
from_date: date string,
to_date: date string,
total_by: string of {"week", "day", "event"},
presence: string of {"present", "absent"},
number_of_times_value: number,
number_of_times_op: string // Operator for number_of_times_value
}

Attendance: Single Event

Operator: ignored

Value:

{
presence: string of {"present", "not present"},
event_id: number,
event_date: date string,
total_by: string of {"week", "day", "event"},
presence: string of {"present", "absent"},
number_of_times_value: number,
number_of_times_op: string // Operator for number_of_times_value
}

Event Search

Operator: ignored

Value:

// If check_type == "status"
{
check_type: "status",
status_op: string, // The operator for status_id
status_id: number,
event_op: string, // The operator for event_id
event_id: number
}
{
// If check_type == "attendance"
check_type: "attendance",
attended: string of {"attended", "did_not_attend", "no_status"},
event_op: string, // The event_id operator
event_id: number,
date_op: string, // The date operator
date_value: date string
}

Legacy Event Search

Operator: ignored

Value:

{
status_op: string, // The operator for status_id
status_id: number,
event_op: string, // The operator for event_id
event_id: number,
}

Form Question & Answer

Operator: string of {"is", "is_set"}

Value: json

// For all question types:
{
form_id: number,
form_question_id: number,
}
{
// For text questions
value: string,
value_op: string // The operator for value
}
{
// For checkbox, radio and select questions
choice_value: number,
choice_op: string // The operator for choice_value
}
{
// For scale questions
choice_value: number,
choice_op: string, // The operator for choice_value
option_value: number,
option_op: string, // The operator for option_value
}
{
// For prioritize and product ticket questions
choice_value: number,
choice_op: string, // The operator for choice_value
value: number,
value_op: // The operator for value
}
{
// For number and donation questions
value: number,
value_op: string // The operator for value
}
{
// For date questions
value: date string,
value_op: string // The operator for value
}
// File upload
// Only checks to see if it exists so no values or operators are needed

Group

Operator: ignored

Value:

{
group_id: number,
status_value: number,
status_op: string // The operator for status_value
}

Group: Department

Operator: ignored

Value:

{
grouping_id: number,
status_value: number,
status_op: string // The operator for status_value
}

Group: Search

Operator: ignored

Value:

{
individual_status_id: number,
individual_status_op: string, // The operator for individual_status_id
group_name_value: string,
group_name_op: string, // The operator for group_name_value
group_grouping_id: number,
group_grouping_op: string, // The operator for group_grouping_id
group_type_id: number,
group_type_op: string // The operator for group_type_id
}

Group: Type

Operator: ignored

Value:

{
type_id: number,
status_value: number,
status_op: string // The operator for status_value
}

Name

Operator: string of {"space_to__wildcard", "space_to_wildcard_space", "any_order_like", "legacy"}

Value: string

The manner of how the search string is compared to the first and last name of each individual is dependant on the operator:

space_to_wildcard: spaces are turned to wildcard characters and the search text is surrounded with wildcard characters.

space_to_wildcard_space: like space_to_wildcard except that spaces are turned into a wildcard surrounded by spaces.

any_order_like: the text is split on spaces and the name must be like all the words in the text, but in any order.

legacy: if the search text contains a space, it is split on the first space and to match the individuals name must being with the first word, and their last name must begin with the second word.

Virtus Status

Operator: string of {"in","not_in"}

Value: string Each Virtus Status can have any of these status options:

  • CERTIFIED
  • EXPIRED
  • ID_ERROR
  • INACTIVE
  • NOT_CERTIFIED
"filters": {
        "conditions": [
            {
                "type": "group",
                "operator": "and",
                "conditions": [
                    {
                        "id": "virtus_status",
                        "invert": false,
                        "operator": "in",
                        "type": "constraint",
                        "value": [
                            "CERTIFIED",
                            "EXPIRED",
                            "ID_ERROR",
                            "INACTIVE",
                            "NOT_CERTIFIED"
                        ],        
                    }
                ]
            }
       ],
    },

NOTE: Virtus must be enabled, and connected, for the organization. If Virtus is not connected, then a 403 Forbidden is returned

{
// 403 Forbidden if Virtus is not connected for this church org.
}

New Giver

Operator: ignored

Value:

{
date_value: date string,
date_op: string, // The operator for date_value
gift_number: number
}

Position

Operator: ignored

Value:

{
status_id: number,
status_op: string, // The operator for status_id
position_id: number,
position_op: string, // The operator for position_id
}

Process Queue

Operator: ignored

Value:

{
step_id: number,
status_id: number,
status_op: string // The operator for status_id
}

Process Queue: Date

Operator: date operator

Value:

{
date_type: string of {"date_created", "date_completed", "date_due"},
value: date value,
step_id: number
}

Significant Event

Operator: ignored

Value:

{
significant_event_id: number,
significant_event_op: string, // The operator for significant_event_id
date_value: date string,
date_op: string // The operator for date_value
}

Transaction Amount

Operator: ignored

Value:

{
amount_value: number,
amount_op: string, // The operator for amount_value
coa_id: number,
coa_op: string, // The operator for coa_id
date_value: date string,
date_op: string, // The operator for date_value
tax_deductible_value: string of {"yes", "no", "both"}
}