Filters
Filters Documentation
Filter [LIST]
Filter [LIST]
Request
Endpoint
GET api/v2/tasks/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": "0",
"type": "task_filter_activity_types",
"attributes": {
"name": "activity_type",
"title": "Action",
"type": "multiselect",
"parent": null,
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
},
{
"name": "Call",
"id": "Call"
},
{
"name": "Appointment",
"id": "Appointment"
},
{
"name": "Email",
"id": "Email"
},
{
"name": "Text Message",
"id": "Text Message"
},
{
"name": "Facebook Message",
"id": "Facebook Message"
},
{
"name": "Letter",
"id": "Letter"
},
{
"name": "Newsletter - Physical",
"id": "Newsletter - Physical"
},
{
"name": "Newsletter - Email",
"id": "Newsletter - Email"
},
{
"name": "Pre Call Letter",
"id": "Pre Call Letter"
},
{
"name": "Reminder Letter",
"id": "Reminder Letter"
},
{
"name": "Support Letter",
"id": "Support Letter"
},
{
"name": "Thank",
"id": "Thank"
},
{
"name": "To Do",
"id": "To Do"
},
{
"name": "Talk to In Person",
"id": "Talk to In Person"
},
{
"name": "Prayer Request",
"id": "Prayer Request"
}
],
"featured": false
}
},
{
"id": "3",
"type": "task_filter_completed_ats",
"attributes": {
"name": "completed_at",
"title": "Date Completed",
"type": "daterange",
"parent": "Date Range Search",
"default_selection": null,
"multiple": false,
"options": [
],
"featured": false
}
},
{
"id": "24",
"type": "task_filter_contact_appeals",
"attributes": {
"name": "contact_appeal",
"title": "Contact 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": "5",
"type": "task_filter_contact_churches",
"attributes": {
"name": "contact_church",
"title": "Contact Church",
"type": "multiselect",
"parent": null,
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": false
}
},
{
"id": "6",
"type": "task_filter_contact_cities",
"attributes": {
"name": "contact_city",
"title": "City",
"type": "multiselect",
"parent": "Contact Location",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": false
}
},
{
"id": "7",
"type": "task_filter_contact_countries",
"attributes": {
"name": "contact_country",
"title": "Country",
"type": "multiselect",
"parent": "Contact Location",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": false
}
},
{
"id": "8",
"type": "task_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": "9",
"type": "task_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": "10",
"type": "task_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": "11",
"type": "task_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": "12",
"type": "task_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": "13",
"type": "task_filter_contact_likelies",
"attributes": {
"name": "contact_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": "14",
"type": "task_filter_contact_metro_areas",
"attributes": {
"name": "contact_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": false
}
},
{
"id": "15",
"type": "task_filter_contact_newsletters",
"attributes": {
"name": "contact_newsletter",
"title": "Contact Newsletter",
"type": "radio",
"parent": null,
"default_selection": "",
"multiple": false,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"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": "16",
"type": "task_filter_contact_pledge_frequencies",
"attributes": {
"name": "contact_pledge_frequency",
"title": "Commitment Frequency",
"type": "multiselect",
"parent": "Contact 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": "17",
"type": "task_filter_contact_referrers",
"attributes": {
"name": "contact_referrer",
"title": "Contact 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": "18",
"type": "task_filter_contact_regions",
"attributes": {
"name": "contact_region",
"title": "Region",
"type": "multiselect",
"parent": "Contact Location",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": false
}
},
{
"id": "19",
"type": "task_filter_contact_states",
"attributes": {
"name": "contact_state",
"title": "State",
"type": "multiselect",
"parent": "Contact Location",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
}
],
"featured": false
}
},
{
"id": "20",
"type": "task_filter_contact_statuses",
"attributes": {
"name": "contact_status",
"title": "Contact Status",
"type": "multiselect",
"parent": null,
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"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": false
}
},
{
"id": "22",
"type": "task_filter_contact_types",
"attributes": {
"name": "contact_type",
"title": "Contact Type",
"type": "multiselect",
"parent": "Contact Details",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "Person",
"id": "person"
},
{
"name": "Company",
"id": "company"
}
],
"featured": false
}
},
{
"id": "2",
"type": "task_filter_created_ats",
"attributes": {
"name": "created_at",
"title": "Date Created",
"type": "daterange",
"parent": "Date Range Search",
"default_selection": null,
"multiple": false,
"options": [
],
"featured": false
}
},
{
"id": "26",
"type": "task_filter_next_actions",
"attributes": {
"name": "next_action",
"title": "Next Action",
"type": "multiselect",
"parent": "Task Details",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
},
{
"name": "Call",
"id": "Call"
},
{
"name": "Email",
"id": "Email"
},
{
"name": "Text Message",
"id": "Text Message"
},
{
"name": "Facebook Message",
"id": "Facebook Message"
},
{
"name": "Talk to In Person",
"id": "Talk to In Person"
},
{
"name": "Appointment",
"id": "Appointment"
},
{
"name": "Prayer Request",
"id": "Prayer Request"
},
{
"name": "Thank",
"id": "Thank"
},
{
"name": "None",
"id": "None"
}
],
"featured": false
}
},
{
"id": "25",
"type": "task_filter_results",
"attributes": {
"name": "result",
"title": "Result",
"type": "multiselect",
"parent": "Task Details",
"default_selection": "",
"multiple": true,
"options": [
{
"name": "-- Any --",
"id": "--any--",
"placeholder": "None"
},
{
"name": "-- None --",
"id": "none"
},
{
"name": "Attempted - Left Message",
"id": "Attempted - Left Message"
},
{
"name": "Attempted",
"id": "Attempted"
},
{
"name": "Completed",
"id": "Completed"
},
{
"name": "Received",
"id": "Received"
},
{
"name": "Done",
"id": "Done"
}
],
"featured": false
}
},
{
"id": "4",
"type": "task_filter_start_ats",
"attributes": {
"name": "start_at",
"title": "Due Date",
"type": "daterange",
"parent": "Date Range Search",
"default_selection": null,
"multiple": false,
"options": [
],
"featured": false
}
},
{
"id": "27",
"type": "task_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": "9d122f65-ad8e-4c9d-841d-1f301fb1265d",
"name": "Maisie "
}
],
"featured": false
}
}
]
}Fields
data
Type
[Filter]
Description An array of Filters
Last updated