The criteria on this page are the id values you put in a filter constraint node. The node shape, the
operators for each data type, and the configuration block are covered in
Advanced Search Overview.

{
  "type": "constraint",
  "id": "birth_date",
  "operator": "in_the_next",
  "value": { "period": "day", "units": 30, "anniversary": true },
  "invert": false
}

Get the live list for your integration

Criteria are filtered by the calling user's permissions and by the church's enabled modules, so the
set you can actually use is narrower than the full table below.

GET /search/individuals

Returns the criteria this caller may use, plus the search actions they may run. Call it once at
integration setup, or when a filter starts returning 412, instead of guessing from documentation.

It uses the same read:individuals scope as the results endpoint.

Reading the table

Type determines which operators are valid and what shape value takes. text, number,
date, date_parts, boolean, boolean_strict, currency, and time are documented in
Data Types and Operators.

special means the criterion takes a structured value object of its own. Every special
criterion has a section under Special criteria giving its exact shape.

Access is the permission the calling user needs. A user who does not have it gets 403, not a
filtered result set — a single unpermitted constraint fails the whole request.

Master administrators and system users satisfy all of these.

Criteria

Ids that changed

Earlier revisions of this page listed ids that the API does not accept, and typed several criteria in
a way that produces 412 or an empty result set. If your integration uses one of these, update it.

These are accepted, but were typed wrongly — the type in the table above is the one the API applies:

Special criteria

Each section gives the constraint's operator and the shape of value.

Where a section says the operator is ignored, send any string — the comparison logic lives
entirely inside value. invert still applies to the constraint as a whole.

Sub-operators inside a value (status_op, date_op, and so on) take the same operator names as the
matching data type. A sub-operator left null disables that part of the filter rather than failing.

Attendance

Covers attendance_attendance_grouping, attendance_department, and attendance_group. All three
share one value shape; type selects what id refers to.

Operator: ignored

{
  "type": "grouping",
  "id": 42,
  "group_id": null,
  "attended": "attended",
  "total_by": "week",
  "date_op": "in_the_last",
  "period": "month",
  "units": 3,
  "number_of_times_op": "greater_than_or_equal",
  "number_of_times_value": 4
}

Attendance: Single Event (legacy)

attendance_single_event. One event on one date.

Operator: ignored

{
  "presence": "present",
  "event_id": 8123,
  "event_date": "2026-08-16"
}

Event

event. check_type selects one of two completely different value shapes.

Operator: ignored
Access: contextual — the caller must be able to view that event's guest list.

Registration status:

{
  "check_type": "status",
  "status_op": "in",
  "status_value": [1, 2],
  "event_op": "equal",
  "event_id": 8123
}

Attendance:

{
  "check_type": "attendance",
  "attended": "attended",
  "event_op": "equal",
  "event_id": 8123,
  "date_op": "in_the_last",
  "date_value": { "period": "month", "units": 1 }
}

Event (legacy)

event_legacy. The pre-event form. Prefer event with check_type: "status".

Operator: ignored

{
  "status_op": "is",
  "status_value": 2,
  "event_op": "equal",
  "event_id": 8123
}

status_op is is, is_not, is_any, or is_not_any. As with event, the key is
status_value — not status_id.

Form Question and Answer

form_question_answer. Matches a response to one question on one form.

Operator: ignored — the real operators are question_op and value_op inside the value.

{
  "form_id": 55,
  "question_id": 912,
  "question_op": "equal",
  "question_type": "single",
  "value": "Downtown",
  "value_op": "contains"
}

What value holds, by question_type:

Group

group. Membership in one group, optionally narrowed by member status.

Operator: ignored
Access: contextual — the caller must be able to view that group's member list.

{
  "group_id": 331,
  "group_op": "equal",
  "status_value": [1, 2],
  "status_op": "in"
}

Group: Department

group_department. Membership in any group in a department.

Operator: ignored

{
  "department_id": 12,
  "department_op": "equal",
  "status_value": ["LEADER"],
  "status_op": "in"
}

Group: Type

group_type.

Operator: ignored

{
  "type_id": 4,
  "type_op": "equal",
  "status_value": ["MEMBER"],
  "status_op": "in"
}

Group: Search

group_search. Combines group name, department, type, and member status in one constraint.

Operator: ignored

{
  "group_name_value": "Youth",
  "group_name_op": "contains",
  "group_grouping_id": 12,
  "group_grouping_op": "equal",
  "group_type_id": 4,
  "group_type_op": "equal",
  "individual_status_id": ["LEADER", "MEMBER"],
  "individual_status_op": "in"
}

