EverReal
  • Introduction
  • Authentication
    • API ClientID and ClientSecret
    • Authentication limitations
  • Rate limiting
  • Helpers
    • Errors
    • Pagination
    • Formatting
  • How to guide
    • EverReal Data Import Process
      • Connect an Integration
      • Import Mappers
      • Ideal CSV Structure
      • Debug Imports
      • FAQ
    • Data import via GraphQL
  • Endpoints
    • Account users / members
    • Owners
      • Owners Query
      • Owners Mutation
    • Property Groups
      • Property Groups Query
      • Property Group Mutation
    • Properties
      • Properties Query
      • Properties Mutation
    • Units
      • Units Query
      • Units Mutation
    • Listing
      • Listing Query
      • Listing Mutation
    • Candidates
      • Candidates Query
      • Candidate Mutation
    • Messages
    • Contact Activites
    • Tenants
      • Tenants Query
      • Tenant Mutation
    • Contract
      • Contract Query
      • Contract Mutation
    • Contacts
      • Contact Mutation
      • Contact Query
    • Document management
      • Document management
      • Simple file upload
    • Tasks
      • Tasks Query
    • Protocols
      • Protocol Query
  • Webhooks
    • Owner Events
      • OWNER_CREATED
      • OWNER_UPDATED
      • OWNER_DELETED
    • Property Events
      • PROPERTY_CREATED
      • PROPERTY_UPDATED
      • PROPERTY_DELETED
    • Unit Events
      • UNIT_CREATED
      • UNIT_UPDATED
      • UNIT_DELETED
    • Listing Events
      • LISTING_ACTIVATED
      • LISTING_ARCHIVED
      • LISTING_UPDATED
      • LISTING_DEACTIVATED
      • LISTING_CREATED
      • LISTING_PUBLISHED_TO_CHANNEL
      • LISTING_UNPUBLISHED_FROM_CHANNEL
    • Candidates Events
      • CANDIDATE_PARSED
      • LISTING_CANDIDATE_APPLIED
    • Listing Contracting Events
      • LISTING_CONTRACT_FLOW_SIGNED
      • LISTING_CONTRACT_FLOW_PARTIALLY_SIGNED
      • LISTING_CONTRACT_FLOW_WITHDRAWN
      • LISTING_CONTRACT_FLOW_STARTED
    • Listing Scheduling Events
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKING_REMOVED_CANDIDATE
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKING_REMOVED_ADMIN
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKED_CANDIDATE
      • LISTING_CANDIDATE_SCHEDULE_TIMESLOT_BOOKED_ADMIN
      • LISTING_CANDIDATE_SCHEDULE_NEW_TIMESLOTS_REQUESTED
      • LISTING_CANDIDATE_SCHEDULE_INVITED_VIEWING
    • Protocol Events
      • PROTOCOL_COMPLETED
  • Change log
    • Releases
      • Introducing Mappers
      • Enhancements for GraphQL
      • Enhancements for Querying
      • Enhancements for Webhooks
    • Upcoming
      • Introduced Querying Protocol in GraphQL
Powered by GitBook
On this page
  • Introduction
  • Contact Query

Was this helpful?

  1. Endpoints
  2. Contacts

Contact Query

Get list of contact

Introduction

Contacts are the company contact that a company user can add in our system. We provides ability to filter the contacts by externalId, email, id and fullSearch(first name and last name). Please make sure the paging option is used to fetch more items.

Contact Query

To query a contacts from Everreal use contacts query

type Query {
  contacts(input: ContactFilterListPaging): [Contact]
}

Schema

type Contact {
  id: String
  externalId: String
  salutation: String
  title: String
  firstName: String
  lastName: String
  email: String
  userId: String
  companyId: String
  phoneNumber: String
  address: ContactAddress
  cellPhoneNumber: String
  birthDate: DateTime
  blacklistReason: String
  companyContactGroupId: String
  gdprAcceptedDate: String
  gdprAcceptedIpAddress: String
  isBlacklisted: String
  responsibleUserId: String
  createdAt: DateTime
  updatedAt: DateTime
  deletedAt: DateTime
}

type ContactAddress {
  streetName: String
  streetNumber: String
  zipCode: String
  city: String
  country: String
}

input ContactFilterListPaging {
  filter: ContactFilter
  paging: GraphPaging
  sort: GraphSorting
}

input ContactFilter {
  id: String
  externalId: String
  email: String
  fullSearch: String
}

Example for contact query

{
    contacts(input: { filter: { email: "test@acme.com"}, paging: {skip: 0, take: 5}}) {
    id
    firstName
    lastName
    salutation
    title
    email
    createdAt
    updatedAt   
  }
}
PreviousContact MutationNextDocument management

Last updated 3 months ago

Was this helpful?