Wabode

Base URI

http://wabode.leverage.it/api/v1
Headers
X-Requested-With
string optional
Applied to all methods
Example:
XMLHttpRequest
Authorization
string required
Applied to all methods

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
API Methods
GET /features
Auth
POST /auth/register
POST /auth/login
GET /auth/logout
POST /password/email
POST /password/reset
Register
POST /auth/register

Request parameters

name
string required
email
string required
password
string required
password_confirmation
string required
role
Role required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

201 Created
Body
Login
POST /auth/login

Request parameters

email
string required
password
string required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Created

X-XSRF-TOKEN

Body
400 Bad Request

These credentials do not match our records.

Logout
GET /auth/logout

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Get Password Reset
POST /password/email

Request parameters

email
string required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Email Sent
404 Can't find email
Reset Password
POST /password/reset

Request parameters

token
string required
email
string required
password
string required
password_confirmation
string required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Success
401 Invalid reset code or invalid email address
User
GET /user
POST /user/avatar
PUT /user
POST /user/latlng
GET /user/addresses
POST /user/address
PUT /user/address/{id}
DELETE /user/address/{id}
POST /user/shipping
POST /user/billing
GET /user/phones
POST /user/phone
PUT /user/phone/{id}
DELETE /user/phone/{id}
POST /user/default_phone
POST /user/payment_methods
DELETE /user/payment_method/{id}
GET /user/payment_methods
POST /user/payment_method
GET /user/{id}/ratings
POST /user/{id}/rating
Get User
GET /user

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Change Avatar
POST /user/avatar

Request parameters

file
string required

an actual file, not a string. can be one of .jpg,.jpeg,.png

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

201 Created
Body
Update User
PUT /user

Request parameters

name
string required
email
string required
password
string optional
password_confirmation
string optional

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Update User Location
POST /user/latlng

Request parameters

lat
number required
Example:
43.6144
lng
number optional
Example:
79.5775

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Created
401 Unauthorized
Get List of Addresses
GET /user/addresses

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Array of Address
Create Address
POST /user/address

Request parameters

nickname
string optional
address
string required
address_line_2
string optional
city
string required
state
string required
zip
string required
country
string required
lat
number optional
lng
number optional

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Update Address
PUT /user/address/{id}

Path variables

id
string required

Request parameters

nickname
string optional
address
string required
address_line_2
string optional
city
string required
state
string required
zip
string required
country
string required
lat
number optional
lng
number optional

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Created
Body
Delete Address
DELETE /user/address/{id}

Path variables

id
string required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

204 No Content
401 Unauthorized
Set Default Shipping Address
POST /user/shipping

Request parameters

id
integer required

address.id

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Created
Body
Set Default Billing Address
POST /user/billing

Request parameters

id
integer required

address.id

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Created
Body
Get List of Phones
GET /user/phones

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Array of Phone
Create Phone
POST /user/phone

Request parameters

type
string required
phone
string required

number

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

201 Created
Body
Update Phone
PUT /user/phone/{id}

Path variables

id
string required

Request parameters

type
string required
phone
string required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
401 Unauthorized
404 Not Found
Delete Phone
DELETE /user/phone/{id}

Path variables

id
string required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

204 No Content
401 Unauthorized
404 Not Found
Set Primary Phone
POST /user/default_phone

Request parameters

id
integer required

phone.id

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Created
Body
404 Not Found
401 Unauthorized
Store Payment Method
POST /user/payment_methods

Request parameters

token
string required

stripe token of a card, acquired through stripe.js

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

201 Created
401 Unauthorized
500 Stripe Error
Delete Payment Method
DELETE /user/payment_method/{id}

Path variables

id
integer required

payment_method.id

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

404 Can't find payment method
204 No Content
Get Payment Methods
GET /user/payment_methods

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Array of Payment Method
Update Primary Payment Method
POST /user/payment_method

Request parameters

id
string optional

payment_method.id

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Saved
500 Stripe Error
Get Ratings
GET /user/{id}/ratings

Path variables

id
string required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Array of Rating
Post Rating
POST /user/{id}/rating

Path variables

id
string required

Request parameters

rating
number required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Order
POST /order
PUT /order/{id}
GET /order
GET /order/{id}
POST /order/{id}/item
POST /order/{id}/item/{item_id}
DELETE /order/{id}/item/{item_id}
Create Order
POST /order

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