Group: Name

group_name. The value's meaning depends on the operator.

Operator: any text operator, plus equal / not_equal

Group: Relationship

group_relationship. Relationship status across all groups, with no group filter.

Operator: ignored

{ "status_value": ["LEADER", "COACH"], "status_op": "in" }

Group: Interaction Type

group_interaction_type.

Operator: a number operator, applied to interaction_type

{ "interaction_type": 3, "status_value": ["MEMBER"], "status_op": "in" }

Group: Status

group_status. Membership status with no group, type, or department filter.

Operator: a number operator
Value: the status value

Group: Member Start Date

group_member_start_date. When someone joined a specific group.

Operator: a date operator
Value: an object carrying group_id alongside the date parts the operator needs.

{ "group_id": 331, "year": 2026, "month": 1, "day": 15 }

Group: Involvement

group_involvement. The composite group filter used by current People Search. Every sub-filter is
optional; supply only the pairs you want applied.

Operator: ignored

{
  "group_name_selected_subfilter": "group_id",
  "group_id_value": 331,
  "group_id_op": "equal",
  "member_status_value": ["LEADER"],
  "member_status_op": "in",
  "member_start_date_value": { "period": "year", "units": 1 },
  "member_start_date_op": "in_the_last",
  "group_active_value": "active"
}

group_name_selected_subfilter tells the filter which of the group-identifying pairs to honour.

Group statuses

status_value in the group criteria accepts these relationship values:

Custom Fields

custom_fields for individual custom fields, group_custom_fields for group ones.

Operator: the operator for the field's own type

{ "field_id": "udf_text_3", "field_type": "TEXT", "field_value": "Alumni" }

For DATE, put the date parts on the value object itself alongside field_id and field_type:

{ "field_id": "udf_date_1", "field_type": "DATE", "year": 2026, "month": 3 }

group_custom_fields takes field_id and field_value only.

Name

name. Fuzzy matching across first and last name. This is the criterion the quick-search box uses.

Operator: space_to_wildcard, space_to_wildcard_space, any_order_like, or legacy
Value: string
Access: any signed-in user

Name Fields

name_fields. One specific name field, with normal text operators.

Operator: any text operator

{ "type": "last_name", "search_term": "Smith" }

type is first_last_name (the default, which behaves like Name), first_name,
middle_name, last_name, legal_name, maiden_name, or alternate_name.

Address

home_address, work_address, mailing_address, other_address. One address block, one component.

Operator: any text operator

{ "type": "city", "search_term": "Colorado Springs" }

type is street, city, state, zip, or country.

Phone Number

phone_number. One phone field, or all of them.

Operator: any text operator

{ "type": "mobile", "search_term": "719-555-0134" }

type is home, mobile, work, emergency, fax, pager, or any.

My Fit: Ability, Passion, Spiritual Gift, Personality Style

ability, passion, spiritual_gift, personality_style.

Operator: in, not_in, is_set, or is_not_set
Value: an id, or an array of ids. Omit for is_set / is_not_set.

{ "type": "constraint", "id": "spiritual_gift", "operator": "in", "value": [3, 7], "invert": false }

Family Members

family_head, family_spouse, family_child, family_other. Matches on the name of another
member of the individual's family, by that member's position.

Operator: any text operator
Value: string — the related person's name

Family Position

family_position. Accepts either form.

A plain string, with the constraint's own operator:

{ "type": "constraint", "id": "family_position", "operator": "equal", "value": "PRIMARY_CONTACT" }

Or an object that pairs the position with a name, letting you ask "whose spouse is named Dana":

{
  "family_position_value": "SPOUSE",
  "family_position_op": "equal",
  "individual_name_value": "Dana",
  "individual_name_op": "contains"
}

Created / Modified By Name

creator_name, modified_name. Matches the full name of the user who created or last modified the
profile, rather than first and last name separately.

Operator: any text operator
Value: string

The creator_first_name, creator_last_name, modifier_first_name, and modifier_last_name
criteria remain available for single-field matching.

Note

note. Text of individual notes.

Operator: any text operator
Value: string
Access: Notes

Duplicates

duplicates. Individuals flagged as possible duplicates of the ids you pass.

Operator: ignored
Value: an individual id, or an array of ids
Access: Full people read

Matches both sides of each duplicate pair, applies the church's duplicate-score threshold, and
excludes the master administrator's profile.

Privacy Settings

privacy_settings. The visibility level a person has set on one field.

Operator: a number operator

{ "type": "phone_home", "selection_values": [1, 2] }

