Criteria
Note: These criteria fields are only applicable to the search for individuals
| Id | Type | Notes |
|---|---|---|
| ability | number | |
| age | number | |
| allergies | text | |
| anniversary | date | |
| anniversary_date_parts | date_parts | |
| anniversary_month | number | |
| area | number | |
| attendance_attendance_grouping | special | info |
| attendance_department | special | info |
| attendance_single_event | special | info |
| barcode | text | |
| birth_date | date | |
| birth_date_parts | date_parts | |
| birth_month | number | |
| campus | number | |
| child_work_approved_start_date | date | |
| child_work_approved_start_month | number | |
| child_work_approved_stop_date | date | |
| child_work_approved_stop_month | number | |
| church_service | number | |
| commitment_date | date | |
| commitment_story | text | |
| contact_phone_number | text | |
| creator_first_name | text | |
| creator_last_name | text | |
| current_story | text | |
| date_created | date | |
| date_created_month | number | |
| date_created_parts | date_parts | |
| date_deceased | date | |
| date_deceased_month | number | |
| date_deceased_parts | date_parts | |
| date_modified | date | |
| date_modified_month | number | |
| date_modified_parts | date_parts | |
| discussion_posts | number | |
| text | ||
| emergency_contact_number | text | |
| emergency_contact_phone_number | text | |
| event | special | info |
| event_legacy | special | info |
| family_child | special | info |
| family_head | text | |
| family_id | number | |
| family_other | text | |
| family_photo | text | |
| family_position | text | |
| family_spouse | text | |
| fax_phone_number | text | |
| first_name | text | |
| form_question_answer | special | info |
| gender | text | |
| giving_number | text | |
| group | special | info |
| group_department | special | info |
| group_name | text | |
| group_relationship | number | |
| group_search | special | info |
| group_type | special | info |
| group_udf_pulldown_1 | number | |
| group_udf_pulldown_2 | number | |
| group_udf_pulldown_3 | number | |
| home_city | text | |
| home_country | text | |
| home_state | text | |
| home_street | text | |
| home_zip | text | |
| how_joined_church | number | |
| how_they_heard | number | |
| individual_id | number | |
| is_baptized | boolean | |
| is_confirmed_no_allergies | boolean_strict | |
| is_home_listed | boolean | |
| is_inactive | boolean | |
| is_limited_access_user | boolean | |
| is_listed | boolean | |
| is_other_listed | boolean | |
| is_work_listed | boolean | |
| last_attended_date | date | |
| last_giving_date | date | |
| last_login_date | date | |
| last_login_date_parts | date_parts | |
| last_name | text | |
| last_need_assigned_date | date | |
| legal_name | text | |
| login | text | |
| mailing_carrier_route | text | |
| mailing_city | text | |
| mailing_country | text | |
| mailing_state | text | |
| mailing_street | text | |
| mailing_zip | text | |
| marital_status | text | |
| membership_month | number | |
| membership_start_date | date | |
| membership_stop_date | date | |
| membership_type | number | |
| middle_name | text | |
| military | text | |
| mobile_carrier | number | |
| mobile_phone_number | text | |
| modifier_first_name | text | |
| modifier_last_name | text | |
| name | special | info |
| new_giver | special | info |
| other_city | text | |
| other_country | text | |
| other_id | text | |
| other_state | text | |
| other_street | text | |
| other_zip | text | |
| pager_phone_number | text | |
| passion | number | |
| personality_style | number | |
| photo | text | |
| pledge | number | |
| position | special | info |
| process_queue | special | info |
| process_queue_date | special | info |
| reason_left_church | number | |
| school | number | |
| school_grade | number | |
| significant_event | special | info |
| spiritual_gift | number | |
| spiritual_maturity | number | |
| sync_id | number | |
| transaction_amount | special | info |
| udf_date_1 | date | |
| udf_date_2 | date | |
| udf_date_3 | date | |
| udf_date_4 | date | |
| udf_date_5 | date | |
| udf_date_6 | date | |
| udf_pulldow_1 | number | |
| udf_pulldow_2 | number | |
| udf_pulldow_3 | number | |
| udf_pulldow_4 | number | |
| udf_pulldow_5 | number | |
| udf_pulldow_6 | number | |
| udf_text_1 | text | |
| udf_text_10 | text | |
| udf_text_11 | text | |
| udf_text_12 | text | |
| udf_text_2 | text | |
| udf_text_3 | text | |
| udf_text_4 | text | |
| udf_text_5 | text | |
| udf_text_6 | text | |
| udf_text_7 | text | |
| udf_text_8 | text | |
| udf_text_9 | text | |
| virtus_status | text | info |
| virtus_status_expiration_time | date_parts | |
| work_city | text | |
| work_country | text | |
| work_state | text | |
| work_street | text | |
| work_zip | text |
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 neededGroup
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"}
}