201 Created
Body
Update Order
PUT /order/{id}

Path variables

id
string optional

Request parameters

coupon
string optional multiple

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
List Orders
GET /order

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Get Order
GET /order/{id}

Path variables

id
integer required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
404 Not Found
Add Item
POST /order/{id}/item

Path variables

id
string required

Request parameters

sku
string required
name
string required
quantity
number required
total_price
number required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Created
Body
Update Item
POST /order/{id}/item/{item_id}

Path variables

id
string required
item_id
string required

Request parameters

quantity
number required
total_price
number required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Created
Body
401 Unauthorized
Delete Item
DELETE /order/{id}/item/{item_id}

Path variables

id
string required
item_id
string required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

404 No Content
403 Forbidden
401 Unauthorized
200 OK
Body
Payment
GET /payment
GET /payment/{id}
POST /payment
List Payments
GET /payment

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Array of Payment
Get Payment
GET /payment/{id}

Path variables

id
string optional

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Make Payment
POST /payment
  • Can only pay a single order, either partially or entirely
    • Cannot overpay

Request parameters

order[id]
integer required
amount
number required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

201 Created
Body
403 Unauthorized
404 Not Found
500 Stripe Error
Payment Methods
Lead

a buyers request for a property

GET /leads/view/{id}
POST /leads
POST /leads/{id}
GET /leads/mine
POST /leads/{id}/feature/{feature_id}
DELETE /leads/{id}/feature/{feature_id}
GET /leads/browse
GET /leads/{lead_id}/score/{property_id}
POST /leads/{lead_id}/offer/{property_id}
Get a Lead
GET /leads/view/{id}

Path variables

id
integer required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
id
number
Example:
1
property_type
string
Example:
residential
purchase_type
string
Example:
buy
min_price
number
Example:
650000
max_price
number
Example:
850000
building_type
string
Example:
house
min_square_feet
number
Example:
1600
max_square_feet
number
Example:
2200
bedrooms
number
Example:
3
comments
string
Example:
4 bedrooms would be ok as well
km_radius_to_seach
number
Example:
5
lat
string
Example:
43.798545
lng
string
Example:
-79.448767
status
string
Example:
open
features
Object
id
number
Example:
1
feature
Object
name
string
Example:
Air Conditioning
isResidential
string
Example:
Yes
isCommercial
string
Example:
Yes
user
Object
name
string
Example:
Looking ForaHouse
email
string
Example:
looking@forhouse.ca
avatar_url
unknown
Create a Lead
POST /leads

Create a lead if you dont already have an open one and you are a buyer

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Request body

Object
property_type
string
Examples:
residentialcommercial
purchase_type
string

must be one of ('buy', 'rent', 'lease', 'short term')

Example:
rent
min_price
string
Example:
850
max_price
string
Example:
1450
building_type
string
Example:
any
min_square_feet
string
Example:
400
max_square_feet
string
Example:
900
bedrooms
string
Example:
1
comments
string
Example:
my comment
lat
string
Example:
43.798545
lng
string
Example:
-79.448767
km_radius_to_seach
string
Example:
5

Responses

200 Created
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
status
string
Example:
open
property_type
string
Example:
residential
purchase_type
string
Example:
rent
min_price
string
Example:
850
max_price
string
Example:
1450
building_type
string
Example:
any
min_square_feet
string
Example:
400
max_square_feet
string
Example:
900
bedrooms
string
Example:
1
comments
string
Example:
my comment
lat
string
Example:
43.798545
lng
string
Example:
-79.448767
km_radius_to_seach
string
Example:
5
id
number
Example:
4
Update your lead
POST /leads/{id}

Create a lead if you dont already have an open one and you are a buyer

Path variables

id
integer required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Request body

Responses

200 Created
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
status
string
Example:
open
property_type
string
Example:
residential
purchase_type
string
Example:
rent
min_price
string
Example:
850
max_price
string
Example:
1450
building_type
string
Example:
any
min_square_feet
string
Example:
400
max_square_feet
string
Example:
900
bedrooms
string
Example:
1
comments
string
Example:
my comment
lat
string
Example:
43.798545
lng
string
Example:
-79.448767
km_radius_to_seach
string
Example:
5
id
number
Example:
4
Get my Leads
GET /leads/mine

buyer api call to get all leads they have created (should only be 1 open lead)

Notes

