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

Was this helpful?

  1. Endpoints

Contact Activites

Entity responsible for contact activity operations

GraphQL interface for messages.

type Query {
  contactActivity(input: ActivityFilterPaging): [Activity]
}

enum COMPANY_CONTACT_ACTIVITY_CATEGORY {
  EMAIL
  NOTE
  CALL
  SMS
  SEARCH_PROFILE_UPDATE
  DATA_ROOM_VIEWED
  USER_BLACKLISTED
  USER_UNBLACKLISTED
}

type Activity {
  id: String
  companyId: String
  listingId: String
  candidateId: String
  companyContactId: String
  messageId: String
  tenantId: String
  searchProfileId: String
  createdByUserId: String
  category: COMPANY_CONTACT_ACTIVITY_CATEGORY
  type: String
  text: String
}

input ActivityFilterPaging {
  filter: ActivityFilter
  paging: GraphPaging
  sort: GraphSorting
}

input ActivityFilter {
  contactId: String
  companyId: String
}

Usage of Query:

query contactActivity($companyId: String, $contactId: String) {
    contactActivity(
      input: { filter: { companyId: $companyId, contactId: $contactId } }
    ) {
      id
      companyId
      listingId
      candidateId
      messageId
      type
      text
      category
    }
  }
  

Variables:

Using either of these two, should give an error if no variables are not given.

{
    "contactId": "6aec3680-a1de-4e5b-b3d9-67cb4b4727f6",
    "companyId": "341de250-2fd6-11e7-9e51-ff0020488d44"
}
curl --location --request POST 'https://acme-qa.everreal-dev.co/api/reporting/graphql' \
--header 'Authorization: Bearer ...' \
--header 'Content-Type: application/json' \
--data-raw '{"query":"query contactActivity($companyId: String, $contactId: String, $externalContactId: String) {\n    contactActivity(\n      input: { filter: { companyId: $companyId, contactId: $contactId, externalContactId: $externalContactId } }\n    ) {\n      id\n      companyId\n      listingId\n      candidateId\n      messageId\n      type\n      text\n      category\n    }\n  }","variables":{"contactId":"6aec3680-a1de-4e5b-b3d9-67cb4b4727f6","companyId":"341de250-2fd6-11e7-9e51-ff0020488d44"}}'
var myHeaders = new Headers();
myHeaders.append("Authorization", "Bearer ....");
myHeaders.append("Content-Type", "application/json");

var graphql = JSON.stringify({
  query: "query contactActivity($companyId: String, $contactId: String, $externalContactId: String) {\n    contactActivity(\n      input: { filter: { companyId: $companyId, contactId: $contactId, externalContactId: $externalContactId } }\n    ) {\n      id\n      companyId\n      listingId\n      candidateId\n      messageId\n      type\n      text\n      category\n    }\n  }",
  variables: {"contactId":"6aec3680-a1de-4e5b-b3d9-67cb4b4727f6","companyId":"341de250-2fd6-11e7-9e51-ff0020488d44"}
})
var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: graphql,
  redirect: 'follow'
};

fetch("https://acme-qa.everreal-dev.co/api/reporting/graphql", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

PreviousMessagesNextTenants

Last updated 2 years ago

Was this helpful?