Types
Represents a directive
Represents a schema
Represents scalars, interfaces, object types, unions, enums in the system
The Boolean
scalar type represents true
or false
.
Represents a unit buyer.
Filter buyer notes by type. For backwards compatibility, only generic buyer notes are returned. Use an empty list to include all types.
Represents a buyer (purchase) commission.
Represents a disbursement from a commission. For example, a payment made to internal and/or external agents.
The Date
scalar type represents a date. The Date appears in a JSON
response as an ISO8601 formatted string, without a time component.
The DateTime
scalar type represents a date and time in the UTC
timezone. The DateTime appears in a JSON response as an ISO8601 formatted
string, including UTC timezone ("Z"). The parsed date and time string will
be converted to UTC if there is an offset.
The Decimal
scalar type represents signed double-precision fractional
values parsed by the Decimal
library. The Decimal appears in a JSON
response as a string to preserve precision.
Markets Edgewise currently operates in. These can be used to filter project queries.
Represents a notable system event. For example: lead.created
, or buyer.updated
are both events. Events are used for understanding activity / history, audit logs, and as the precursor for webhooks, dashboard push notifications, and email alerts.
The Float
scalar type represents signed double-precision fractional
values as specified by
IEEE 754.
Represents a project floor plan. Units inherit from floor plans (eg, square footage, bedrooms, baths, etc.).
Represents a floor plan image. Typically used for renderings / marketing photos. Use FloorPlanDrawing
for drawings, and FloorPlanDocument
for PDFs.
The ID
scalar type represents a unique identifier, often used to
refetch an object or as key for a cache. The ID type appears in a JSON
response as a String; however, it is not intended to be human-readable.
When expected as an input type, any string (such as "4"
) or integer
(such as 4
) input value will be accepted as an ID.
The Int
scalar type represents non-fractional signed whole numeric
values. It is NOT compliant with the GraphQl spec, it can represent
values between -(2^53 - 1)
and 2^53 - 1
as specified by
IEEE 754.
It is kept here for backwards compatibility, prefer using
the SpecCompliantInt.
Filter lead notes by type. For backwards compatibility, only generic lead notes are returned. Use an empty list to include all types.
The Naive DateTime
scalar type represents a naive date and time without
timezone. The DateTime appears in a JSON response as an ISO8601 formatted
string.
Represents an online negotiation between buyer and seller (aka "Buy Now"). Negotiations are made up of one offer, and optionally multiple counter-offers.
Organization profile photo (1x1). Usually the same image used for social media websites (Instagram, Facebook, LinkedIn, etc.)
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.
The project address. Location (latitude and longitude) are computed automatically.
Project analytics expose metrics in timeseries, with support for date ranges and granularity (eg. grouped by week, month, quarter, etc.), as well as filters. Metrics are typically returned with json data, as well as a few aggregates (average, total, etc.).
Project profile photo (1x1). Typically the same image used for social media websites (Instagram, Facebook, LinkedIn, etc.)
Represents both online and offline lot / unit reservations.
The String
scalar type represents textual data, represented as UTF-8
character sequences. The String type is most often used by GraphQL to
represent free-form human-readable text.
Customer objects allow you to perform recurring charges, and to track multiple charges that are associated with the same customer.
Represents a project unit (aka "inventory").
Represents an uploaded file.