EntityContactWithDetails

  • businessAddressCity
    Type: string nullable

    City of linked business address

  • businessAddressCountryName
    Type: string nullable

    Country name of linked business address

  • businessAddressId
    Type: stringFormat: uuid nullable

    UUID of the linked business address

  • businessAddressLine1
    Type: string nullable

    Primary address line of linked business address

  • companyName
    Type: string nullable

    External company name if different from client company

  • contactTypeBillingNotifications
    Type: boolean

    Whether the contact type receives billing notifications

  • contactTypeExclusive
    Type: boolean

    Whether the contact type is exclusive

  • contactTypeId
    Type: stringFormat: uuid

    UUID of the contact type

  • contactTypeName
    Type: string

    Name of the contact type

  • contactTypeNotifications
    Type: boolean

    Whether the contact type receives notifications

  • createdAt
    Type: stringFormat: date-time

    When the contact was created

  • deletedAt
    Type: stringFormat: date-time nullable

    When the contact was deleted (null if active)

  • department
    Type: string nullable

    Contact's department

  • email
    Type: stringFormat: email

    Contact's email address

  • entityId
    Type: stringFormat: uuid

    UUID of the entity that owns this contact

  • firstName
    Type: string

    Contact's first name

  • id
    Type: stringFormat: uuid

    UUID of the contact

  • isPrimaryContact
    Type: boolean

    Whether this is the primary contact for this type

  • lastName
    Type: string

    Contact's last name

  • mobileNumber
    Type: string nullable

    Mobile phone number

  • notes
    Type: string nullable

    Additional notes about the contact

  • phoneNumber
    Type: string nullable

    Contact's phone number

  • phoneNumberExt
    Type: string nullable

    Phone extension

  • preferredContactMethod
    Type: stringenum

    Preferred method of contact

    values
    • email
    • phone
    • mobile
  • timeZone
    Type: string nullable

    Contact's time zone

  • title
    Type: string nullable

    Contact's job title