API Summary

The API is organized around the following resources:

API ItemResource AreaDescription

Property

https://www.relahq.com/api/v1/object/property

CRUD Properties.

Properties

https://www.relahq.com/api/v1/object/properties/{UID}

Gets a list of property nids for a given user id.

Property Image

https://www.relahq.com/api/v1/object/property_image

CRUD property images.

Property Images

https://www.relahq.com/api/v1/object/property_images

Get and Create multiple property images at once.

Zipped Images

https://www.relahq.com/api/v1/object/zipped_images

Upload zipped images to a property.

Templates

https://www.relahq.com/api/v1/object/template_base

Pull list of templates.

Agent

https://www.relahq.com/api/v1/object/agent_card

CRUD Agents.

Agent Lookup

https://www.relahq.com/api/v1/object/agent_lookup

Search for agents

Domain

https://www.relahq.com/api/v1/object/domain

Purchase custom domains.

Document (Floor Plan)

https://www.relahq.com/api/v1/object/document

CRUD Floorplans

Property Video

https://www.relahq.com/api/v1/object/property_video

CRUD Property Videos

3D Tour

https://www.relahq.com/api/v1/object/virtual_tour

CRUD 3D Tours

SSO (Single Sign On)

https://www.relahq.com/api/v1/user/autologin

Get the autologin url for an email.

Connected App Authorization

http://www.relahq.com/authorize/{APP_ID}?redirect_uri=http://example.com

(This is only needed if you are given an APP ID with your credentials. Most users will not need this. All API Calls can be made with your API Key and Token).

Authorize user workflow. User will have option to register new Rela Account or log in to existing account.

Last updated