Getting Started
General Capabilities
The Luxury Presence Public API can be used to:
- fetch, create, update and delete Agents, Offices, Teams and their associated Media
- fetch, create, update and delete Webhook suscriptions
Generating and Managing API Keys
API Keys can be generated via the dashboard located here, or by following these steps:
- Login to your Luxury Presence account: app.luxurypresence.com.
- Click on your profile icon in the bottom left-hand corner.
- Navigate to Settings > API Keys > Generate Key.
- Type in a Key Description for your API key to help easily recognize it later.
- Click Generate Key.
- Copy your API Key, and store it in a safe place.
You must have the role of admin in your account to be able to manage API Keys.
Making a Request
You must specify your API key in the request header asx-api-key.
You can target different versions of our API endpoints by specifying a version in the url.
ex. api.luxurypresence.com/cms/v1/agents
Endpoints, which fetch a list of items, accept pagination parameters (limit and offset).
ex. api.luxurypresence.com/cms/v1/agents?limit=10&offset=10
Please consult our API Reference Docs for further information regarding endpoints and payload details.
Updated 6 months ago