speca wont save the sample output, sample output as defined below: { "sucess": true, "code": 200, "data": [ { "id": 4, "property_type": "residential", "purchase_type": "rent", "min_price": 500, "max_price": 1450, "building_type": "any", "min_square_feet": 400, "max_square_feet": 900, "bedrooms": 2, "comments": "my comment", "km_radius_to_seach": 5, "lat": "43.798545", "lng": "-79.448767", "status": "open", "features": [ { "id": 5, "feature": { "name": "Swimming Pool", "isResidential": "Yes", "isCommercial": "No" } } ], "properties": [ { "id": 1, "score": 65, "created_at": "2015-06-29 21:14:58", "updated_at": "2015-06-29 21:14:58", "deleted_at": null, "accepted_at": null, "property": { "building_type": "House", "square_feet": 2200, "bathrooms": 3, "bedrooms": 4, "price": "835000.00", "sold_on": null, "purchase_type": "buy", "isFinished": 0, "comments": "great house in a great area", "address": { "id": 3, "nickname": "", "address": "22 troyer court", "address_line_2": "", "city": "thornhill", "state": "on", "zip": "l4jsm7", "country": "Canada", "lat": "43.798545", "lng": "-79.448767" }, "features": [ { "id": 1, "feature": { "name": "Fireplace", "isResidential": "Yes", "isCommercial": "No" } }, { "id": 2, "feature": { "name": "Air Conditioning", "isResidential": "Yes", "isCommercial": "Yes" } } ] } } ] } ] }

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
id
number
Example:
4
property_type
string
Example:
residential
purchase_type
string
Example:
rent
min_price
number
Example:
850
max_price
number
Example:
1450
building_type
string
Example:
any
min_square_feet
number
Example:
400
max_square_feet
number
Example:
900
bedrooms
number
Example:
1
comments
string
Example:
my comment
km_radius_to_seach
number
Example:
5
lat
string
Example:
43.798545
lng
string
Example:
-79.448767
status
string
Example:
open
features
unknown
Add a feature to your lead
POST /leads/{id}/feature/{feature_id}

add a feature to your lead, use the get featues call to find all features and then use this call to add it by id, if you add it twice nothing will happen. an error is thrown if you add a residential only feature to a commercial lead and vice versa

Path variables

id
integer required
feature_id
integer required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Remove a feature from your lead
DELETE /leads/{id}/feature/{feature_id}

Path variables

id
integer required
feature_id
integer required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Browse Leads
GET /leads/browse

returns paginated list of leads that are still open and within your (the brokers) requested area

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Score a Property on a Lead
GET /leads/{lead_id}/score/{property_id}

get the score with its breakdown for a given property. You must own the property and the lead must be open. this call can be made regardless of an offer existing for this proerty on this lead

Path variables

lead_id
string required
property_id
string required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
score
number
Example:
67
breakdown
Object
Distance
number
Example:
97
Purchase Type
number
Example:
100
Price
number
Example:
25
Square Footage
number
Example:
80
Bedrooms
number
Example:
100
Features
number
Offer a Property to a Lead
POST /leads/{lead_id}/offer/{property_id}

get the score with its breakdown for a given property. You must own the property and the lead must be open. this call can be made regardless of an offer existing for this property on this lead

Path variables

