Property Groups Query
Gets property group lists from EverReal
Introduction
Our property group query will get you the list of owners from the respective company. We provides ability to filter the property group query by externalId and fullSearch over propertyGroup name. Please make sure the paging option is used to fetch more items.
Property Group Query
To query a property group from Everreal use propertyGroups
query
type Query {
propertyGroups(input: PropertyGroupFilterListPaging): [PropertyGroup]
}
Schema
type PropertyGroup {
id: String
externalId: String
name: String
createdAt: DateTime
updatedAt: DateTime
descriptions: PropertyGroupDescription
properties: [PartialProperty]
}
type PartialProperty {
id: String
objectId: String
name: String
category: String
subtype: String
type: String
}
input PropertyGroupDescriptionInput {
object: String
amenities: String
location: String
other: String
}
input PropertyGroupFilter {
id: String
externalId: String
companyId: String
fullSearch: String
}
input GraphPaging {
skip: Int
take: Int
}
input GraphSorting {
fieldName: String
direction: String
}
Example for property group query
{
propertyGroups(
input: { filter: { externalId: "iPG-32" }, paging: { skip: 0, take: 10 } }
) {
name
externalId
properties {
id
objectId
name
category
subtype
type
}
}
}
Last updated
Was this helpful?