Contacts
Contacts Documentation
Contact [LIST]
Contact [LIST]
Request
Endpoint
Body
Parameters
Sorts
name
Type Unknown
Description Sort objects by name
Required No
Filters
account_list_id
Type ID string
Description Filter by Account List; Accepts Account List ID
Required No
address_historic
Type boolean
Description Filter by Address No Longer Valid; Accepts values 'true', or 'false'
Required No
address_lat_lng
Type object with ne and sw lat lng pairs
Description Filter contacts with addresses located within the lat lng bounds. Hash should contain a ne and sw lat lng pair.
Required No
address_valid
Type boolean
Description Filter where address value is false; accepts "false"
Required No
alma_mater
Type string
Description Filter by alma mater; Accepts multiple parameters, with value 'none', or an alma mater name
Required No
anniversary
Type string
Description Filter where contact people have anniversary on date between provided date range
Required No
any_tags
Type boolean
Description When filtering by tags this specifies if the filter should match tasks with any of the filtered tags if "true" or only tasks with all of the filtered tags if "false"
Required No
appeal
Type ID string
Description Filter by Appeal; Accepts multiple parameters, with value 'no_appeals', or an appeal ID
Required No
appeal_status
Type ID string
Description Filter by Pledge Status. One of excluded, asked, not_received, received_not_processed, or processed. Must be used with appeal filter.
Required No
birthday
Type string
Description Filter where contact people have birthday on date between provided date range
Required No
church
Type string
Description Filter by Church; Accepts multiple parameters, with value 'none', or a church name
Required No
city
Type string
Description Filter by City; Accepts multiple parameters, with value 'none', or a city name
Required No
contact_info_addr
Type string
Description Filter by where contact has address; Accepts values 'Yes', or 'No'
Required No
contact_info_email
Type string
Description Filter where contact people has an email; Accepts values 'Yes', or 'No'
Required No
contact_info_facebook
Type string
Description Filter where contact people has a Facebook Profile; Accepts values 'Yes', or 'No'
Required No
contact_info_mobile
Type string
Description Filter where contact people has a mobile phone; Accepts values 'Yes', or 'No'
Required No
contact_info_phone
Type string
Description Filter where contact people has a phone; Accepts values 'Yes', or 'No'
Required No
contact_info_work_phone
Type string
Description Filter where contact people has a work phone; Accepts values 'Yes', or 'No'
Required No
contact_type
Type string
Description Filter by Type; Accepts multiple parameters, with values 'person', and 'company'
Required No
country
Type string
Description Filter by Country; Accepts multiple parameters, with values 'none', or a country
Required No
created_at
Type string
Description Filter by Created At date between a provided date range
Required No
designation_account_id
Type string
Description Filter by Designation Account; accepts multiple parameters, separated by comma
Required No
donation
Type string
Description Filter by Gift Options; Accepts multiple parameters, with values 'none', 'one', 'first', and 'last'
Required No
donation_amount
Type string
Description Filter by Exact Gift Amount; Accepts multiple parameters, with values like '9.99'
Required No
donation_amount_range
Type Object
Description Filter by Gift Amount Range; Accepts object with max and min keys with decimal values { "max": "9.99", "min": "0.99" }
Required No
donation_date
Type string
Description Filter by Gift Date; Accepts date range with text value like 'MM/DD/YYYY - MM/DD/YYYY'
Required No
exclude_tags
Type string
Description Filter contacts that have any of the tags included in this filter; comma separated value for multiple
Required No
gave_more_than_pledged_range
Type date
Description Filter where contact gave more than they pledged within the provided date range
Required No
ids
Type ID string
Description Filter contacts with ids included in this filter; comma separated value for multiple
Required No
late_at
Type Unknown
Description Filter contacts by the date at which the contact started being late on payments
Required No
likely
Type string
Description Filter by Likely To Give; Accepts multiple parameters, with values 'none', 'Least Likely', 'Likely', and 'Most Likely'
Required No
locale
Type string
Description Filter by Language; Accepts multiple parameters,
Required No
metro_area
Type string
Description Filter by Metro Area; Accepts multiple parameters, with values 'none', or a metro area name
Required No
name_like
Type string
Description Filter where contact name starts with the provided value
Required No
newsletter
Type string
Description Filter by Newsletter Recipients; Accepts values 'none', 'all', 'address', 'email', and 'both'
Required No
next_ask
Type string
Description Filter by Next Ask date within the provided date range
Required No
no_appeals
Type boolean
Description Filter where contact has asked specifically not to receive appeals; accepts "true"
Required No
not_ids
Type ID string
Description Filter where contact id is not apart of the provided list of ids; accepts comma separated ids
Required No
notes
Type string
Description Filter contacts with note contents; accepts hash with wildcard_note_search parameter { "wildcard_note_search": "value to search by" }
Required No
opt_out
Type string
Description Filter where at least one contact person has opted out from email; Accepts values 'Yes', or 'No'
Required No
organization_id
Type ID string
Description filter where contact's account list has a designation account belonging to an organization; Accepts IDs separated by comma
Required No
pledge
Type string
Description Filter contacts by pledge status. completed, outstanding, pending
Required No
pledge_amount
Type string
Description Filter by Pledge Amount; Accepts multiple parameters, with values like '100.0'
Required No
pledge_amount_increased_range
Type date
Description Filter where Pledge Amount increased in the provided date range
Required No
pledge_currency
Type string
Description Filter by Pledge Currency; Accepts multiple parameters, with values like 'USD'
Required No
pledge_frequency
Type string
Description Filter by Pledge Frequency; Accepts multiple parameters, with numeric values like '0.23076923076923' (Weekly), '0.46153846153846' (Every 2 Weeks), '1.0' (Monthly), '2.0' (Every 2 Months), '3.0', '4.0', '6.0', '12.0' (Yearly), and '24.0' (Every 2 Years)
Required No
pledge_late_by
Type string
Description Filter by Late By; Accepts values '', '0_30' (Less than 30 days late), '30_60' (More than 30 days late), '60_90' (More than 60 days late), or '90' (More than 90 days late)
Required No
pledge_received
Type string
Description Filter by Pledge Received; Accepts values 'true', or 'false'
Required No
primary_address
Type string
Description Filter contacts with addresses in particular state; accepts comma separated values of either 'primary', 'active', 'inactive', 'null'
Required No
referrer
Type string
Description Filter by Referrer; Accepts multiple parameters, with values 'none', 'any', or a Contact ID
Required No
referrer_ids
Type string
Description Filter by Referrer ID; Accepts Comma separated list of Contact IDs
Required No
region
Type string
Description Filter by Region; Accepts multiple parameters, with values 'none', or a region name
Required No
related_task_action
Type string
Description Filter by Action; Accepts multiple parameters, with values 'none', or an activity type like 'Call'
Required No
source
Type Unknown
Description Filter by Source; Accepts multiple parameters
Required No
starred
Type string
Description Filter by starred, is either selected or unselected
Required No
started_giving_range
Type date
Description Filter where contact started giving in the provided date range
Required No
state
Type string
Description Filter by State; Accepts multiple parameters, with values 'none', or a state
Required No
status
Type string
Description Filter by Status; Accepts multiple parameters, with values 'active', 'hidden', 'null', 'Never Contacted', 'Ask in Future', 'Cultivate Relationship', 'Contact for Appointment', 'Appointment Scheduled', 'Call for Decision', 'Partner - Financial', 'Partner - Special', 'Partner - Pray', 'Not Interested', 'Unresponsive', 'Never Ask', 'Research Abandoned', and 'Expired Referral'
Required No
status_valid
Type string
Description Filter by Status Valid; Accepts values 'true', or 'false'
Required No
stopped_giving_range
Type date
Description Filter where contact stopped giving in the provided date range
Required No
tags
Type string
Description Filter by Tags; Accepts multiple parameters, with text values separated by comma
Required No
task_due_date
Type string
Description Filter by Due Date; Accepts date range with text value like 'MM/DD/YYYY - MM/DD/YYYY'
Required No
tasks_all_completed
Type boolean
Description Filter where contact's tasks have completed set to true; accepts "true"
Required No
timezone
Type string
Description Filter by Timezone; Accepts multiple parameters
Required No
updated_at
Type date
Description Filter contacts that were updated in this date range
Required No
user_ids
Type ID string
Description Filter contacts with user_ids included in this filter; comma separated value for multiple
Required No
wildcard_search
Type string
Description Filter contacts where subject contains this filter
Required No
Response
Headers
Body
Fields
data
Type
[Contact]
Description An array of Contacts
Contact [POST]
Contact [POST]
Request
Endpoint
Body
Parameters
Attributes
avatar
Type
string
Description The avatar url of the Contact
Required No
church_name
Type
string
Description The name of the Church for this Contact
Required No
created_at
Type
date
Description The timestamp of when this resource was created
Required No
deceased
Type
boolean
Description Whether or not the Contact is deceased
Required No
direct_deposit
Type
boolean
Description If the contact is setup for direct deposit
Required No
envelope_greeting
Type
string
Description The greeting for this Contact for use on an envelope
Required No
greeting
Type
string
Description The greeting for this contact
Required No
late_at
Type
string
Description The date at which the contact started being late on payments
Required No
locale
Type
string
Description The locale of the Contact
Required No
magazine
Type
booelan
Description Whether or not the Contact receives a magazine
Required No
missionary_pages_banner
Type
boolean
Description if front end should show banner or not
Required No
name
Type
string
Description The name of the Contact
Required No
next_ask
Type
string
Description The date of the next ask for the Contact
Required No
no_appeals
Type
boolean
Description Whether or not the Contact has no appeals
Required No
no_gift_aid
Type
boolean
Description Whether or not the Contact is eligible for Gift Aid (UK government subsidies)
Required No
notes
Type
string
Description Notes for this contact
Required No
pledge_amount
Type
float
Description The amount that the Contact has pledged
Required No
pledge_currency
Type
string
Description The currency format for the Contact's pledge
Required No
pledge_frequency
Type
float
Description The requency in which the Contact pledges
Required No
pledge_received
Type
boolean
Description Whether or not a pledge has been received for this Contact
Required No
pledge_start_date
Type
string
Description Date in which the Contact's pledge starts
Required No
preferred_contact_method
Type
string
Description Method of contact that a Contact prefers ie 'Phone Call' or 'SMS'
Required No
relationship_code
Type
string
Description The remote system relationship code to match with
Required No
send_newsletter
Type
string
Description The type of newsletter to be sent to this Contact. Physical, Email, or Both
Required No
source
Type
string
Description string that describes where the contact information came from
Required No
square_avatar
Type
string
Description A url for the Contact's avatar - but in a square format
Required No
starred_at
Type
datetime
Description Indicates is the user has starred the contact
Required No
status
Type
string
Description The partner status of the Contact
Required No
status_valid
Type
boolean
Description Whether or not the Contact's status is valid
Required No
tag_list
Type
[string]
Description A list of tags
Required No
timezone
Type
string
Description The Contact's timezone
Required No
updated_at
Type
date
Description The timestamp of when this resource was last updated
Required No
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Required No
website
Type
string
Description The website of the Contact
Required No
Relationships
account_list.data
Type
Account List
Description The account list that this Contact belongs to
Required No
appeal_contacts.data
Type
[AppealContact]
Description An array of Contact and Appeal many-to-many join records
Required No
contact_referrals_by_me.data
Type
[Contact Referral]
Description An array of Contact Referrals references the Contacts that were referred by the current Contact
Required No
contact_referrals_to_me.data
Type
[Contact Referral]
Description An array of Contact Referrals references the Contacts that referred the current Contact
Required No
excluded_appeal_contacts.data
Type
[AppealContact]
Description An array of Contact and Appeal (excluded) many-to-many join records
Required No
pledges.data
Type
[Pledge]
Description An array of Pledges contact has made to appeals
Required No
primary_or_first_person.data
Type
Person
Description The primary person, if none set then the first person
Required No
primary_person.data
Type
Person
Description The primary person
Required No
spouse.data
Type
Person
Description The spouse of the primary person
Required No
user.data
Type
User
Description The user assigned to this contact
Required No
Response
Headers
Body
Fields
Attributes
avatar
Type
string
Description The avatar url of the Contact
church_name
Type
string
Description The name of the Church for this Contact
created_at
Type
date
Description The timestamp of when this resource was created
deceased
Type
boolean
Description Whether or not the Contact is deceased
direct_deposit
Type
boolean
Description If the contact is setup for direct deposit
envelope_greeting
Type
string
Description The greeting for this Contact for use on an envelope
greeting
Type
string
Description The greeting for this contact
last_activity
Type
string
Description The date of the last activity for the Contact
last_appointment
Type
string
Description The date of the last appointment for the Contact
last_donation
Type
string
Description The donation object of the last donation
last_letter
Type
string
Description The date of the last letter for the Contact
last_phone_call
Type
string
Description The date of the last phone call for the Contact
last_pre_call
Type
string
Description The date of the last pre-phone call for the Contact
last_thank
Type
string
Description The date of the last thank you for the Contact
late_at
Type
string
Description The date at which the contact started being late on payments
lifetime_donations
Type
number
Description Total donation amount
likely_to_give
Type
boolean
Description Whether or not the Contact is likely to give
locale
Type
string
Description The locale of the Contact
magazine
Type
booelan
Description Whether or not the Contact receives a magazine
missionary_pages_banner
Type
boolean
Description if front end should show banner or not
name
Type
string
Description The name of the Contact
next_ask
Type
string
Description The date of the next ask for the Contact
no_appeals
Type
boolean
Description Whether or not the Contact has no appeals
no_gift_aid
Type
boolean
Description Whether or not the Contact is eligible for Gift Aid (UK government subsidies)
notes
Type
string
Description Notes for this contact
notes_saved_at
Type
string
Description the datetime of when the notes for this Contact were last saved
pledge_amount
Type
float
Description The amount that the Contact has pledged
pledge_currency
Type
string
Description The currency format for the Contact's pledge
pledge_currency_symbol
Type
string
Description The symbol that represents the currency format for the Contact's pledge
pledge_frequency
Type
float
Description The requency in which the Contact pledges
pledge_received
Type
boolean
Description Whether or not a pledge has been received for this Contact
pledge_start_date
Type
string
Description Date in which the Contact's pledge starts
preferred_contact_method
Type
string
Description Method of contact that a Contact prefers ie 'Phone Call' or 'SMS'
relationship_code
Type
string
Description The remote system relationship code to match with
send_newsletter
Type
string
Description The type of newsletter to be sent to this Contact. Physical, Email, or Both
source
Type
string
Description string that describes where the contact information came from
square_avatar
Type
string
Description A url for the Contact's avatar - but in a square format
starred_at
Type
datetime
Description Indicates is the user has starred the contact
status
Type
string
Description The partner status of the Contact
status_valid
Type
boolean
Description Whether or not the Contact's status is valid
suggested_changes
Type
string
Description thing
tag_list
Type
[string]
Description A list of tags
timezone
Type
string
Description The Contact's timezone
uncompleted_tasks_count
Type
number
Description The number of uncompleted tasks for this Contact
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
website
Type
string
Description The website of the Contact
Relationships
account_list.data
Type
Account List
Description The account list that this Contact belongs to
addresses.data
Type
[Address]
Description An array of Address references for the Contact
appeal_contacts.data
Type
[AppealContact]
Description An array of Contact and Appeal many-to-many join records
appeals.data
Type
[Appeal]
Description An array of Appeal references for the Contact
contact_referrals_by_me.data
Type
[Contact Referral]
Description An array of Contact Referrals references the Contacts that were referred by the current Contact
contact_referrals_to_me.data
Type
[Contact Referral]
Description An array of Contact Referrals references the Contacts that referred the current Contact
contacts_referred_by_me.data
Type
[Contact]
Description An array of referred Contact references for the Contact
contacts_that_referred_me.data
Type
[Contact]
Description An array of Contact referral references for the Contact
donor_accounts.data
Type
[Donor Account]
Description An array of Donor Account references for the Contact
excluded_appeal_contacts.data
Type
[AppealContact]
Description An array of Contact and Appeal (excluded) many-to-many join records
last_six_donations.data
Type
[Donation]
Description An array of the last six Donation references for the Contact
people.data
Type
[Person]
Description An array of People references for the Contact
pledges.data
Type
[Pledge]
Description An array of Pledges contact has made to appeals
primary_or_first_person.data
Type
Person
Description The primary person, if none set then the first person
primary_person.data
Type
Person
Description The primary person
spouse.data
Type
Person
Description The spouse of the primary person
tasks.data
Type
[Tasks]
Description An array of Tasks references for the Contact
user.data
Type
User
Description The user assigned to this contact
Contact [GET]
Contact [GET]
Request
Endpoint
Body
Response
Headers
Body
Fields
Attributes
avatar
Type
string
Description The avatar url of the Contact
church_name
Type
string
Description The name of the Church for this Contact
created_at
Type
date
Description The timestamp of when this resource was created
deceased
Type
boolean
Description Whether or not the Contact is deceased
direct_deposit
Type
boolean
Description If the contact is setup for direct deposit
envelope_greeting
Type
string
Description The greeting for this Contact for use on an envelope
greeting
Type
string
Description The greeting for this contact
last_activity
Type
string
Description The date of the last activity for the Contact
last_appointment
Type
string
Description The date of the last appointment for the Contact
last_donation
Type
string
Description The donation object of the last donation
last_letter
Type
string
Description The date of the last letter for the Contact
last_phone_call
Type
string
Description The date of the last phone call for the Contact
last_pre_call
Type
string
Description The date of the last pre-phone call for the Contact
last_thank
Type
string
Description The date of the last thank you for the Contact
late_at
Type
string
Description The date at which the contact started being late on payments
lifetime_donations
Type
number
Description Total donation amount
likely_to_give
Type
boolean
Description Whether or not the Contact is likely to give
locale
Type
string
Description The locale of the Contact
magazine
Type
booelan
Description Whether or not the Contact receives a magazine
missionary_pages_banner
Type
boolean
Description if front end should show banner or not
name
Type
string
Description The name of the Contact
next_ask
Type
string
Description The date of the next ask for the Contact
no_appeals
Type
boolean
Description Whether or not the Contact has no appeals
no_gift_aid
Type
boolean
Description Whether or not the Contact is eligible for Gift Aid (UK government subsidies)
notes
Type
string
Description Notes for this contact
notes_saved_at
Type
string
Description the datetime of when the notes for this Contact were last saved
pledge_amount
Type
float
Description The amount that the Contact has pledged
pledge_currency
Type
string
Description The currency format for the Contact's pledge
pledge_currency_symbol
Type
string
Description The symbol that represents the currency format for the Contact's pledge
pledge_frequency
Type
float
Description The requency in which the Contact pledges
pledge_received
Type
boolean
Description Whether or not a pledge has been received for this Contact
pledge_start_date
Type
string
Description Date in which the Contact's pledge starts
preferred_contact_method
Type
string
Description Method of contact that a Contact prefers ie 'Phone Call' or 'SMS'
relationship_code
Type
string
Description The remote system relationship code to match with
send_newsletter
Type
string
Description The type of newsletter to be sent to this Contact. Physical, Email, or Both
source
Type
string
Description string that describes where the contact information came from
square_avatar
Type
string
Description A url for the Contact's avatar - but in a square format
starred_at
Type
datetime
Description Indicates is the user has starred the contact
status
Type
string
Description The partner status of the Contact
status_valid
Type
boolean
Description Whether or not the Contact's status is valid
suggested_changes
Type
string
Description thing
tag_list
Type
[string]
Description A list of tags
timezone
Type
string
Description The Contact's timezone
uncompleted_tasks_count
Type
number
Description The number of uncompleted tasks for this Contact
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
website
Type
string
Description The website of the Contact
Relationships
account_list.data
Type
Account List
Description The account list that this Contact belongs to
addresses.data
Type
[Address]
Description An array of Address references for the Contact
appeal_contacts.data
Type
[AppealContact]
Description An array of Contact and Appeal many-to-many join records
appeals.data
Type
[Appeal]
Description An array of Appeal references for the Contact
contact_referrals_by_me.data
Type
[Contact Referral]
Description An array of Contact Referrals references the Contacts that were referred by the current Contact
contact_referrals_to_me.data
Type
[Contact Referral]
Description An array of Contact Referrals references the Contacts that referred the current Contact
contacts_referred_by_me.data
Type
[Contact]
Description An array of referred Contact references for the Contact
contacts_that_referred_me.data
Type
[Contact]
Description An array of Contact referral references for the Contact
donor_accounts.data
Type
[Donor Account]
Description An array of Donor Account references for the Contact
excluded_appeal_contacts.data
Type
[AppealContact]
Description An array of Contact and Appeal (excluded) many-to-many join records
last_six_donations.data
Type
[Donation]
Description An array of the last six Donation references for the Contact
people.data
Type
[Person]
Description An array of People references for the Contact
pledges.data
Type
[Pledge]
Description An array of Pledges contact has made to appeals
primary_or_first_person.data
Type
Person
Description The primary person, if none set then the first person
primary_person.data
Type
Person
Description The primary person
spouse.data
Type
Person
Description The spouse of the primary person
tasks.data
Type
[Tasks]
Description An array of Tasks references for the Contact
user.data
Type
User
Description The user assigned to this contact
Contact [PUT]
Contact [PUT]
Request
Endpoint
Body
Parameters
Attributes
avatar
Type
string
Description The avatar url of the Contact
Required No
church_name
Type
string
Description The name of the Church for this Contact
Required No
created_at
Type
date
Description The timestamp of when this resource was created
Required No
deceased
Type
boolean
Description Whether or not the Contact is deceased
Required No
direct_deposit
Type
boolean
Description If the contact is setup for direct deposit
Required No
envelope_greeting
Type
string
Description The greeting for this Contact for use on an envelope
Required No
greeting
Type
string
Description The greeting for this contact
Required No
late_at
Type
string
Description The date at which the contact started being late on payments
Required No
locale
Type
string
Description The locale of the Contact
Required No
magazine
Type
booelan
Description Whether or not the Contact receives a magazine
Required No
missionary_pages_banner
Type
boolean
Description if front end should show banner or not
Required No
name
Type
string
Description The name of the Contact
Required No
next_ask
Type
string
Description The date of the next ask for the Contact
Required No
no_appeals
Type
boolean
Description Whether or not the Contact has no appeals
Required No
no_gift_aid
Type
boolean
Description Whether or not the Contact is eligible for Gift Aid (UK government subsidies)
Required No
notes
Type
string
Description Notes for this contact
Required No
overwrite
Type
boolean
Description
Only used for updating a record where you want to ignore the server's ' 'updated_in_db_at value and force overwrite the values for the record. ' 'Must be true to work.
Required No
pledge_amount
Type
float
Description The amount that the Contact has pledged
Required No
pledge_currency
Type
string
Description The currency format for the Contact's pledge
Required No
pledge_frequency
Type
float
Description The requency in which the Contact pledges
Required No
pledge_received
Type
boolean
Description Whether or not a pledge has been received for this Contact
Required No
pledge_start_date
Type
string
Description Date in which the Contact's pledge starts
Required No
preferred_contact_method
Type
string
Description Method of contact that a Contact prefers ie 'Phone Call' or 'SMS'
Required No
relationship_code
Type
string
Description The remote system relationship code to match with
Required No
send_newsletter
Type
string
Description The type of newsletter to be sent to this Contact. Physical, Email, or Both
Required No
source
Type
string
Description string that describes where the contact information came from
Required No
square_avatar
Type
string
Description A url for the Contact's avatar - but in a square format
Required No
starred_at
Type
datetime
Description Indicates is the user has starred the contact
Required No
status
Type
string
Description The partner status of the Contact
Required No
status_valid
Type
boolean
Description Whether or not the Contact's status is valid
Required No
tag_list
Type
[string]
Description A list of tags
Required No
timezone
Type
string
Description The Contact's timezone
Required No
updated_at
Type
date
Description The timestamp of when this resource was last updated
Required No
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
Required No
website
Type
string
Description The website of the Contact
Required No
Relationships
account_list.data
Type
Account List
Description The account list that this Contact belongs to
Required No
appeal_contacts.data
Type
[AppealContact]
Description An array of Contact and Appeal many-to-many join records
Required No
contact_referrals_by_me.data
Type
[Contact Referral]
Description An array of Contact Referrals references the Contacts that were referred by the current Contact
Required No
contact_referrals_to_me.data
Type
[Contact Referral]
Description An array of Contact Referrals references the Contacts that referred the current Contact
Required No
excluded_appeal_contacts.data
Type
[AppealContact]
Description An array of Contact and Appeal (excluded) many-to-many join records
Required No
pledges.data
Type
[Pledge]
Description An array of Pledges contact has made to appeals
Required No
primary_or_first_person.data
Type
Person
Description The primary person, if none set then the first person
Required No
primary_person.data
Type
Person
Description The primary person
Required No
spouse.data
Type
Person
Description The spouse of the primary person
Required No
user.data
Type
User
Description The user assigned to this contact
Required No
Response
Headers
Body
Fields
Attributes
avatar
Type
string
Description The avatar url of the Contact
church_name
Type
string
Description The name of the Church for this Contact
created_at
Type
date
Description The timestamp of when this resource was created
deceased
Type
boolean
Description Whether or not the Contact is deceased
direct_deposit
Type
boolean
Description If the contact is setup for direct deposit
envelope_greeting
Type
string
Description The greeting for this Contact for use on an envelope
greeting
Type
string
Description The greeting for this contact
last_activity
Type
string
Description The date of the last activity for the Contact
last_appointment
Type
string
Description The date of the last appointment for the Contact
last_donation
Type
string
Description The donation object of the last donation
last_letter
Type
string
Description The date of the last letter for the Contact
last_phone_call
Type
string
Description The date of the last phone call for the Contact
last_pre_call
Type
string
Description The date of the last pre-phone call for the Contact
last_thank
Type
string
Description The date of the last thank you for the Contact
late_at
Type
string
Description The date at which the contact started being late on payments
lifetime_donations
Type
number
Description Total donation amount
likely_to_give
Type
boolean
Description Whether or not the Contact is likely to give
locale
Type
string
Description The locale of the Contact
magazine
Type
booelan
Description Whether or not the Contact receives a magazine
missionary_pages_banner
Type
boolean
Description if front end should show banner or not
name
Type
string
Description The name of the Contact
next_ask
Type
string
Description The date of the next ask for the Contact
no_appeals
Type
boolean
Description Whether or not the Contact has no appeals
no_gift_aid
Type
boolean
Description Whether or not the Contact is eligible for Gift Aid (UK government subsidies)
notes
Type
string
Description Notes for this contact
notes_saved_at
Type
string
Description the datetime of when the notes for this Contact were last saved
pledge_amount
Type
float
Description The amount that the Contact has pledged
pledge_currency
Type
string
Description The currency format for the Contact's pledge
pledge_currency_symbol
Type
string
Description The symbol that represents the currency format for the Contact's pledge
pledge_frequency
Type
float
Description The requency in which the Contact pledges
pledge_received
Type
boolean
Description Whether or not a pledge has been received for this Contact
pledge_start_date
Type
string
Description Date in which the Contact's pledge starts
preferred_contact_method
Type
string
Description Method of contact that a Contact prefers ie 'Phone Call' or 'SMS'
relationship_code
Type
string
Description The remote system relationship code to match with
send_newsletter
Type
string
Description The type of newsletter to be sent to this Contact. Physical, Email, or Both
source
Type
string
Description string that describes where the contact information came from
square_avatar
Type
string
Description A url for the Contact's avatar - but in a square format
starred_at
Type
datetime
Description Indicates is the user has starred the contact
status
Type
string
Description The partner status of the Contact
status_valid
Type
boolean
Description Whether or not the Contact's status is valid
suggested_changes
Type
string
Description thing
tag_list
Type
[string]
Description A list of tags
timezone
Type
string
Description The Contact's timezone
uncompleted_tasks_count
Type
number
Description The number of uncompleted tasks for this Contact
updated_at
Type
date
Description The timestamp of when this resource was last updated
updated_in_db_at
Type
date
Description This is to be used as a reference for the last time the resource was updated in the remote database - specifically for when data is updated while the client is offline.
website
Type
string
Description The website of the Contact
Relationships
account_list.data
Type
Account List
Description The account list that this Contact belongs to
addresses.data
Type
[Address]
Description An array of Address references for the Contact
appeal_contacts.data
Type
[AppealContact]
Description An array of Contact and Appeal many-to-many join records
appeals.data
Type
[Appeal]
Description An array of Appeal references for the Contact
contact_referrals_by_me.data
Type
[Contact Referral]
Description An array of Contact Referrals references the Contacts that were referred by the current Contact
contact_referrals_to_me.data
Type
[Contact Referral]
Description An array of Contact Referrals references the Contacts that referred the current Contact
contacts_referred_by_me.data
Type
[Contact]
Description An array of referred Contact references for the Contact
contacts_that_referred_me.data
Type
[Contact]
Description An array of Contact referral references for the Contact
donor_accounts.data
Type
[Donor Account]
Description An array of Donor Account references for the Contact
excluded_appeal_contacts.data
Type
[AppealContact]
Description An array of Contact and Appeal (excluded) many-to-many join records
last_six_donations.data
Type
[Donation]
Description An array of the last six Donation references for the Contact
people.data
Type
[Person]
Description An array of People references for the Contact
pledges.data
Type
[Pledge]
Description An array of Pledges contact has made to appeals
primary_or_first_person.data
Type
Person
Description The primary person, if none set then the first person
primary_person.data
Type
Person
Description The primary person
spouse.data
Type
Person
Description The spouse of the primary person
tasks.data
Type
[Tasks]
Description An array of Tasks references for the Contact
user.data
Type
User
Description The user assigned to this contact
Contact [DELETE]
Contact [DELETE]
Request
Endpoint
Body
Response
Headers
Body
Last updated