People
People Documentation
Person [LIST]
Person [LIST]
Request
Endpoint
GET /api/v2/contacts/55b92c67-5105-4e96-aa97-99d35977838c/people
Content-Type: application/vnd.api+jsonBody
Parameters
Filters
account_list_id
Type ID string
Description Filter by Account List; accepts an Account List ID
Required No
contact_status
Type Unknown
Description Filter by Contact 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
deceased
Type boolean
Description Filter by deceased; Accepts values "true" and "false"
Required No
email_address_valid
Type boolean
Description Filter by Email Address Invalid; A Person's Email Address is invalid if the Email Address's valid_values attribute is set to false, or if the Person has multiple Email Addresses marked as primary; Accepts value "false"
Required No
phone_number_valid
Type boolean
Description Filter by Phone Number Invalid; A Person's Phone Number is invalid if the Phone Number's valid_values attribute is set to false, or if the Person has multiple Phone Numbers marked as primary; Accepts value "false"
Required No
updated_at
Type date
Description Filter by Updated At Date range; Accepts date range with text value like "MM/DD/YYYY - MM/DD/YYYY"
Required No
wildcard_search
Type string
Description Filter by keyword, searches through name, email_addresses and phone_numbers
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": [
{
"id": "8f1be655-56d6-4cee-84df-14220b4c8fbb",
"type": "people",
"attributes": {
"alma_mater": null,
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2022-01-12T17:18:11Z",
"deceased": false,
"employer": null,
"first_name": "Cleotilde",
"gender": null,
"last_name": "Borer",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"55b92c67-5105-4e96-aa97-99d35977838c"
],
"suffix": null,
"title": null,
"updated_at": "2022-01-12T17:18:11Z",
"updated_in_db_at": "2022-01-12T17:18:11Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
],
"meta": {
"pagination": {
"page": 1,
"per_page": 25,
"total_count": 1,
"total_pages": 1
},
"sort": null,
"filter": {
}
}
}Fields
data
Type
[Person]
Description An array of People
Person [POST]
Person [POST]
Request
Endpoint
POST /api/v2/contacts/147c316e-234f-46fc-a168-2459097dcf9a/people
Content-Type: application/vnd.api+jsonBody
{
"data": {
"type": "people",
"attributes": {
"first_name": "Mpdx",
"last_name": "Jast",
"title": "Mr",
"updated_in_db_at": "2022-01-12 17:18:12 UTC"
}
}
}Parameters
Attributes
alma_mater
Type
string
Description The college a person graduated from
Required No
anniversary_day
Type
number
Description Anniversary Day
Required No
anniversary_month
Type
number
Description Anniversary Month
Required No
anniversary_year
Type
number
Description Anniversary Year
Required No
avatar
Type
string
Description Avatar
Required No
birthday_day
Type
number
Description Birthday Day
Required No
birthday_month
Type
number
Description Birthday Month
Required No
birthday_year
Type
number
Description Birthday Year
Required No
created_at
Type
string
Description Created At
Required No
deceased
Type
boolean
Description Deceased
Required No
employer
Type
string
Description Employer
Required No
first_name
Type
string
Description First Name
Required No
gender
Type
string
Description Gender
Required No
last_name
Type
string
Description Last Name
Required No
legal_first_name
Type
string
Description Legal First Name
Required No
marital_status
Type
string
Description Marital Status
Required No
middle_name
Type
string
Description Middle Name
Required No
occupation
Type
string
Description Occupation
Required No
optout_enewsletter
Type
boolean
Description Optout of enewsletter
Required No
parent_contacts
Type
[Contact]
Description Parent contacts of this person
Required No
suffix
Type
string
Description Suffix
Required No
title
Type
string
Description Title
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
Relationships
email_addresses.data
Type
[Email Address]
Description Array of email_addresses
Required No
facebook_accounts.data
Type
[Facebook Account]
Description Array of facebook_accounts
Required No
family_relationships.data
Type
[Family Relationship]
Description Array of family relationships
Required No
linkedin_accounts.data
Type
[Linkedin Account]
Description Array of linkedin accounts
Required No
phone_numbers.data
Type
[Phone Number]
Description Array of phone numbers
Required No
twitter_accounts.data
Type
[Twitter Account]
Description Array of twitter accounts
Required No
websites.data
Type
[Website]
Description Array of websites
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
201 CreatedBody
{
"data": {
"id": "4c5f00ee-c340-4385-bb6e-09d0ea3e1f6a",
"type": "people",
"attributes": {
"alma_mater": null,
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2022-01-12T17:18:12Z",
"deceased": false,
"employer": null,
"first_name": "Mpdx",
"gender": null,
"last_name": "Jast",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"147c316e-234f-46fc-a168-2459097dcf9a"
],
"suffix": null,
"title": "Mr.",
"updated_at": "2022-01-12T17:18:12Z",
"updated_in_db_at": "2022-01-12T17:18:12Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}Fields
Attributes
alma_mater
Type
string
Description The college a person graduated from
anniversary_day
Type
number
Description Anniversary Day
anniversary_month
Type
number
Description Anniversary Month
anniversary_year
Type
number
Description Anniversary Year
avatar
Type
string
Description Avatar
birthday_day
Type
number
Description Birthday Day
birthday_month
Type
number
Description Birthday Month
birthday_year
Type
number
Description Birthday Year
created_at
Type
string
Description Created At
deceased
Type
boolean
Description Deceased
employer
Type
string
Description Employer
first_name
Type
string
Description First Name
gender
Type
string
Description Gender
last_name
Type
string
Description Last Name
legal_first_name
Type
string
Description Legal First Name
marital_status
Type
string
Description Marital Status
middle_name
Type
string
Description Middle Name
occupation
Type
string
Description Occupation
optout_enewsletter
Type
boolean
Description Optout of enewsletter
parent_contacts
Type
[Contact]
Description Parent contacts of this person
suffix
Type
string
Description Suffix
title
Type
string
Description Title
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.
Relationships
email_addresses.data
Type
[Email Address]
Description Array of email_addresses
facebook_accounts.data
Type
[Facebook Account]
Description Array of facebook_accounts
family_relationships.data
Type
[Family Relationship]
Description Array of family relationships
linkedin_accounts.data
Type
[Linkedin Account]
Description Array of linkedin accounts
phone_numbers.data
Type
[Phone Number]
Description Array of phone numbers
twitter_accounts.data
Type
[Twitter Account]
Description Array of twitter accounts
websites.data
Type
[Website]
Description Array of websites
Person [GET]
Person [GET]
Request
Endpoint
GET /api/v2/contacts/8dc849de-428b-47ae-8cb2-b960c06d0aba/people/2a459fcf-9c02-4021-b17e-7c07c998c6ad
Content-Type: application/vnd.api+jsonBody
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": {
"id": "2a459fcf-9c02-4021-b17e-7c07c998c6ad",
"type": "people",
"attributes": {
"alma_mater": null,
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2022-01-12T17:18:10Z",
"deceased": false,
"employer": null,
"first_name": "Arthur",
"gender": null,
"last_name": "Lehner",
"legal_first_name": null,
"marital_status": null,
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"8dc849de-428b-47ae-8cb2-b960c06d0aba"
],
"suffix": null,
"title": null,
"updated_at": "2022-01-12T17:18:10Z",
"updated_in_db_at": "2022-01-12T17:18:10Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}Fields
Attributes
alma_mater
Type
string
Description The college a person graduated from
anniversary_day
Type
number
Description Anniversary Day
anniversary_month
Type
number
Description Anniversary Month
anniversary_year
Type
number
Description Anniversary Year
avatar
Type
string
Description Avatar
birthday_day
Type
number
Description Birthday Day
birthday_month
Type
number
Description Birthday Month
birthday_year
Type
number
Description Birthday Year
created_at
Type
string
Description Created At
deceased
Type
boolean
Description Deceased
employer
Type
string
Description Employer
first_name
Type
string
Description First Name
gender
Type
string
Description Gender
last_name
Type
string
Description Last Name
legal_first_name
Type
string
Description Legal First Name
marital_status
Type
string
Description Marital Status
middle_name
Type
string
Description Middle Name
occupation
Type
string
Description Occupation
optout_enewsletter
Type
boolean
Description Optout of enewsletter
parent_contacts
Type
[Contact]
Description Parent contacts of this person
suffix
Type
string
Description Suffix
title
Type
string
Description Title
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.
Relationships
email_addresses.data
Type
[Email Address]
Description Array of email_addresses
facebook_accounts.data
Type
[Facebook Account]
Description Array of facebook_accounts
family_relationships.data
Type
[Family Relationship]
Description Array of family relationships
linkedin_accounts.data
Type
[Linkedin Account]
Description Array of linkedin accounts
phone_numbers.data
Type
[Phone Number]
Description Array of phone numbers
twitter_accounts.data
Type
[Twitter Account]
Description Array of twitter accounts
websites.data
Type
[Website]
Description Array of websites
Person [PUT]
Person [PUT]
Request
Endpoint
PUT /api/v2/contacts/2089a9bc-b2ee-4967-940d-09ebc40457f7/people/8d60603c-306b-4235-8399-dd3b48cffd01
Content-Type: application/vnd.api+jsonBody
{
"included": [
{
"attributes": {
"relationship": "Nephew"
},
"relationships": {
"related_person": {
"data": {
"type": "people",
"id": "89a28dd4-fc5a-43f5-892d-7101f42d4f59"
}
}
},
"type": "family_relationships",
"id": "ce1e9746-2b34-4d3d-9357-292a950e681a"
}
],
"data": {
"relationships": {
"linkedin_accounts": {
"data": null
},
"facebook_accounts": {
"data": null
},
"family_relationships": {
"data": [
{
"type": "family_relationships",
"id": "ce1e9746-2b34-4d3d-9357-292a950e681a"
}
]
},
"websites": {
"data": null
},
"email_addresses": {
"data": null
}
},
"attributes": {
"birthday_year": null,
"first_name": "new",
"last_name": "person",
"middle_name": null,
"suffix": null,
"title": null,
"gender": "female",
"created_at": "2022-01-12 17:18:12 UTC",
"marital_status": "Married",
"updated_at": "2022-01-12 17:18:12 UTC",
"anniversary_day": null,
"anniversary_month": null,
"birthday_day": null,
"overwrite": true,
"anniversary_year": null,
"birthday_month": null,
"deceased": false
},
"type": "people",
"id": "8d60603c-306b-4235-8399-dd3b48cffd01"
}
}Parameters
Attributes
alma_mater
Type
string
Description The college a person graduated from
Required No
anniversary_day
Type
number
Description Anniversary Day
Required No
anniversary_month
Type
number
Description Anniversary Month
Required No
anniversary_year
Type
number
Description Anniversary Year
Required No
avatar
Type
string
Description Avatar
Required No
birthday_day
Type
number
Description Birthday Day
Required No
birthday_month
Type
number
Description Birthday Month
Required No
birthday_year
Type
number
Description Birthday Year
Required No
created_at
Type
string
Description Created At
Required No
deceased
Type
boolean
Description Deceased
Required No
employer
Type
string
Description Employer
Required No
first_name
Type
string
Description First Name
Required No
gender
Type
string
Description Gender
Required No
last_name
Type
string
Description Last Name
Required No
legal_first_name
Type
string
Description Legal First Name
Required No
marital_status
Type
string
Description Marital Status
Required No
middle_name
Type
string
Description Middle Name
Required No
occupation
Type
string
Description Occupation
Required No
optout_enewsletter
Type
boolean
Description Optout of enewsletter
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
parent_contacts
Type
[Contact]
Description Parent contacts of this person
Required No
suffix
Type
string
Description Suffix
Required No
title
Type
string
Description Title
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
Relationships
email_addresses.data
Type
[Email Address]
Description Array of email_addresses
Required No
facebook_accounts.data
Type
[Facebook Account]
Description Array of facebook_accounts
Required No
family_relationships.data
Type
[Family Relationship]
Description Array of family relationships
Required No
linkedin_accounts.data
Type
[Linkedin Account]
Description Array of linkedin accounts
Required No
phone_numbers.data
Type
[Phone Number]
Description Array of phone numbers
Required No
twitter_accounts.data
Type
[Twitter Account]
Description Array of twitter accounts
Required No
websites.data
Type
[Website]
Description Array of websites
Required No
Response
Headers
Content-Type: application/vnd.api+json; charset=utf-8
200 OKBody
{
"data": {
"id": "8d60603c-306b-4235-8399-dd3b48cffd01",
"type": "people",
"attributes": {
"alma_mater": null,
"anniversary_day": null,
"anniversary_month": null,
"anniversary_year": null,
"avatar": "https://mpdx.org/images/avatar_f.png",
"birthday_day": null,
"birthday_month": null,
"birthday_year": null,
"created_at": "2022-01-12T17:18:12Z",
"deceased": false,
"employer": null,
"first_name": "new",
"gender": "female",
"last_name": "person",
"legal_first_name": null,
"marital_status": "Married",
"middle_name": null,
"occupation": null,
"optout_enewsletter": false,
"parent_contacts": [
"2089a9bc-b2ee-4967-940d-09ebc40457f7"
],
"suffix": null,
"title": null,
"updated_at": "2022-01-12T17:18:12Z",
"updated_in_db_at": "2022-01-12T17:18:12Z"
},
"relationships": {
"email_addresses": {
"data": [
]
},
"facebook_accounts": {
"data": [
]
},
"family_relationships": {
"data": [
{
"id": "ce1e9746-2b34-4d3d-9357-292a950e681a",
"type": "family_relationships"
}
]
},
"linkedin_accounts": {
"data": [
]
},
"phone_numbers": {
"data": [
]
},
"twitter_accounts": {
"data": [
]
},
"websites": {
"data": [
]
}
}
}
}Fields
Attributes
alma_mater
Type
string
Description The college a person graduated from
anniversary_day
Type
number
Description Anniversary Day
anniversary_month
Type
number
Description Anniversary Month
anniversary_year
Type
number
Description Anniversary Year
avatar
Type
string
Description Avatar
birthday_day
Type
number
Description Birthday Day
birthday_month
Type
number
Description Birthday Month
birthday_year
Type
number
Description Birthday Year
created_at
Type
string
Description Created At
deceased
Type
boolean
Description Deceased
employer
Type
string
Description Employer
first_name
Type
string
Description First Name
gender
Type
string
Description Gender
last_name
Type
string
Description Last Name
legal_first_name
Type
string
Description Legal First Name
marital_status
Type
string
Description Marital Status
middle_name
Type
string
Description Middle Name
occupation
Type
string
Description Occupation
optout_enewsletter
Type
boolean
Description Optout of enewsletter
parent_contacts
Type
[Contact]
Description Parent contacts of this person
suffix
Type
string
Description Suffix
title
Type
string
Description Title
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.
Relationships
email_addresses.data
Type
[Email Address]
Description Array of email_addresses
facebook_accounts.data
Type
[Facebook Account]
Description Array of facebook_accounts
family_relationships.data
Type
[Family Relationship]
Description Array of family relationships
linkedin_accounts.data
Type
[Linkedin Account]
Description Array of linkedin accounts
phone_numbers.data
Type
[Phone Number]
Description Array of phone numbers
twitter_accounts.data
Type
[Twitter Account]
Description Array of twitter accounts
websites.data
Type
[Website]
Description Array of websites
Person [DELETE]
Person [DELETE]
Request
Endpoint
DELETE /api/v2/contacts/630c5157-abe8-4e33-a53f-c9809a9d718f/people/02133d4f-61c9-4a73-8beb-c41d009f2eba
Content-Type: application/vnd.api+jsonBody
Response
Headers
204 No ContentBody
Last updated