People

People Documentation

Person [LIST]

Person [LIST]

Request

Endpoint

GET /api/v2/contacts/c2822a72-9236-4889-9a62-c7ffa748a770/people
Content-Type: application/vnd.api+json

Body

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 OK

Body

{
  "data": [
    {
      "id": "7265a92e-bbad-4cf1-94b7-c5afba86afc6",
      "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": "2021-11-23T14:37:54Z",
        "deceased": false,
        "employer": null,
        "first_name": "Bennett",
        "gender": null,
        "last_name": "Harvey",
        "legal_first_name": null,
        "marital_status": null,
        "middle_name": null,
        "occupation": null,
        "optout_enewsletter": false,
        "parent_contacts": [
          "c2822a72-9236-4889-9a62-c7ffa748a770"
        ],
        "suffix": null,
        "title": null,
        "updated_at": "2021-11-23T14:37:54Z",
        "updated_in_db_at": "2021-11-23T14:37:54Z"
      },
      "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/bcf27865-b062-4608-89ec-4552482fd10f/people
Content-Type: application/vnd.api+json

Body

{
  "data": {
    "type": "people",
    "attributes": {
      "first_name": "Mpdx",
      "last_name": "Langworth",
      "title": "Mr",
      "updated_in_db_at": "2021-11-23 14:37:55 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 Created

Body

{
  "data": {
    "id": "2cb2918c-c9c7-4515-bd4d-9213ef10174c",
    "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": "2021-11-23T14:37:55Z",
      "deceased": false,
      "employer": null,
      "first_name": "Mpdx",
      "gender": null,
      "last_name": "Langworth",
      "legal_first_name": null,
      "marital_status": null,
      "middle_name": null,
      "occupation": null,
      "optout_enewsletter": false,
      "parent_contacts": [
        "bcf27865-b062-4608-89ec-4552482fd10f"
      ],
      "suffix": null,
      "title": "Mr.",
      "updated_at": "2021-11-23T14:37:55Z",
      "updated_in_db_at": "2021-11-23T14:37:55Z"
    },
    "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/12129acb-2e41-4fa4-99ee-0c87c1516b0c/people/22d4f727-97cc-4081-8001-2a4b4772d157
Content-Type: application/vnd.api+json

Body

Response

Headers

Content-Type: application/vnd.api+json; charset=utf-8
200 OK

Body

{
  "data": {
    "id": "22d4f727-97cc-4081-8001-2a4b4772d157",
    "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": "2021-11-23T14:37:55Z",
      "deceased": false,
      "employer": null,
      "first_name": "Abe",
      "gender": null,
      "last_name": "MacGyver",
      "legal_first_name": null,
      "marital_status": null,
      "middle_name": null,
      "occupation": null,
      "optout_enewsletter": false,
      "parent_contacts": [
        "12129acb-2e41-4fa4-99ee-0c87c1516b0c"
      ],
      "suffix": null,
      "title": null,
      "updated_at": "2021-11-23T14:37:55Z",
      "updated_in_db_at": "2021-11-23T14:37:55Z"
    },
    "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/9aea881b-d7d3-4be3-bf33-56c4d3b242ce/people/fdd53ae4-6500-4a3e-82bd-f8e2f8b5cdca
Content-Type: application/vnd.api+json

Body

{
  "included": [
    {
      "attributes": {
        "relationship": "Nephew"
      },
      "relationships": {
        "related_person": {
          "data": {
            "type": "people",
            "id": "6c487a7a-53e8-488c-a2ba-023920f154be"
          }
        }
      },
      "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": "2021-11-23 14:37:54 UTC",
      "marital_status": "Married",
      "updated_at": "2021-11-23 14:37:54 UTC",
      "anniversary_day": null,
      "anniversary_month": null,
      "birthday_day": null,
      "overwrite": true,
      "anniversary_year": null,
      "birthday_month": null,
      "deceased": false
    },
    "type": "people",
    "id": "fdd53ae4-6500-4a3e-82bd-f8e2f8b5cdca"
  }
}

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 OK

Body

{
  "data": {
    "id": "fdd53ae4-6500-4a3e-82bd-f8e2f8b5cdca",
    "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": "2021-11-23T14:37:54Z",
      "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": [
        "9aea881b-d7d3-4be3-bf33-56c4d3b242ce"
      ],
      "suffix": null,
      "title": null,
      "updated_at": "2021-11-23T14:37:54Z",
      "updated_in_db_at": "2021-11-23T14:37:54Z"
    },
    "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/0076037a-6ee6-4824-a0e6-98d12d1aec21/people/9bd69d39-967e-40ba-88e8-7a66ef4f1c49
Content-Type: application/vnd.api+json

Body

Response

Headers

204 No Content

Body