lead_id
integer required
property_id
integer required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
offer
Object
score
number
Example:
32
updated_at
string
Example:
2015-07-08 21:23:52
created_at
string
Example:
2015-07-08 21:23:52
id
number
Example:
5
lead
Object
id
number
Example:
4
property_type
string
Example:
residential
purchase_type
string
Example:
rent
min_price
number
Example:
500
max_price
number
Example:
1450
building_type
string
Example:
any
min_square_feet
number
Example:
400
max_square_feet
number
Example:
900
bedrooms
number
Example:
2
comments
string
Example:
my comment
km_radius_to_seach
number
Example:
5
lat
string
Example:
43.814042
lng
string
Example:
-79.442276
status
string
Example:
open
features
Object
id
number
Example:
5
property
Object
id
number
Example:
2
building_type
string
Example:
Detached House
square_feet
number
Example:
2200
bathrooms
number
Example:
4
bedrooms
number
Example:
3
price
string
Example:
888800.00
sold_on
unknown
purchase_type
string
Example:
buy
isFinished
number
Example:
1
comments
string
Example:
Highly Sought After, Renovated Home Across From Park. 3 Bedrooms, 4 Bathrooms. Custom Kitchen With Granite Counters & S/S Appliances. Crown Moulding, Hardwood And High Quality Carpet Throughout. Smooth Ceilings, Pot Lights. Many South Facing Windows, Lots Of Sunlight! Separate Entrance To Basement W/ 2 Bedrooms, 4Pc. Bathroom, Large Rec Room & Full Kitchen. Entrance From Garage, Updated Furnace, A/C, Windows, Driveway, Washer/Dryer, Hardwood, Patio Doors... **** EXTRAS **** Stainless Steel Fridge & Gas Stove, 2 Dishwashers, Microwave Hood, Front Load Washer & Dryer. Basement Fridge, Stove & Hood, Newer High Efficiency Furnace, A/C, Stone Patio, Open Concept Main Floor, One Of The Largest Lots On The Street...
address
Object
id
number
Example:
4
address
string
Example:
48 Cambell Ave
address_line_2
string
city
string
Example:
Thornhill
state
string
Example:
Ontario
zip
string
Example:
L4J4Y7
country
string
Example:
Canada
lat
string
Example:
43.808476
lng
string
Example:
-79.445776
features
unknown
score
Object
score
number
Example:
32
breakdown
Object
Distance
number
Example:
97
Purchase Type
number
Price
number
Square Footage
number
Example:
20
Bedrooms
number
Example:
75
Features
number
Property

A property is only visible to the broker who created it and to a buyer once its been suggested for their lead

POST /property
POST /property/update/{id}
GET /property/mine
POST /property/{id}/feature/{feature_id}
DELETE /property/{id}/feature/{feature_id}
GET /property/{id}/photo
DELETE /property/{id}/photo/{photo_id}
Create a Property
POST /property

Request parameters

building_type
string required
square_feet
number required
bathrooms
integer required
bedrooms
integer required
price
number required
purchase_type
string required
Enumeration:
buy
rent
lease
short_term
is_finished
boolean required

1 for yes, 0 for no

user_owns_property
string optional

0 or 1

type
string optional
Enumeration:
residential
commercial
comments
string optional

details about the property

address
string required
address_line_2
string optional
city
string required
state
string required
zip
string required
country
string required
lat
number required

latitude

lng
number required

longitude

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Created
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
id
number
Example:
7
building_type
string
Example:
Detached
square_feet
number
Example:
2701
bathrooms
number
Example:
4
bedrooms
number
Example:
4
price
string
Example:
949000.00
sold_on
unknown
purchase_type
string
Example:
buy
isFinished
number
Example:
1
comments
string
Example:
This One Has It All. Oversized 57' X 140' Lot. Fabulous Family Residence. Just Under 3000 Sq.Ft + Finished Lower Level. Great Floor Plan. 4 Bdrms +....4 Baths. Large Rooms. Combined Lr & Dr Providing Dining Space For Up To 40 People. Recent Reno Of Approx. 100K Incl. New Kitchen & Appli., Multiple New Baths, Heated Floors, Windows, Doors, Etc. Hardwood Floors. Fully Fenced & Gated. New Gazebo. Huge Bkyrd Deck. Quiet/Private Lifestyle. Original Owner. **** EXTRAS **** 5 New Stainless Appli. + Washer/Dryer. Furnace & Equip., Cac, Cvac, Humidifier, Air Cleaner, New Attic Vent, All Shelving, Int. & Ext. Lighting, Gar. Dr. Opener & Remotes. Lush Landscaping & Fully Fenced/Gated. Open House July 4 & 5, 1-4Pm
address
Object
id
number
Example:
9
address
string
Example:
22 WINBORNE RD
address_line_2
unknown
city
string
Example:
Thornhill
state
string
Example:
ON
zip
string
Example:
l4j2r9
country
string
Example:
Canada
lat
string
Example:
43.797204
lng
string
Example:
-79.455506
Update a Property
POST /property/update/{id}

you must repost all fields even if just changing 1

Path variables

id
string required

Request parameters

building_type
string required
square_feet
number required
bathrooms
integer required
bedrooms
integer required
price
number required
purchase_type
string required
Enumeration:
buy
rent
lease
short_term
is_finished
boolean required

1 for yes, 0 for no

type
string optional
Enumeration:
residential
commercial
user_owns_property
integer optional

0 for no (broker), 1 for yes

comments
string optional

details about the property

