Interface Contact

Return data for a specific contact

See

ChurchSuite Address Book: Get a contact

Hierarchy

Properties

addressaddress2address3citycommunicationcountrycountyctimecusercustom_fieldsdate_of_birthemailemployerfirst_nameformal_nameformer_nameidimagesjoblast_namelatitudelocationlongitudemaiden_namemaritalmiddle_namemobilemtimemulti_team_multi_rolemuserongoing_consentperson_uuidpostcodepublic_optionssexsite_idsite_idsspouse_idstatustelephonetitletype_idwork_telephone

Properties

address

address: string

address2

address2: string

address3

address3: string

city

city: string

communication

communication: { general_email: BooleanAsNumber; general_sms: BooleanAsNumber; rota_email: BooleanAsNumber; rota_sms: BooleanAsNumber }

Type declaration

country

country: string

county

county: string

ctime

ctime: string

cuser

cuser: string

custom_fields

custom_fields: []

date_of_birth

date_of_birth: string

email

email: `${string}@${string}.${string}`

employer

employer: null | string

first_name

first_name: string

formal_name

formal_name: null | string

former_name

former_name: null | string

id

id: number

images

images: [] | Image[]

job

job: null | string

last_name

last_name: string

latitude

latitude: number

location

location: { address: string; latitude: string; longitude: string }

Type declaration

  • address: string
  • latitude: string
  • longitude: string

longitude

longitude: number

maiden_name

maiden_name: null | string

marital

marital: null | string

middle_name

middle_name: null | string

mobile

mobile: string

mtime

mtime: string

Optional multi_team_multi_role

multi_team_multi_role?: boolean

muser

muser: string

ongoing_consent

ongoing_consent: { granted_ctime: null | string; granted_name: null | string; request_ctime: null | string; required: BooleanAsNumber }

Type declaration

  • granted_ctime: null | string
  • granted_name: null | string
  • request_ctime: null | string
  • required: BooleanAsNumber

person_uuid

person_uuid: string

postcode

postcode: string

public_options

public_options: { access: boolean; invited: boolean; visible: { address: boolean; email: boolean; enabled: boolean; mobile: boolean; telephone: boolean } }

Type declaration

  • access: boolean
  • invited: boolean
  • visible: { address: boolean; email: boolean; enabled: boolean; mobile: boolean; telephone: boolean }
    • address: boolean
    • email: boolean
    • enabled: boolean
    • mobile: boolean
    • telephone: boolean

sex

sex: null | "u" | "m" | "f"

site_id

site_id: number

site_ids

site_ids: string[]

spouse_id

spouse_id: null | string

status

status: "active" | "archived"

telephone

telephone: string

title

title: string

type_id

type_id: string

work_telephone

work_telephone: string

Settings

Member Visibility

Theme

Generated using TypeDoc