Havenly · Postman Collection

Havenly API

This is documentation to the Havenly API. IDs, names, emails found here are not real and requests from the examples will need to be modified slightly to work (ie edited to use real IDs, passwords, etc.)

If you have feedback on this API we'd love to hear it! Click here to shoot us an email!

Happy designing!

Authentication

How to authenticate.
What is our outh metho

22
Requests
11
Folders
View on GitHub Raw JSON CompanyInterior DesignHome DecorFurnitureE-CommerceMarketplaceDesignRetailAIPostman Collection

Overview

Havenly API is a Postman Collection published by Havenly on the APIs.io network.

This is documentation to the Havenly API. IDs, names, emails found here are not real and requests from the examples will need to be modified slightly to work (ie edited to use real IDs, passwords, etc.)

If you have feedback on this API we'd love to hear it! Click here to shoot us an email!

Happy designing!

Authentication

How to authenticate.
What is our outh metho The collection contains 22 requests organised into 11 folders. Tagged areas include Company, Interior Design, Home Decor, Furniture, and E-Commerce.

Requests & Folders

Authentication

Authentication is the first piece to many of the Havenly API routes found here. Although not all of them require auth, it is required for most, so understanding the oauth flow is important.

Addresses

Routes/endpoints to manage a user's addresses

Attribute Types
Board Feedback

Board feedback is what we use to gauge how well a designer did on an idea for a user. The routes contained here are for managing board feedback

Board Feedback Questions
Board Products
Searched Vendor Variants

This is a single endpoint to suplement user specific data for a given set of vendor variants.
The intention here is that the frontend is going to hit Algolia first with all the filtering, et

Vendor Variants
User Opinions

Used to update a user opinion of a product.
Currently only POST is allowed.
This endpoint will manage the likes/dislikes table records accordingly on each update such that a user only

User Profile

User Profile endpoints are used to get information about the authed user.

The response to /user-profile is based on commonly needed values/attributes within our app

Users

These endpoints are used to create/manage users

Related API Specs

Havenly API (OpenAPI)
Back to Havenly · All Collections · GitHub