address
string required
address_line_2
string optional
city
string required
state
string required
zip
string required
country
string required
lat
number required

latitude

lng
number required

longitude

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 Created
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
id
number
Example:
7
building_type
string
Example:
Detached
square_feet
number
Example:
2701
bathrooms
number
Example:
4
bedrooms
number
Example:
4
price
string
Example:
949000.00
sold_on
unknown
purchase_type
string
Example:
buy
isFinished
number
Example:
1
comments
string
Example:
This One Has It All. Oversized 57' X 140' Lot. Fabulous Family Residence. Just Under 3000 Sq.Ft + Finished Lower Level. Great Floor Plan. 4 Bdrms +....4 Baths. Large Rooms. Combined Lr & Dr Providing Dining Space For Up To 40 People. Recent Reno Of Approx. 100K Incl. New Kitchen & Appli., Multiple New Baths, Heated Floors, Windows, Doors, Etc. Hardwood Floors. Fully Fenced & Gated. New Gazebo. Huge Bkyrd Deck. Quiet/Private Lifestyle. Original Owner. **** EXTRAS **** 5 New Stainless Appli. + Washer/Dryer. Furnace & Equip., Cac, Cvac, Humidifier, Air Cleaner, New Attic Vent, All Shelving, Int. & Ext. Lighting, Gar. Dr. Opener & Remotes. Lush Landscaping & Fully Fenced/Gated. Open House July 4 & 5, 1-4Pm
address
Object
id
number
Example:
9
address
string
Example:
22 WINBORNE RD
address_line_2
unknown
city
string
Example:
Thornhill
state
string
Example:
ON
zip
string
Example:
l4j2r9
country
string
Example:
Canada
lat
string
Example:
43.797204
lng
string
Example:
-79.455506
Get my Properies
GET /property/mine

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
building_type
string
Example:
House
square_feet
number
Example:
2200
bathrooms
number
Example:
3
bedrooms
number
Example:
4
price
string
Example:
835000.00
sold_on
unknown
purchase_type
string
Example:
buy
isFinished
number
comments
string
Example:
great house in a great area
features
Object
id
number
Example:
1
feature
Object
name
string
Example:
Fireplace
isResidential
string
Example:
Yes
isCommercial
string
Example:
No
leads
Object
id
number
Example:
1
score
number
Example:
23
created_at
string
Example:
2015-07-05 15:44:18
updated_at
string
Example:
2015-07-05 15:44:18
deleted_at
unknown
accepted_at
unknown
lead
Object
id
number
Example:
4
property_type
string
Example:
residential
purchase_type
string
Example:
rent
min_price
number
Example:
500
max_price
number
Example:
1450
building_type
string
Example:
any
min_square_feet
number
Example:
400
max_square_feet
number
Example:
900
bedrooms
number
Example:
2
comments
string
Example:
my comment
km_radius_to_seach
number
Example:
5
lat
string
Example:
43.814042
lng
string
Example:
-79.442276
status
string
Example:
open
address
Object
id
number
Example:
3
nickname
string
address
string
Example:
22 troyer court
address_line_2
string
city
string
Example:
Thornhill
state
string
Example:
Ontario
zip
string
Example:
l4j2m7
country
string
Example:
Canada
lat
string
Example:
43.798545
lng
string
Example:
-79.448767
photos
unknown
Add a Feature
POST /property/{id}/feature/{feature_id}

Path variables

id
integer required

property id

feature_id
integer required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

201 Created
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
string
Example:
feature added
Remove a Feature
DELETE /property/{id}/feature/{feature_id}

Path variables

id
integer required

property id

feature_id
integer required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
string
Example:
feature deleted
Add a Photo
GET /property/{id}/photo

Path variables

id
integer required

property id

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
property_id
number
Example:
7
filename
string
Example:
E314EB5B-3F18-4F20-8AD9-DD032C494168.jpg
id
number
Example:
14
Remove a Photo
DELETE /property/{id}/photo/{photo_id}

Path variables

id
integer required

property id

photo_id
integer required

must belong to the property

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK

photo deleted message

Lead Property

a property being offered for a lead, this is the entity that holds the score and status

DELETE /lead-property/{id}
POST /lead-property/accept/{id}
POST /lead-property/accept/{id}
Delete
DELETE /lead-property/{id}

Decline an offer presented to your lead from a broker. this can be done right away or after some conversation with the broker

