Person

A person record as returned by GET /person/{personId} (Person::exportTo('JSON') plus computed fields). Keys use the Propel PHP names. Related objects (e.g. Family) are embedded when the person has them.

Idinteger

Example: 42

Titlestringnullable

Example: Mr.

FirstNamestring

Example: John

MiddleNamestringnullable

LastNamestring

Example: Doe

Suffixstringnullable

Address1stringnullable

Address2stringnullable

Citystringnullable

Statestringnullable

Zipstringnullable

Countrystringnullable

HomePhonestringnullable

WorkPhonestringnullable

CellPhonestringnullable

Emailstringnullable

WorkEmailstringnullable

BirthMonthinteger

0 when unknown

BirthDayinteger

0 when unknown

BirthYearintegernullable

MembershipDatestring<date>nullable

DateDeceasedstring<date>nullable

Genderinteger

0 = unknown, 1 = male, 2 = female

FmrIdinteger

Family role ID

ClsIdinteger

Classification ID

FamIdinteger

Family ID; 0 when the person has no family

Envelopeintegernullable

DateLastEditedstring<date-time>nullable

DateEnteredstring<date-time>

EnteredByinteger

EditedByintegernullable

FriendDatestring<date>nullable

Flagsinteger

Facebookstringnullable

Twitterstringnullable

LinkedInstringnullable

DateDeactivatedstring<date>nullable

Empty/null for an active person

NeedsReviewboolean

Addressstring

Computed one-line address (falls back to the family address)

FullNamestring

Computed display name

HasPhotoboolean

True when a photo has been uploaded

Family object

A family record as returned by GET /family/{familyId} (Family::toArray()). Keys use the Propel PHP names. ScanCheck, ScanCredit and Envelope are only returned to users with the Finance role.

Idinteger

Example: 7

Namestring

Example: Doe

Address1stringnullable

Address2stringnullable

Citystringnullable

Statestringnullable

Zipstringnullable

Countrystringnullable

SecondAddress1stringnullable

SecondAddress2stringnullable

SecondCitystringnullable

SecondStatestringnullable

SecondZipstringnullable

SecondCountrystringnullable

SecondIsMailingboolean

HomePhonestringnullable

Emailstringnullable

Weddingdatestring<date>nullable

DateEnteredstring<date-time>nullable

DateLastEditedstring<date-time>nullable

EnteredByintegernullable

EditedByintegernullable

ScanCheckstringnullable

Finance role only

ScanCreditstringnullable

Finance role only

SendNewsletterstringnullable

DateDeactivatedstring<date>nullable

Empty/null for an active family

Latitudenumber<double>nullable

Longitudenumber<double>nullable

Envelopeintegernullable

Finance role only

NeedsReviewboolean

Addressstring

Primary address, one line

FamilyStringstring

Display string for the family

HasSecondAddressboolean

SecondAddressIsMailingboolean

SecondAddressstring

Second address, one line

MailingAddressLinesstring

Resolved mailing address, one line

MailingAddress object

Resolved mailing address parts

Address1string

Address2string

Citystring

Statestring

Zipstring

Countrystring

singlePersonCustom object

Custom field values the caller is allowed to see, keyed by custom field

property name*any

Custom field values the caller is allowed to see, keyed by custom field

Person

{
  "Id": 42,
  "Title": "Mr.",
  "FirstName": "John",
  "MiddleName": "string",
  "LastName": "Doe",
  "Suffix": "string",
  "Address1": "string",
  "Address2": "string",
  "City": "string",
  "State": "string",
  "Zip": "string",
  "Country": "string",
  "HomePhone": "string",
  "WorkPhone": "string",
  "CellPhone": "string",
  "Email": "string",
  "WorkEmail": "string",
  "BirthMonth": 0,
  "BirthDay": 0,
  "BirthYear": 0,
  "MembershipDate": "2024-07-29",
  "DateDeceased": "2024-07-29",
  "Gender": 0,
  "FmrId": 0,
  "ClsId": 0,
  "FamId": 0,
  "Envelope": 0,
  "DateLastEdited": "2024-07-29T15:51:28.071Z",
  "DateEntered": "2024-07-29T15:51:28.071Z",
  "EnteredBy": 0,
  "EditedBy": 0,
  "FriendDate": "2024-07-29",
  "Flags": 0,
  "Facebook": "string",
  "Twitter": "string",
  "LinkedIn": "string",
  "DateDeactivated": "2024-07-29",
  "NeedsReview": true,
  "Address": "string",
  "FullName": "string",
  "HasPhoto": true,
  "Family": {
    "Id": 7,
    "Name": "Doe",
    "Address1": "string",
    "Address2": "string",
    "City": "string",
    "State": "string",
    "Zip": "string",
    "Country": "string",
    "SecondAddress1": "string",
    "SecondAddress2": "string",
    "SecondCity": "string",
    "SecondState": "string",
    "SecondZip": "string",
    "SecondCountry": "string",
    "SecondIsMailing": true,
    "HomePhone": "string",
    "Email": "string",
    "Weddingdate": "2024-07-29",
    "DateEntered": "2024-07-29T15:51:28.071Z",
    "DateLastEdited": "2024-07-29T15:51:28.071Z",
    "EnteredBy": 0,
    "EditedBy": 0,
    "ScanCheck": "string",
    "ScanCredit": "string",
    "SendNewsletter": "string",
    "DateDeactivated": "2024-07-29",
    "Latitude": 0,
    "Longitude": 0,
    "Envelope": 0,
    "NeedsReview": true,
    "Address": "string",
    "FamilyString": "string",
    "HasSecondAddress": true,
    "SecondAddressIsMailing": true,
    "SecondAddress": "string",
    "MailingAddressLines": "string",
    "MailingAddress": {
      "Address1": "string",
      "Address2": "string",
      "City": "string",
      "State": "string",
      "Zip": "string",
      "Country": "string"
    }
  },
  "singlePersonCustom": {}
}