Fields

Get an appointment by ID.

Lists appointments across your portfolio. Returns a max 1000 appointments, ordered descending by startsAt.

Get a Buyer by ID.

Get a custom export by ID.

Get a custom report by ID.

Get an event by ID.

Get a Lead by ID.

Excludes leads who have converted to buyers.

Uses the IP address of the viewer to determine the closest city Edgewise operates in.

Lists offers across your portfolio. Returns a max 1000 offers, ordered descending by insertedAt.

Get an organization by ID. Slug can be used as ID.

Get an organization integration by ID.

List all available organization integration apps.

Get a Project by ID. The project's slug can be used as the ID.

Returns all affiliated projects. Default is to sort by last updated.

DEPRECATED. Use project query.

Returns public projects. Default is to return all projects, sorted by Edgewise Index. You can filter by city, as well as change the sort order. Some fields are permission restricted, and will return null if you (the viewer) do not have permission.

Returns last 50 sold units.

Get a reservation by ID.

Lists reservations across your portfolio. Returns a max 1000 reservations, ordered descending by insertedAt.

Search for projects, floor plans, units, buyers, buyer's agents, and leads.

Get a Unit by ID.

Get a User by ID. The User's slug can be used as the ID.

List all available user integration apps.

The user associated with the authentication token.

Contact Edgewise.

Contact an organization. Messages are forwarded via email.

Contact a project's sales office. This will create a lead, or merge (based on the email address).

Convert a lead into a buyer.

Create a long-lived API access token.

Create a new user account.

Create a lead or buyer agreement.

Create a lead or buyer appointment.

Create a buyer.

Create a lead or buyer contact.

Create a lead or buyer deposit.

Create a project fallout reason.

Create a project floor plan.

Create a project lead. Note: this will not notify the sales team.

Create a lead note. This will not notify anyone subscribed to lead note notifications.

Create a project lead source.

Create a project lease permit.

Create a project lot.

Create the unit negotiation. Buyers cannot place an offer without having a base negotiation to assign to.

Create a negotiation offer / counter-offer.

Accept or reject a negotiation offer. Responses are final.

Create a project open house.

Create an organization.

Create a billing card.

Create an organization invite.

Create an organization respresentative. Necessary for enabling payments.

Create a new personalization. Personalizations are option and upgrade selections for a unit.

Create a personalization credit (eg. "Construction delay"). For percentages (eg. "10% off"), use a personalization discount.

Create a personalization discount (eg. "10% off"). For dollar amounts (eg. "Construction delay"), use a personalization credit.

Create a lead or buyer phone call.

Create a new project.

Create a project collection.

Create a project open house.

Create a project promotion.

Create a reservation. This does not charge the user.

Create a spec category (eg. "Kitchen").

Create a spec element (eg. "Appliances").

Create a spec option (eg. "Standard" or "Upgrades").

Create a Stripe card.

Create a new task.

Create a tracker.

Create a project unit.

Create a one-time-password (OTP) that can be used for reseting a user's password. This will send an email with a unique token that the user can use to create a new password. For security reasons, this always returns true.

Create an organization webhook.

Delete an API access token.

Delete a buyer document.

Delete a floor plan elevation image.

Delete a project fallout reason.

Delete a project floor plan.

Delete a floor plan image.

Delete a lead document.

Delete a project lead source.

Delete a project lease permit.

Delete a project lot.

Delete a lot image.

Delete a project open house.

Delete an Organization's avatar image. You must have the OWNER role on the Organization.

Delete a billing card.

Delete a Project's avatar image.

Delete a project testimonial.

Delete a project promotion.

Delete a project's site plan.

Delete a Stripe card.

Delete a task.

Delete a tracker.

Delete a project unit.

Delete a unit image.

Delete an organization webhook.

Follow a project.

Import project buyers via CSV.

Import project units via CSV.

Invite a buyer to Edgewise.

Swap username and password for an authentication token. Note: token expires after 30 days. If you need a longer expiration (eg. for long-running API access), create an AccessToken (which has the benefit of being revokable).

Refund a Stripe charge.

Remove a member from an Organization. You must have the OWNER role on the Organization.

Reset a user's password. Requires a one-time-password token.

Draft an Edgewise Intelligence generated email to a lead.

Unfollow a project.

Update an appointment.

Update a buyer.

Update an contact.

Update a custom export.

Update a floor plan elevation image.

Update a project fallout reason.

Update a project floor plan.

Update a floor plan image.

Update a lead.

Update a project lead source.

Update a project lease permit.

Update a project lot.

Update a lot image.

Update a negotiation. Note: the negotiation status will be automatically set for accepted, rejected, and expired offers.

Update a project open house.

Update an organization.

Update a member's role. You must have the OWNER role on the Organization to modify another member's role.

Update your notifications for organizations for which you are a member.

Update an organization respresentative.

Update the currently authenticated user's password.

Update an phone call.

Update a project.

Update a project collection.

Update a project testimonial.

Update a project promotion.

Update a reservation. If the status is changed to REFUNDED, then the buyer assignment is removed, and the associated lot or unit will be marked as AVAILABLE at the originally listed price. Note: marking a reservation as REFUNDED does not automatically refund associated charges. Charges can be refunded using refundStripeCharge.

Update a project's sales office.

Update a task.

Update a project unit.

Update a unit image.

Update many project units.

Update a user. Users can only update themselves.

Upload a floor plan elevation image. File size max is 5MB.

Upload a floor plan document. File size max is 50MB.

Upload a floor plan drawing. File size max is 5MB.

Upload a floor plan image. File size max is 5MB.

Upload a lot image. File size max is 5MB.

Upload an Organization's avatar image. File size max is 5MB. You must have the OWNER role on the Organization.

Upload a Project's avatar image. File size max is 5MB.

Upload a project document. File size max is 50MB.

Upload a project image. File size max is 5MB.

Upload a reservation document. File size max is 50MB.

Upload a project's site plan. File size max is 5MB.

Upload a unit image. File size max is 5MB.