Path variables

id
string optional

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Accept
POST /lead-property/accept/{id}

intent to buy the property

Path variables

id
string optional

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Accept Copy
POST /lead-property/accept/{id}

intent to buy the property

Path variables

id
string optional

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Conversation

conversation between a broker and a buyer when a lead is connected to a property

GET /conversation/{id}
POST /conversation/{id}
Get conversation history
GET /conversation/{id}

id is the leadProperty id, it can be found in the properties array for a lead (for buyers) or the leads array for a property (for brokers)

this call can also be used for polling, just set page_size to 1

Path variables

id
string optional

Request parameters

page_size
integer optional
Default:
50
page
string optional

remember its in descending order

Default:
1

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK

paginated response in descending order with a default of 50 messages per page

Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
per_page
number
Example:
50
current_page
number
Example:
1
next_page_url
unknown
prev_page_url
unknown
from
number
Example:
1
to
number
Example:
2
data
Object
from
string
Example:
Buyer
message
string
Example:
hrmm not too bad but im really looking to rent not buy!
created_at
string
Example:
2015-06-29 21:35:00
Add a message
POST /conversation/{id}

Path variables

id
integer required

the lead property id (id from leads in get properties or property in get leads)

Request parameters

meesage
string required

the message you wish to send

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

201 Created
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
from
string
Example:
Broker
message
string
Example:
this message came from the API!
updated_at
string
Example:
2015-07-13 20:49:04
created_at
string
Example:
2015-07-13 20:49:04
id
number
Example:
3
Broker Profile
GET /brokerage-companies
POST /broker-profle
GET /broker-profile
Get Brokerage Companies
GET /brokerage-companies

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
id
number
Example:
1
name
string
Example:
Remax
Create or Update Broker Profile
POST /broker-profle

update (or create) a broker profile

Request parameters

brokerage_company_id
integer optional

id of brokerage company, if left out will be set to NULL. there is an api call to get all available options

send_promotional_emails
integer required

0 for no, 1 for yes

is_residential
integer required

0 for no, 1 for yes

is_commercial
integer required

0 for no, 1 for yes

years_of_experience
integer required
transaction_type
string required
building_type
string required
min_price
number required
max_price
number required
km_radius_area_of_expertise_min
number required
km_radius_area_of_expertise_max
number required

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

201 Created
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
user_id
number
Example:
3
brokerage_company_id
number
Example:
1
send_promotional_emails
number
is_residential
number
Example:
1
is_commercial
number
Example:
1
years_of_experience
number
Example:
12
transaction_type
string
Example:
All
building_type
string
Example:
House
min_price
number
Example:
500001
max_price
number
Example:
1500000
km_radius_area_of_expertise_min
number
km_radius_area_of_expertise_max
number
Example:
50
Get your Broker Profile
GET /broker-profile

get your own broker profile

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
user_id
number
Example:
3
brokerage_company_id
number
Example:
1
send_promotional_emails
number
is_residential
number
Example:
1
is_commercial
number
Example:
1
years_of_experience
number
Example:
12
transaction_type
string
Example:
All?
building_type
string
Example:
House
min_price
number
Example:
500000
max_price
number
Example:
1500000
km_radius_area_of_expertise_min
number
km_radius_area_of_expertise_max
number
Example:
50
Get Features
GET /features

Request headers

X-Requested-With
string optional
Example:
XMLHttpRequest
Authorization
string required

not needed for /auth actions, must start with "Bearer " followed by the token

Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng

Responses

200 OK
Body
Object
sucess
boolean
Example:
true
code
number
Example:
200
data
Object
name
string
Example:
Swimming Pool
isResidential
string
Example:
Yes
isCommercial
string
Example:
No
Data Reference
Token object

Properties

token
string
Example:
eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Methods: Login Register
User object

Properties

name
string
Example:
Monish Overlander
email
string
Example:
monish@leverage.it
avatar_url
string nullable
Example:
/images/avatar.jpg
settings
string nullable
role_name
payment_method
Payment Method nullable
primary_phone
Phone nullable
shipping_address
Address nullable
billing_address
Address nullable
organization
Organization nullable
lat
number nullable
lng
number nullable
latlng_updated_at
string date nullable
Phone object

Properties

id
integer
phone
string
Example:
123 456 7890
type
string nullable
Example:
Home
Address object

Properties