type names the field. email_primary checks the listed flag; every other value checks that
field's privacy level.

Process Queue

process_queue. Position in a process, by step and status.

Operator: ignored

{ "step_id": 17, "status_value": [1], "status_op": "in" }

Process Queue: Date

process_queue_added_date, process_queue_completed_date, process_queue_due_date. The criterion
id chooses the date; there is no date_type value.

Operator: a date_parts operator
Value: the date parts, plus the process and step ids

{
  "process_name_id": 5,
  "queue_name_id": 17,
  "year": 2026,
  "month": 8
}

is_not_set on the constraint drops the date comparison and inverts the match — it finds people who
have no such date on that step.

Significant Event

significant_event, and significant_event_date for a date-only query.

Operator: ignored (significant_event) · a date_parts operator (significant_event_date)
Access: Full people read

{
  "significant_event_id": [4, 9],
  "significant_event_op": "in",
  "significant_event_date_value": { "period": "year", "units": 1 },
  "significant_event_date_op": "in_the_last",
  "significant_event_note_value": "hospital",
  "significant_event_note_op": "contains"
}

Funeral

funeral_system_significant_event. Funerals recorded as system significant events.

Operator: ignored
Access: Significant events

Every pair below is optional; supply only what you want applied.

Sacraments

baptism_sacrament, reconciliation_sacrament, first_communion_sacrament,
confirmation_sacrament, marriage_sacrament, holy_order_sacrament,
anointing_the_sick_sacrament.

Operator: ignored
Access: Sacrament admin. Requires the Sacraments module.

Deleted and archived sacraments are always excluded. Every pair is optional — an empty value matches
anyone with a sacrament of that type.

Virtus Status

virtus_status, and virtus_status_expiration_time for the expiry date.

Operator: in or not_in (virtus_status) · a date_parts operator (virtus_status_expiration_time)
Access: Virtus

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

New Giver

new_giver. Finds people by the date of their nth gift.

Operator: a date_parts operator
Value: the gift number in type, plus the date parts

{
  "type": "constraint",
  "id": "new_giver",
  "operator": "in_the_last",
  "value": { "type": 1, "period": "month", "units": 3 },
  "invert": false
}

Scheduling (Luna)

Scheduling criteria on the individual domain. For scheduling-first queries use the dedicated
scheduling search domains instead.

Operator: ignored, except where noted

Department Admin

department_admin. Administrators of a department.

Operator: equal or not_equal
Value: the department id

Background Check Package Name

background_check_package_name matches people by their background checks — the package, and
optionally when the check completed, when it expires, who ordered it, and its report status.
has_requested_background_check distinguishes checks a person requested for themselves from checks
ordered on their behalf — send not_equal to match self-requested checks, anything else to match
checks ordered by someone else.

Operator: in — the node operator is not consulted; matching is controlled by the *_op keys
inside the value.

Checks expiring in the next 90 days under package 123:

{
  "package_op": "in",
  "package_value": [123],
  "expiration_date_op": "in_the_next",
  "expiration_date_value": { "period": "day", "units": 90 }
}

Every block except the package is optional — include only the *_op / *_value pairs you need.

Date blocks. completed_date_* and expiration_date_* each accept four forms:

Email Verification

email_verification_opt_in_status, plus four date variants:
email_verification_opt_in_date, email_verification_date_verified,
email_verification_date_verification_email_sent, email_verification_date_opt_in_email_sent.

Operator: a text operator for the status · a date_parts operator for the dates

{ "type": "constraint", "id": "email_verification_opt_in_status", "operator": "in", "value": ["OPT_IN"] }

MICR Scan

micr_scan. Matches a scanned check's MICR line.

Operator: ignored
Value: the MICR string
Access: Financial

Envelope User Id

envelope_user_id. Giving envelope number.

Operator: the constraint's own operator
Value: the envelope id

Non-queryable criteria

whos_included is returned by GET /search/individuals as a filtering option for the People Search
UI, but it is not backed by a query. Do not send it in a filter tree — it has no valid comparison
and will fail the request rather than being ignored. Use configuration.filter_profile_type and the
include_* keys documented in
Population selection instead.

Extra keys on a constraint node

Beyond type, id, operator, value, and invert, a constraint node accepts:

Unrecognized keys are ignored.

Formula groups

A group node normally joins its children with a single and or or. A formula group lets you
express an arbitrary boolean expression over them instead, including NOT and parentheses, without
nesting groups by hand.

