Project

Also known as a community, or subdivision (eg. "Acme Condos"). A project represents the main object in Edgewise. Each project receives it's own URL (eg. /projects/[project-slug]). Floor plans, units, images, documents, leads, and buyers are all associated back to an individual project.

Fields

abstractProjectAbstract

Computed summary values (typically min and max) for the project. For example, min available unit price, or if the project is sold out.

activity(filter:ProjectActivityFilter)[ProjectActivity]
addOns(subject:String)[ProjectAddOn]
addressProjectAddress

The project address. Location (latitude and longitude) are computed automatically.

agreementTypes[ProjectAgreementType]
agreements(first:Int)[Agreement]
amenities[ProjectAmenity]
appointmentTypes[AppointmentType]
appointments(filter:ProjectAppointmentsFilterfirst:Intoffset:Int)[Appointment]
archivedAtNaiveDateTime

The project archived timestamp. Archived projects are not visible in the Edgewise Marketplace, and are read-only in Seller Central.

avatarProjectAvatar

Project profile photo (1x1). Typically the same image used for social media websites (Instagram, Facebook, LinkedIn, etc.)

buyerNotes(filter:BuyerNotesFilterfirst:Int)[CommonBuyerNote]
buyers(filter:ProjectBuyersFilterfirst:Intquery:String)[Buyer]

Project buyers. null is returned for projects the viewer is not associated with.

chats[Chat]

Project chat conversations. null is returned for projects the viewer is not associated with.

collaborators[ProjectCollaboratorConnection]

The project's collaborators. Users with the OWNER role in a the project's OWNER organization will have automatic access. Otherwise, users must be explicitly added to each project.

collections[ProjectCollection]
customFieldDefinitions[CustomFieldDefinition]
depositSchedule[DepositScheduleMilestone]
deposits[Deposit]
designString

The design, personalization, and amenities description. Limited to 1500 characters.

designHeadingString
documents[ProjectDocument]
events(filter:ProjectEventsFilterfirst:Int)[Event]
exitIntentPolicyProjectExitIntentPolicy
floorPlans[FloorPlan]
followers[ProjectFollow]
grossSelloutValueInt

The project's computed gross sellout value.

heroProjectImage

The project "hero" is the image that represents the project. It is used as the projet thumbnail and the primary image seen in the project details page in Edgewise. The hero is implied from the first image of the project images (eg. sequence 0).

hoaPpsfFloat

HOA price per square foot. This will auto-calculate the HOA fees of a floor plan / unit by multiplying the HOA PPSF by the SQFT of the floor plan.

idID
images[ProjectImage]
inceptionDateDate

The project inception date is used for analytics / metrics. When null, the insertedAt timestamp is used.

insertedAtNaiveDateTime
leadAssignmentPolicyProjectLeadAssignmentPolicy
leadAssignmentPoolOptionsProjectLeadAssignmentPoolOptions
leadNotes(filter:LeadNotesFilterfirst:Int)[CommonLeadNote]
leadSources[LeadSource]
leads(filter:LeadsFilterfirst:Intoffset:IntorderBy:LeadsOrderquery:String)[Lead]

Project leads. null is returned for projects the viewer is not associated with.

leasePermits[LeasePermit]
lots[Lot]
marketingStudioMarketingStudio
marketplaceConfigMarketplaceConfig
metadataJson
nearbySchools(radius:Int)[School]
negotiations(filter:ProjectNegotiationsFilterfirst:Int)[Negotiation]

Project negotiations. null is returned for projects the viewer is not associated with.

neighborhoodString

The neighborhood description. Limited to 1500 characters.

neighborhoodHeadingString
offerInstructionsString

Instructions presented to the user when making an offer.

offerPolicies[ProjectOfferPolicy]
offers(filter:ProjectOffersFilterfirst:Int)[BindingOffer]

Project offers. null is returned for projects the viewer is not associated with.

openHouses[OpenHouse]
overviewString

The project's primary description. Limited to 1500 characters. Used in the project details page for meta tags and sharing (eg. Facebook, Twitter, etc.).

overviewHeadlineString

Limited to 40 characters.

parking[Parking]
pathString

The project's path in the Edgewise Marketplace.

payments[Payment]
payouts[Payout]
permissions[String]

WARNING: this requires multiple db queries and could slow the response time.

phases[ProjectPhase]
promotionalVideoProjectPromotionalVideo
promotions[Promotion]
publicBoolean

TRUE if public, FALSE if private. Private projects are not searchable or visible in the Edgewise Marketplace.

questions[ProjectContactMessage]

Project questions. null is returned for projects the viewer is not associated with.

registrationFields[ProjectRegistrationField]
registrationForms[RegistrationForm]
reservationCancellationFeeInt

The amount deducted from a reservation refund, in USD.

reservationCancellationPolicyDescriptionString

Text presented to the buyer regarding cancellation terms.

reservationExpirationInt

The amount of time a reservation is active before being marked as expired, in hours (eg. 48 is a two day reservation). Buyers will receive automated reminder emails. If no expiration is set, then reservations are active indefinitely and would need to be manually updated.

reservationExpirationCancellationPolicyProjectReservationExpirationCancellationPolicy

Determines whether reservations are manually or automatically cancelled. If automatic, the reservation will be cancelled when expired, automatically refunded (minus the cancellation fee), and the lot/unit marked as available.

reservationInstructionsString

Instructions presented to the user when placing a lot/unit reservation.

reservationLimitsProjectReservationLimits
reservationPriceInt

The reservation price for all lots and/or units, in USD. The default is 250 ($250.00).

reservationSettingsProjectReservationSettings
reservations(filter:ProjectReservationsFilterfirst:Intoffset:Int)[Reservation]

Project reservations. null is returned for projects the viewer is not associated with.

salesOfficeSalesOffice
sitePlanSitePlan
slugString

An auto-generated, URL friendly version of the project's title. Example: ACME Condos becomes acme-condos.

socialLinksProjectSocialLinks

Social media handles (eg. @acmecondos) for Facebook, Instagram, and Twitter.

specificationsSpecifications
stackingPlans[StackingPlan]
statusProjectStatus

The project's marketing status.

storage[Storage]
testimonials[ProjectTestimonial]
titleString

The project's title. Note, changing the title will change the slug; which will change the URL.

units(filter:ProjectUnitsFilter)[Unit]
updatedAtNaiveDateTime
videos[ProjectVideo]
walkScoreWalkScore
websiteString

The URL of an affiliated marketing website for the project (eg. https://acmecondos.com)

yelpYelp

Deprecated Fields

changedInt

Use updatedAt instead.

createdInt

Use insertedAt instead.

leadsAggregate(filter:LeadsFilterfirst:Intoffset:Intquery:String)LeadsAggregation

Use project lead analytics instead.

neighborhoodHeroProjectHero

No longer used. Always returns null.

offerPolicyProjectOfferPolicy

No longer used. Always returns null. Use offerPolicies instead.

overviewHeroProjectHero

Use hero instead. Always returns null.

personalizationString

The design, personalization, and amenities description. Limited to 1500 characters.

Use design instead.

personalizationHeroProjectHero

No longer used. Always returns null.

promotedBoolean

Alias for project.public.

Use public instead.

secondaryLeadSources[LeadSource]

Use sources instead.

unitStackingPlans[UnitStackingPlan]

Use stackingPlans instead.