Opportunity API overview¶
Connect your software to the Opportunity API to highlight business opportunities and help your connected properties act on them.
Use Opportunity API to:
- retrieve a list of available opportunities for a specific property;
- action on an opportunity, enable, disable or dismiss the opportunity;
- RESTful API that speaks JSON. More fields and additional data will be added to the response structure as the API matures so it is advised for integrating clients to be receptive to these changes and not expect a strict schema.
Start by retrieving a list of opportunities.
The Opportunity API uses basic authentication. Each request must have an
Authorization header containing your machine account username and password. Manage your machine accounts in the Connectivity Portal. See also Authentication.
In addition to the documentation you're reading now, be sure to also check out the Opportunity API reference, which provides more technical specifics.
Support & feedback¶
If you have questions or suggestions for improvement, please feel free to contact us.