Tenants Query

Get list of tenants from EverReal

Introduction

Our tenant query will get you the list of tenants from the respective company. We provides ability to filter the tenant query by externalId, updatedAt and candidateSources. Please make sure the paging option is used to fetch more items.

Tenant Query

To query a property group from Everreal use tenants query

type Query {
  tenants(input: TenantFilterListPaging): [Tenant]
}

Schema

input TenantFilterListPaging {
  filter: TenantFilter
  paging: GraphPaging
  sort: GraphSorting
}

input TenantFilter {
  id: String
  candidateSources: [String]
  externalId: String
  updatedAt: IDateRange
}

input IDateRange {
  from: String
  to: String
}

input GraphPaging {
  skip: Int
  take: Int
}

input GraphSorting {
  fieldName: String
  direction: String
}

type Tenant {
  id: String
  externalId: String
  email: String
  firstName: String
  lastName: String
  company: Company
  createdAt: DateTime
  updatedAt: DateTime
  companyContact: CompanyContact
}

type CompanyContact {
  userId: String
  externalId: String
  firstName: String
  lastName: String
  email: String
  phoneNumber: String
  cellPhoneNumber: String
}

type Company {
  id: String
  name: String
  partnerId: String
  listings: [Listing]
}

example for tenant query

GraphQL

{
  tenants(
    input: {
      filter: { externalId: "external-tenant-3" }
      paging: { skip: 0, take: 20 }
    }
  ) {
    id
    firstName
    lastName
    externalId
    email
    company {
      id
    }
    createdAt
    updatedAt
  }
}