Wabode
Base URI
http://wabode.leverage.it/api/v1
X-Requested-With
string
optional
Applied to all operations
Example:
XMLHttpRequest
Authorization
string
required
Applied to all operations
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
GET
/features
POST
/auth/register
POST
/auth/login
GET
/auth/logout
POST
/password/email
POST
/password/reset
POST
/auth/register
Request parameters
name
string
required
email
string
required
password
string
required
password_confirmation
string
required
role
Role
required
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
201
Created
Body
POST
/auth/login
Request parameters
email
string
required
password
string
required
Request headers
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.
GET
/auth/logout
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
POST
/password/email
Request parameters
email
string
required
Request headers
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
POST
/password/reset
Request parameters
token
string
required
email
string
required
password
string
required
password_confirmation
string
required
Request headers
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
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
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
Body
POST
/user/avatar
Request parameters
file
string
required
an actual file, not a string. can be one of .jpg,.jpeg,.png
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
201
Created
Body
PUT
/user
Request parameters
name
string
required
email
string
required
password
string
optional
password_confirmation
string
optional
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
POST
/user/latlng
Request parameters
lat
number
required
Example:
43.6144
lng
number
optional
Example:
79.5775
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
Created
401
Unauthorized
GET
/user/addresses
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
Body
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
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
Body
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
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
Created
Body
DELETE
/user/address/
{id}Path variables
id
string
required
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
204
No Content
401
Unauthorized
POST
/user/shipping
Request parameters
id
integer
required
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
Created
Body
POST
/user/billing
Request parameters
id
integer
required
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
Created
Body
GET
/user/phones
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
Body
POST
/user/phone
Request parameters
type
string
required
phone
string
required
number
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
201
Created
Body
PUT
/user/phone/
{id}Path variables
id
string
required
Request parameters
type
string
required
phone
string
required
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
DELETE
/user/phone/
{id}Path variables
id
string
required
Request headers
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
POST
/user/default_phone
Request parameters
id
integer
required
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
POST
/user/payment_methods
Request parameters
token
string
required
stripe token of a card, acquired through stripe.js
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
DELETE
/user/payment_method/
{id}Path variables
id
integer
required
payment_method.id
Request headers
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
/user/payment_methods
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
Body
POST
/user/payment_method
Request parameters
id
string
optional
payment_method.id
Request headers
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
/user/
{id}/ratingsPath variables
id
string
required
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
Body
POST
/user/
{id}/ratingPath variables
id
string
required
Request parameters
rating
number
required
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
Body
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}
POST
/order
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
201
Created
Body
PUT
/order/
{id}Path variables
id
string
optional
Request parameters
coupon
string
optional
Collection format:
multi
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
Body
GET
/order
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
Body
GET
/order/
{id}Path variables
id
integer
required
Request headers
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
POST
/order/
{id}/itemPath variables
id
string
required
Request parameters
sku
string
required
name
string
required
quantity
number
required
total_price
number
required
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
Created
Body
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
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
/order/
{id}/item/{item_id}Path variables
id
string
required
item_id
string
required
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
GET
/payment
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
Body
GET
/payment/
{id}Path variables
id
string
optional
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
Body
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
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
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
/leads/view/
{id}Path variables
id
integer
required
Request headers
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
POST
/leads
Create a lead if you dont already have an open one and you are a buyer
Request headers
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
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
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
/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
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
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
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
DELETE
/leads/
{id}/feature/{feature_id}Path variables
id
integer
required
feature_id
integer
required
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
GET
/leads/browse
returns paginated list of leads that are still open and within your (the brokers) requested area
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
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
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
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
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
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}
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
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
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
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
/property/mine
Request headers
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
POST
/property/
{id}/feature/{feature_id}Path variables
id
integer
required
property id
feature_id
integer
required
Request headers
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
DELETE
/property/
{id}/feature/{feature_id}Path variables
id
integer
required
property id
feature_id
integer
required
Request headers
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
GET
/property/
{id}/photoPath variables
id
integer
required
property id
Request headers
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
DELETE
/property/
{id}/photo/{photo_id}Path variables
id
integer
required
property id
photo_id
integer
required
must belong to the property
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Responses
200
OK
photo deleted message
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
/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
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
POST
/lead-property/accept/
{id}intent to buy the property
Path variables
id
string
optional
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
POST
/lead-property/accept/
{id}intent to buy the property
Path variables
id
string
optional
Request headers
not needed for /auth actions, must start with "Bearer " followed by the token
Example:
Bearer eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
conversation between a broker and a buyer when a lead is connected to a property
GET
/conversation/
{id}
POST
/conversation/
{id}
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
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
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
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
GET
/brokerage-companies
POST
/broker-profle
GET
/broker-profile
GET
/brokerage-companies
Request headers
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
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
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
/broker-profile
get your own broker profile
Request headers
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
Request headers
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
Object
token
string
Example:
eyJhbGciOixIUzI1NiIsInR5cCI6IkpXUyJ9.eyJzdWIiOiIxIiwiaXNzIjoiaHR0cDpcL1wvbG9jYWxob3N0OjgwMDBcL2FwaVwvdjFcL2F1dGhcL2xvZ2luIiwiaWF0IjoiMTQzMzE4MDg2MiIsImV4cCI6IjE0MzMxODQ0NjIiLCJuYmYiOiIxNDMzMTgwODYyIiwianRpIjoiMjM1ZWYyMzEyM2E1NjhjODRmNzExMjQ3NDE3NjQ0ZWQifQ.MTliYTI3MDhhMGUzMjhkNmQzYjUxMTI4NGI0MzM0OGM1M2VlOWQ1OGRhZWYxZjFiYTc4MGUxZDc1MDU4NWM0Ng
Object
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
Object
id
integer
phone
string
Example:
123 456 7890
type
string
nullable
Example:
Home
Types:
User
Object
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
Object
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
Object
id
integer
sku
string
Example:
fewfe
name
string
Example:
fewfewf
quantity
number
total_price
number
Types:
Order
Object
id
integer
user_id
integer
amount
number
status
string
date
created_at
string
date
pivot
Object
order_id
integer
payment_id
integer
amount
number
method
orders
Types:
Order
Object
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
Methods:
Get Payment Methods
Store Payment Method
Object
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
Object
rating
number
created_at
string
date
Methods:
Get Ratings
Post Rating
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
status
string
Enumeration:
sold
id
string
123
Methods:
Update your lead
Object
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&auto_play=false&start_volume=25&videoId=v6782222&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.
string
Enumeration:
new
Types:
Order
Order - Simplified