OBJECT

Contact

Contact

link GraphQL Schema definition

  • type Contact {
  • # Activity feed items
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • # activityFeedItemType: [Not documented]
  • # noteType: [Not documented]
  • # activityType: [Not documented]
  • # pinned: [Not documented]
  • # scopes: [Not documented]
  • activityFeed(
  • after: String,
  • before: String,
  • first: Int,
  • last: Int,
  • activityFeedItemType: [ActivityFeedItemEnum!],
  • noteType: [NoteTypeEnum!],
  • activityType: [ActivityTypeEnum!],
  • pinned: Boolean,
  • scopes: [ActivityFeedScopesEnum!]
  • ): ActivityFeedConnection
  • # address line 1 of the Contact
  • addressLine1: String
  • # address line 2 of the Contact
  • addressLine2: String
  • # The automation trackers of a contact
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • # scopes: scopes of the automation trackers
  • # orderBy: order of the automation trackers
  • automationTrackers(
  • after: String,
  • before: String,
  • first: Int,
  • last: Int,
  • scopes: [AutomationTrackerScopesEnum!],
  • orderBy: AutomationTrackerOrderEnum
  • ): AutomationTrackerConnection!
  • # background info of the Contact
  • backgroundInfo: String
  • # Name used on the contact's bank account
  • bankAccountName: String
  • # Contact's bank account number
  • bankAccountNumber: String
  • # BSB of the contact's bank account
  • bankBsb: String
  • # company of the Contact
  • company: String
  • # contact groups of the Contact
  • contactGroups: [ContactGroup!]
  • # country of the Contact
  • country: String
  • # When the contact was created
  • createdAt: ISO8601DateTime!
  • # custom fields of the Contact
  • customFields: [CustomField!]
  • # date of birth of the Contact
  • dateOfBirth: ISO8601DateTime
  • # deals of the contact
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • deals(after: String, before: String, first: Int, last: Int): DealConnection
  • # district of the Contact
  • district: String
  • # Do not contact the Contact
  • doNotContact: Boolean
  • # Eagle Eye update date of the Contact
  • eagleEyeUpdatedAt: ISO8601DateTime
  • # jobs of the Contact
  • education: String
  • # emails of the Contact
  • emails: [PriorityEmail!]
  • # encrypted password of the Contact
  • encryptedPassword: Boolean!
  • # Properties that the Contact is has enquired on
  • enquiredOn: [Property!]!
  • # facebook username of the Contact
  • facebookUsername: String
  • # first name of the Contact
  • firstName: String!
  • # found addresses of the Contact
  • foundAddresses: String
  • # found name of the Contact
  • foundName: String
  • # found phones of the Contact
  • foundPhones: String
  • # full name of the Contact
  • fullName: String
  • # education of the Contact
  • gender: String
  • # ID of the Contact
  • id: ID!
  • # Properties that the Contact is has inspected
  • inspected: [Property!]!
  • # Inspection ordinal number
  • #
  • # Arguments
  • # inspectionId: Inspection ID
  • inspectionOrdinalNumber(inspectionId: ID): ID
  • # invoices of a contact
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • # offset: [Not documented]
  • # limit: [Not documented]
  • # orderBy: [Not documented]
  • # updatedBefore: [Not documented]
  • # updatedAfter: [Not documented]
  • invoices(
  • after: String,
  • before: String,
  • first: Int,
  • last: Int,
  • offset: Int,
  • limit: Int,
  • orderBy: OrderByEnum,
  • updatedBefore: ISO8601DateTime,
  • updatedAfter: ISO8601DateTime
  • ): InvoiceConnection
  • # gender of the Contact
  • jobs: String
  • # last contacted at of the Contact
  • lastContactedAt: ISO8601DateTime
  • # last name of the Contact
  • lastName: String
  • # Legal name of the contact
  • legalName: String
  • # linked in username of the Contact
  • linkedInUsername: String
  • # locality of the Contact
  • locality: String
  • # The winner contact
  • #
  • # Arguments
  • # deleted: Include deleted records
  • mergedTo(deleted: Boolean): Contact
  • # notes of the contact
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • # propertyId: notes with an associated property
  • # noteType: filter by type of note
  • # orderBy: [Not documented]
  • notes(
  • after: String,
  • before: String,
  • first: Int,
  • last: Int,
  • propertyId: ID,
  • noteType: [NoteTypeEnum!],
  • orderBy: OrderByEnum
  • ): NoteConnection
  • # Properties that the Contact is has made an offer on
  • offeredOn: [Property!]!
  • # ownerships of the Address
  • #
  • # Arguments
  • # current: ownerships that are current
  • # limit: limit the number of ownerships returned
  • ownerships(current: Boolean, limit: Int): [Ownership!]
  • # permission of the Contact
  • permission: Permission!
  • # phone numbers of the Contact
  • phoneNumbers: [PriorityPhoneNumber!]
  • # photo url of the Contact
  • #
  • # Arguments
  • # width: [Not documented]
  • # height: [Not documented]
  • # smart: [Not documented]
  • photoUrl(width: Int, height: Int, smart: Boolean): String
  • # postcode of the Contact
  • postcode: String
  • # The property interests of a contact
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • # propertyId: ID of the property
  • # interested: [Not documented]
  • # orderBy: [Not documented]
  • propertyInterests(
  • after: String,
  • before: String,
  • first: Int,
  • last: Int,
  • propertyId: ID,
  • interested: [PropertyInterestEnum!],
  • orderBy: PropertyInterestsOrderEnum
  • ): PropertyInterestConnection!
  • # Buyer preferences of the Contact
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • propertyPreferences(
  • after: String,
  • before: String,
  • first: Int,
  • last: Int
  • ): PropertyPreferenceConnection
  • # property subscriptions of the Contact
  • propertySubscriptions: [PropertySubscription!]
  • # audit logs of the contact
  • recentAudits: [Audit!]
  • # referred by of the Contact
  • referredBy: String @deprecated( reason: "Use `Contact.source` instead." )
  • # Relationships of the Contact
  • relatedContacts: [RelatedContacts!]
  • # rental application comments of the contact
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • rentalApplicationComments(
  • after: String,
  • before: String,
  • first: Int,
  • last: Int
  • ): RentalApplicationCommentConnection
  • # rental applications of the contact
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • rentalApplications(
  • after: String,
  • before: String,
  • first: Int,
  • last: Int
  • ): RentalApplicationConnection
  • # referred by of the Contact
  • source: String
  • # state of the Contact
  • state: String
  • # subscribed to email of the Contact
  • subscribedToEmail: Boolean
  • # subscribed to letters of the Contact
  • subscribedToLetters: Boolean
  • # subscribed to property alerts of the Contact
  • subscribedToPropertyAlerts: Boolean
  • # subscribed to sms of the Contact
  • subscribedToSms: Boolean
  • # suburb of the Contact
  • suburb: String
  • # tasks of the contact
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • # propertyId: tasks with an associated property
  • # orderBy: [Not documented]
  • # completed: [Not documented]
  • tasks(
  • after: String,
  • before: String,
  • first: Int,
  • last: Int,
  • propertyId: ID,
  • orderBy: TaskOrderEnum,
  • completed: Boolean
  • ): TaskConnection
  • # tenancies of the contact
  • #
  • # Arguments
  • # after: Returns the elements in the list that come after the
  • # specified cursor.
  • # before: Returns the elements in the list that come before the
  • # specified cursor.
  • # first: Returns the first _n_ elements from the list.
  • # last: Returns the last _n_ elements from the list.
  • # current: tenancies that are current
  • tenancies(after: String, before: String, first: Int, last: Int, current: Boolean): TenancyConnection
  • # tenant rating of the Contact
  • tenantRating: String
  • # title of the Contact
  • title: String
  • # twitter username of the Contact
  • twitterUsername: String
  • # Unsubscribed from all communication
  • unsubscribedFromAll: Boolean
  • # unsubscribed reason of the Contact
  • unsubscribedReason: String
  • # When the contact was last updated
  • updatedAt: ISO8601DateTime!
  • # Vendorships of the Contact
  • vendors: [Vendor!]
  • }