id
integer
nickname
string nullable
address
string
Example:
30-299 Mullen Drive
address_line_2
string nullable
Example:
30-299 Mullen Dr
city
string
Example:
Thornhill
state
string
Example:
Ontario
zip
string
Example:
L4J 3W3
country
string
Example:
Canada
lat
number nullable
lng
number nullable
Order object

Properties

id
integer
user_id
integer
status
subtotal
number
tax
number
total
number
comments
string
paid_at
string date
created_at
string date
updated_at
string date
billing_address
Address nullable
shipping_address
Address nullable
items
Array of Order Item
payments
Array of Payment
Order - Simplified object

Properties

id
integer
user_id
integer
status
subtotal
number
tax
number
total
number
comments
string
paid_at
string date
created_at
string date
updated_at
string date
Methods: List Orders
Types: Payment
Order Item object

Properties

id
integer
sku
string
Example:
fewfe
name
string
Example:
fewfewf
quantity
number
total_price
number
Types: Order
Payment object

Properties

id
integer
user_id
integer
amount
number
status
string date
created_at
string date
pivot
Object
order_id
integer
payment_id
integer
amount
number
orders
Payment Method object

Properties

id
integer
user_id
integer
last4
number
brand
string
Example:
Visa
exp_month
number
exp_year
number
created_at
string date
updated_at
string date
is_default
boolean
Organization object

Properties

name
string
Example:
Leverage IT
description
string nullable
Example:
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
image_url
string nullable
Example:
http://leverage.it/wp-content/uploads/2014/01/logo_22.png
url
string nullable
Example:
http://leverage.it/
phone
string nullable
Example:
888.781.2036
fax
string nullable
email
string nullable
Example:
info@leverage.it
address
Address nullable
Types: User
Chat object

Properties

id
integer
message
string
Example:
e wer ewrfera tTR WETR
read_at
string date nullable
created_at
string date
to_user
from_user
order
Order nullable
Rating object

Properties

rating
number
created_at
string date
Product object

Properties

id
integer
name
string
price
number
is_addon
boolean
Lead object

Properties

property_type
string
Examples:
residentialcommercial
purchase_type
string

must be one of ('buy', 'rent', 'lease', 'short term')

Example:
rent
min_price
string
Example:
850
max_price
string
Example:
1450
building_type
string
Example:
any
min_square_feet
string
Example:
400
max_square_feet
string
Example:
900
bedrooms
string
Example:
1
comments
string
Example:
my comment
lat
string
Example:
43.798545
lng
string
Example:
-79.448767
km_radius_to_seach
string
Example:
5
status
string
Enumeration:
sold
id
string

123

Challenge object

Properties

id
number
Example:
1
status
string
Example:
finished
scoreable
number
Example:
1
challenger_result
string
Example:
challengee_won
challengee_result
string
Example:
challengee_won
result
string
Example:
challengee_won
twitch_embed_code
string
Example:
<object bgcolor="#000000" data="http://www.twitch.tv/swflibs/TwitchPlayer.swf" height="378" id="clip_embed_player_flash" type="application/x-shockwave-flash" width="620"><param name="movie" value="http://www.twitch.tv/swflibs/TwitchPlayer.swf" /><param name="allowScriptAccess" value="always" /><param name="allowNetworking" value="all" /><param name="allowFullScreen" value="true" /><param name="flashvars" value="channel=lirik&amp;auto_play=false&amp;start_volume=25&amp;videoId=v6782222&amp;device_id=39d57fbfc5a5bd9f" /></object><br /><a href="http://www.twitch.tv/lirik" style="padding:2px 0px 4px; display:block; width: 320px; font-weight:normal; font-size:10px; text-decoration:underline;">Watch live video from LIRIK on Twitch</a>
created_at
string
Example:
2015-07-03 09:39:17
updated_at
string
Example:
2015-07-03 09:39:17
challenger
Object
id
number
Example:
2
username
string
Example:
gamerME
avatar_url
string
Example:
/images/avatar.jpg
challengee
Object
id
number
Example:
2
username
string
Example:
gamerME
avatar_url
string
Example:
/images/avatar.jpg
game
Object
id
number
Example:
497
title
string
Example:
Super Smash Bros.
platform
Object
id
number
Example:
497
title
string
Example:
Super Smash Bros.
Role string
string
Enumeration:
User
Methods: Register
Types: User
Order Status string
string
Enumeration:
new