Filters
Filters Documentation
Filter [LIST]
Filter [LIST]
Request
Endpoint
GET api/v2/contacts/filters
Content-Type: application/vnd.api+jsonBody
Parameters
Filters
account_list_id
Type string
Description The account list to return filters for
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": [
{
"id": "14",
"type": "contact_filter_address_historics",
"attributes": {
"name": "address_historic",
"title": "Address No Longer Valid",
"type": "single_checkbox",
"parent": "Contact Location",
"default_selection": false,
"multiple": false,
"options": [
],
"featured": true
}
},
{
"id": "40",
"type": "contact_filter_alma_maters",
"attributes": {
"name": "alma_mater",
"title": "Alma Mater",
"type": "multiselect",
"parent": "Contact Details",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": false
}
},
{
"id": "39",
"type": "contact_filter_anniversaries",
"attributes": {
"name": "anniversary",
"title": "Anniversary",
"type": "daterange",
"parent": "Contact Details",
"default_selection": "",
"multiple": false,
"options": [
],
"featured": false
}
},
{
"id": "26",
"type": "contact_filter_appeals",
"attributes": {
"name": "appeal",
"title": "Appeal",
"type": "multiselect",
"parent": null,
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- Do not ask --",
"id": "no_appeals"
}
],
"featured": false
}
},
{
"id": "38",
"type": "contact_filter_birthdays",
"attributes": {
"name": "birthday",
"title": "Birthday",
"type": "daterange",
"parent": "Contact Details",
"default_selection": "",
"multiple": false,
"options": [
],
"featured": false
}
},
{
"id": "24",
"type": "contact_filter_churches",
"attributes": {
"name": "church",
"title": "Church",
"type": "multiselect",
"parent": "Contact Details",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": false
}
},
{
"id": "11",
"type": "contact_filter_cities",
"attributes": {
"name": "city",
"title": "City",
"type": "multiselect",
"parent": "Contact Location",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": true
}
},
{
"id": "21",
"type": "contact_filter_contact_info_addrs",
"attributes": {
"name": "contact_info_addr",
"title": "Address",
"type": "radio",
"parent": "Contact Information",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "Yes",
"id": "Yes"
},
{
"name": "No",
"id": "No"
}
],
"featured": false
}
},
{
"id": "17",
"type": "contact_filter_contact_info_emails",
"attributes": {
"name": "contact_info_email",
"title": "Email",
"type": "radio",
"parent": "Contact Information",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "Yes",
"id": "Yes"
},
{
"name": "No",
"id": "No"
}
],
"featured": false
}
},
{
"id": "22",
"type": "contact_filter_contact_info_facebooks",
"attributes": {
"name": "contact_info_facebook",
"title": "Facebook Profile",
"type": "radio",
"parent": "Contact Information",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "Yes",
"id": "Yes"
},
{
"name": "No",
"id": "No"
}
],
"featured": false
}
},
{
"id": "19",
"type": "contact_filter_contact_info_mobiles",
"attributes": {
"name": "contact_info_mobile",
"title": "Mobile Phone",
"type": "radio",
"parent": "Contact Information",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "Yes",
"id": "Yes"
},
{
"name": "No",
"id": "No"
}
],
"featured": false
}
},
{
"id": "18",
"type": "contact_filter_contact_info_phones",
"attributes": {
"name": "contact_info_phone",
"title": "Home Phone",
"type": "radio",
"parent": "Contact Information",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "Yes",
"id": "Yes"
},
{
"name": "No",
"id": "No"
}
],
"featured": false
}
},
{
"id": "20",
"type": "contact_filter_contact_info_work_phones",
"attributes": {
"name": "contact_info_work_phone",
"title": "Work Phone",
"type": "radio",
"parent": "Contact Information",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "Yes",
"id": "Yes"
},
{
"name": "No",
"id": "No"
}
],
"featured": false
}
},
{
"id": "9",
"type": "contact_filter_contact_types",
"attributes": {
"name": "contact_type",
"title": "Type",
"type": "multiselect",
"parent": "Contact Details",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "Person",
"id": "person"
},
{
"name": "Company",
"id": "company"
}
],
"featured": false
}
},
{
"id": "13",
"type": "contact_filter_countries",
"attributes": {
"name": "country",
"title": "Country",
"type": "multiselect",
"parent": "Contact Location",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": true
}
},
{
"id": "41",
"type": "contact_filter_created_ats",
"attributes": {
"name": "created_at",
"title": "Created At",
"type": "daterange",
"parent": "Contact Details",
"default_selection": "",
"multiple": false,
"options": [
],
"featured": false
}
},
{
"id": "29",
"type": "contact_filter_donations",
"attributes": {
"name": "donation",
"title": "Gift Options",
"type": "multiselect",
"parent": "Gift Details",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "No Gifts",
"id": "none"
},
{
"name": "One or More Gifts",
"id": "one"
},
{
"name": "First Gift",
"id": "first"
},
{
"name": "Last Gift",
"id": "last"
}
],
"featured": true
}
},
{
"id": "31",
"type": "contact_filter_donation_amount_ranges",
"attributes": {
"name": "donation_amount_range",
"title": "Gift Amount Range",
"type": "text",
"parent": "Gift Details",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "Gift Amount Higher Than or Equal To",
"id": "min",
"placeholder": 0
},
{
"name": "Gift Amount Less Than or Equal To",
"id": "max",
"placeholder": null
}
],
"featured": true
}
},
{
"id": "32",
"type": "contact_filter_donation_dates",
"attributes": {
"name": "donation_date",
"title": "Gift Date",
"type": "daterange",
"parent": "Gift Details",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "Last 30 Days",
"start": "2021-12-14T00:00:00+13:00",
"end": "2022-01-13T06:18:57+13:00"
},
{
"name": "This Month",
"start": "2022-01-01T01:00:00+13:00",
"end": "2022-01-31T23:59:59+13:00"
},
{
"name": "Last Month",
"start": "2021-12-01T01:00:00+13:00",
"end": "2021-12-31T23:59:59+13:00"
},
{
"name": "Last Two Months",
"start": "2021-11-01T01:00:00+13:00",
"end": "2022-01-01T00:00:00+13:00"
},
{
"name": "Last Three Months",
"start": "2021-10-01T01:00:00+13:00",
"end": "2022-01-01T00:00:00+13:00"
},
{
"name": "This Year",
"start": "2022-01-01T01:00:00+13:00",
"end": "2022-12-31T23:59:59+13:00"
},
{
"name": "Last Year",
"start": "2021-01-01T01:00:00+13:00",
"end": "2021-12-31T23:59:59+13:00"
}
],
"featured": true
}
},
{
"id": "8",
"type": "contact_filter_likelies",
"attributes": {
"name": "likely",
"title": "Likely To Give",
"type": "multiselect",
"parent": "Contact Details",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
},
{
"name": "Least Likely",
"id": "Least Likely"
},
{
"name": "Likely",
"id": "Likely"
},
{
"name": "Most Likely",
"id": "Most Likely"
}
],
"featured": false
}
},
{
"id": "28",
"type": "contact_filter_locales",
"attributes": {
"name": "locale",
"title": "Language",
"type": "multiselect",
"parent": "Contact Details",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"id": "null",
"name": "-- Unspecified --"
}
],
"featured": false
}
},
{
"id": "15",
"type": "contact_filter_metro_areas",
"attributes": {
"name": "metro_area",
"title": "Metro Area",
"type": "multiselect",
"parent": "Contact Location",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": true
}
},
{
"id": "6",
"type": "contact_filter_newsletters",
"attributes": {
"name": "newsletter",
"title": "Newsletter Recipients",
"type": "radio",
"parent": null,
"default_selection": "",
"multiple": false,
"options": [
{
"name": "Nothing Selected",
"id": "no_value"
},
{
"name": "None",
"id": "none"
},
{
"name": "All",
"id": "all"
},
{
"name": "Physical and Both",
"id": "address"
},
{
"name": "Email and Both",
"id": "email"
},
{
"name": "Physical Only",
"id": "address_only"
},
{
"name": "Email Only",
"id": "email_only"
},
{
"name": "Both Only",
"id": "both"
}
],
"featured": false
}
},
{
"id": "33",
"type": "contact_filter_next_asks",
"attributes": {
"name": "next_ask",
"title": "Next Ask",
"type": "daterange",
"parent": "Gift Details",
"default_selection": "",
"multiple": false,
"options": [
],
"featured": false
}
},
{
"id": "37",
"type": "contact_filter_notes",
"attributes": {
"name": "notes",
"title": "Notes",
"type": "text",
"parent": "Search Notes",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "Search note contents",
"id": "wildcard_note_search"
}
],
"featured": false
}
},
{
"id": "23",
"type": "contact_filter_opt_outs",
"attributes": {
"name": "opt_out",
"title": "Opted Out of Email",
"type": "radio",
"parent": "Contact Information",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "Yes, at least one person",
"id": "Yes"
},
{
"name": "No people",
"id": "No"
}
],
"featured": false
}
},
{
"id": "3",
"type": "contact_filter_pledge_currencies",
"attributes": {
"name": "pledge_currency",
"title": "Commitment Currency",
"type": "multiselect",
"parent": "Commitment Details",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "USD",
"id": "USD"
}
],
"featured": false
}
},
{
"id": "4",
"type": "contact_filter_pledge_frequencies",
"attributes": {
"name": "pledge_frequency",
"title": "Commitment Frequency",
"type": "multiselect",
"parent": "Commitment Details",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "Weekly",
"id": "0.23076923076923"
},
{
"name": "Every 2 Weeks",
"id": "0.46153846153846"
},
{
"name": "Monthly",
"id": "1.0"
},
{
"name": "Every 2 Months",
"id": "2.0"
},
{
"name": "Quarterly",
"id": "3.0"
},
{
"name": "Every 4 Months",
"id": "4.0"
},
{
"name": "Every 6 Months",
"id": "6.0"
},
{
"name": "Annual",
"id": "12.0"
},
{
"name": "Every 2 Years",
"id": "24.0"
}
],
"featured": false
}
},
{
"id": "5",
"type": "contact_filter_pledge_late_bies",
"attributes": {
"name": "pledge_late_by",
"title": "Late By",
"type": "radio",
"parent": "Commitment Details",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "Less than 30 days late",
"id": "0_30"
},
{
"name": "30-60 days late",
"id": "30_60"
},
{
"name": "60-90 days late",
"id": "60_90"
},
{
"name": "More than 90 days late",
"id": "90"
}
],
"featured": false
}
},
{
"id": "1",
"type": "contact_filter_pledge_receiveds",
"attributes": {
"name": "pledge_received",
"title": "Commitment Received",
"type": "radio",
"parent": "Commitment Details",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "Received",
"id": "true"
},
{
"name": "Not Received",
"id": "false"
}
],
"featured": false
}
},
{
"id": "10",
"type": "contact_filter_primary_addresses",
"attributes": {
"name": "primary_address",
"title": "Address Type",
"type": "multiselect",
"parent": "Contact Location",
"default_selection": "primary, null",
"multiple": true,
"options": [
{
"name": "Primary",
"id": "primary"
},
{
"name": "Active",
"id": "active"
},
{
"name": "Inactive",
"id": "inactive"
},
{
"name": "All",
"id": "null"
}
],
"featured": true
}
},
{
"id": "7",
"type": "contact_filter_referrers",
"attributes": {
"name": "referrer",
"title": "Referrer",
"type": "multiselect",
"parent": null,
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
},
{
"name": "-- Has referrer --",
"id": "any"
}
],
"featured": false
}
},
{
"id": "16",
"type": "contact_filter_regions",
"attributes": {
"name": "region",
"title": "Region",
"type": "multiselect",
"parent": "Contact Location",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": true
}
},
{
"id": "25",
"type": "contact_filter_related_task_actions",
"attributes": {
"name": "related_task_action",
"title": "Action",
"type": "multiselect",
"parent": "Tasks",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": false
}
},
{
"id": "12",
"type": "contact_filter_states",
"attributes": {
"name": "state",
"title": "State",
"type": "multiselect",
"parent": "Contact Location",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": true
}
},
{
"id": "0",
"type": "contact_filter_statuses",
"attributes": {
"name": "status",
"title": "Status",
"type": "multiselect",
"parent": null,
"default_selection": "active, null",
"multiple": true,
"options": [
{
"name": "-- All Active --",
"id": "active"
},
{
"name": "-- All Hidden --",
"id": "hidden"
},
{
"name": "-- None --",
"id": "null"
},
{
"name": "Never Contacted",
"id": "Never Contacted"
},
{
"name": "Ask in Future",
"id": "Ask in Future"
},
{
"name": "Cultivate Relationship",
"id": "Cultivate Relationship"
},
{
"name": "Contact for Appointment",
"id": "Contact for Appointment"
},
{
"name": "Appointment Scheduled",
"id": "Appointment Scheduled"
},
{
"name": "Call for Decision",
"id": "Call for Decision"
},
{
"name": "Partner - Financial",
"id": "Partner - Financial"
},
{
"name": "Partner - Special",
"id": "Partner - Special"
},
{
"name": "Partner - Pray",
"id": "Partner - Pray"
},
{
"name": "Not Interested",
"id": "Not Interested"
},
{
"name": "Unresponsive",
"id": "Unresponsive"
},
{
"name": "Never Ask",
"id": "Never Ask"
},
{
"name": "Research Abandoned",
"id": "Research Abandoned"
},
{
"name": "Expired Referral",
"id": "Expired Referral"
}
],
"featured": true
}
},
{
"id": "36",
"type": "contact_filter_task_due_dates",
"attributes": {
"name": "task_due_date",
"title": "Due Date",
"type": "daterange",
"parent": "Tasks",
"default_selection": "",
"multiple": false,
"options": [
{
"name": "Yesterday",
"start": "2022-01-12T01:00:00+13:00",
"end": "2022-01-12T23:59:59+13:00"
},
{
"name": "Today",
"start": "2022-01-13T01:00:00+13:00",
"end": "2022-01-13T23:59:59+13:00"
},
{
"name": "Tomorrow",
"start": "2022-01-14T01:00:00+13:00",
"end": "2022-01-14T23:59:59+13:00"
},
{
"name": "This Week",
"start": "2022-01-09T00:00:00+13:00",
"end": "2022-01-14T23:59:59+13:00"
},
{
"name": "Next Week",
"start": "2022-01-16T00:00:00+13:00",
"end": "2022-01-21T23:59:59+13:00"
},
{
"name": "This Month",
"start": "2022-01-01T01:00:00+13:00",
"end": "2022-01-31T23:59:59+13:00"
},
{
"name": "Next Month",
"start": "2022-02-01T01:00:00+13:00",
"end": "2022-02-28T23:59:59+13:00"
}
],
"featured": false
}
},
{
"id": "35",
"type": "contact_filter_tasks_all_completeds",
"attributes": {
"name": "tasks_all_completed",
"title": "No Incomplete Tasks",
"type": "single_checkbox",
"parent": "Tasks",
"default_selection": false,
"multiple": false,
"options": [
],
"featured": false
}
},
{
"id": "43",
"type": "contact_filter_user_ids",
"attributes": {
"name": "user_ids",
"title": "Assignee",
"type": "multiselect",
"parent": null,
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"id": "14564b58-7eae-49db-8239-c3106b539dfd",
"name": "Troy "
}
],
"featured": false
}
}
]
}Fields
data
Type
[Filter]
Description An array of Filters
Last updated