{
  "type": "group",
  "operator": "formula",
  "formula": "set1 AND (NOT set2 OR set3)",
  "invert": false,
  "conditions": [
    { "type": "constraint", "id": "campus", "operator": "equal", "value": 1, "invert": false },
    { "type": "constraint", "id": "is_inactive", "operator": "is_set", "invert": false },
    { "type": "constraint", "id": "membership_type", "operator": "in", "value": [2, 3], "invert": false }
  ]
}

Grammar. SET<n>, AND, OR, NOT, and parentheses. Keywords are case-insensitive and
whitespace is ignored. set1 is the first entry in conditions, set2 the second, and so on —
the numbering is 1-based.

Each set may itself be a group node, so a formula can combine whole sub-trees rather than single
constraints.

Examples

A single special criterion

Everyone whose mobile number contains a given exchange:

{
  "configuration": { "return_search_results": true },
  "filters": {
    "type": "constraint",
    "id": "phone_number",
    "operator": "contains",
    "value": { "type": "mobile", "search_term": "719555" },
    "invert": false
  }
}

Attendance

Adults who attended a weekend service at least twice in the last three months:

{
  "configuration": {
    "return_search_results": true,
    "order_by": [{ "column": "last_name", "direction": "asc" }]
  },
  "filters": {
    "type": "group",
    "operator": "and",
    "invert": false,
    "conditions": [
      {
        "type": "constraint",
        "id": "age",
        "operator": "greater_than_or_equal",
        "value": 18,
        "invert": false
      },
      {
        "type": "constraint",
        "id": "attendance_attendance_grouping",
        "operator": "ignored",
        "value": {
          "type": "grouping",
          "id": 42,
          "attended": "attended",
          "total_by": "week",
          "date_op": "in_the_last",
          "period": "month",
          "units": 3,
          "number_of_times_op": "greater_than_or_equal",
          "number_of_times_value": 2
        },
        "invert": false
      }
    ]
  }
}

Group leaders in a department

Everyone leading a group in department 12, including leaders of inactive groups:

{
  "configuration": { "return_search_results": true },
  "filters": {
    "type": "constraint",
    "id": "group_department",
    "operator": "ignored",
    "value": {
      "department_id": 12,
      "department_op": "equal",
      "status_value": ["LEADER", "COACH", "DIRECTOR"],
      "status_op": "in"
    },
    "include_value": { "include_value": ["ACTIVE", "INACTIVE"] },
    "invert": false
  }
}

A form response

Everyone who answered question 912 on form 55 with a specific choice:

{
  "configuration": { "return_search_results": true },
  "filters": {
    "type": "constraint",
    "id": "form_question_answer",
    "operator": "ignored",
    "value": {
      "form_id": 55,
      "question_id": 912,
      "question_op": "equal",
      "question_type": "select",
      "value": 4471,
      "value_op": "equal"
    },
    "invert": false
  }
}

To find everyone who responded to the form at all, drop question_id and keep only form_id.

First-time givers this quarter

{
  "configuration": {
    "return_search_results": true,
    "order_by": [{ "column": "last_name", "direction": "asc" }]
  },
  "filters": {
    "type": "constraint",
    "id": "new_giver",
    "operator": "in_the_previous",
    "value": { "type": 1, "period": "quarter", "units": 1 },
    "invert": false
  }
}

Excluding a set of Virtus statuses

Everyone who is neither expired nor uncertified — written as in plus invert, because not_in
with multiple statuses does not exclude the way it reads:

{
  "configuration": { "return_search_results": true },
  "filters": {
    "type": "constraint",
    "id": "virtus_status",
    "operator": "in",
    "value": ["EXPIRED", "NOT_CERTIFIED"],
    "invert": true
  }
}

A formula group

Members of campus 1 who are either leading a group or have a background check on file, but are not
inactive:

{
  "configuration": {
    "return_search_results": true,
    "filter_profile_type": ["active", "inactive"]
  },
  "filters": {
    "type": "group",
    "operator": "formula",
    "formula": "set1 AND NOT set2 AND (set3 OR set4)",
    "invert": false,
    "conditions": [
      { "type": "constraint", "id": "campus", "operator": "equal", "value": 1, "invert": false },
      { "type": "constraint", "id": "is_inactive", "operator": "is_set", "invert": false },
      {
        "type": "constraint",
        "id": "group_relationship",
        "operator": "ignored",
        "value": { "status_value": ["LEADER"], "status_op": "in" },
        "invert": false
      },
      {
        "type": "constraint",
        "id": "background_check_package_name",
        "operator": "is_set",
        "invert": false
      }
    ]
  }
}

When a filter is rejected