API & webhooks
Your systems. Better connected.
Create scoped API keys and signed webhooks yourself on the Developers page, to connect your listings, availability and leads. Read-only on Free, the full API on Pro and Business.
Pro features free for your first 12 months.
- Self-serve in your workspace
- Scoped access keys
- Signed webhooks
API and webhooks
Built for dependable connections.
The rental listing API is self-serve: owners and admins create scoped API keys on the Developers page of the workspace. It syncs your listings with idempotency keys and upsert by external id, and sends HMAC-SHA256 signed webhooks with retries and replay. Free gets read-only access; Pro and Business get the full API.
Set up yourself on the Developers page
Owners and admins create API clients, scoped keys, webhooks and OAuth client secrets themselves on the Developers page. Partner access for a property management system or channel manager is the one part Easycoliv sets up, with your consent.
REST API with scoped API keys
A property listing API for PGs, coliving spaces, rooms and flats. Create keys limited to the scopes each integration needs. Reads carry an ETag, and an edit sent with If-Match is refused if the listing or lead changed since you read it.
Upsert by external id with idempotency keys
Upserts keyed on your own ids, plus idempotency keys, keep room inventory sync free of duplicate listings. Every write accepts an Idempotency-Key header: a retry within 24 hours gets the first answer back instead of making the change twice.
HMAC-SHA256 signed webhooks
A rental listings webhook tells your system when a listing or lead changes. Every delivery is signed with HMAC-SHA256, and signing secrets can be rotated.
Webhook retries and replay
Failed deliveries are retried with backoff, and events can be replayed from the event log.
Send leads to your CRM
Send leads to your CRM as they arrive: a webhook for new leads, or read them through the API. Node.js and Python examples, plus curl, cover reading leads, updating availability and verifying webhook signatures.
API access by plan
Read-only API on Free. The full API on Pro, with 5 webhooks, and on Business, with 20. You create the keys and webhooks yourself in the workspace.
OAuth 2.0 client credentials
Integrations can sign in with OAuth 2.0 client credentials instead of a fixed key: a client secret is exchanged for an access token that works for one hour, with the same scopes, IP allow-list and rate limit as the client's API keys. Client secrets are shown once and can be rotated with an overlap.
Partner access you control
On request, Easycoliv can let a property management system or channel manager work for your business through the API. It manages its own webhooks, which get your events only while it has access, and owners and admins can withdraw that access from the Developers page at any time.
Public search API
GET /v1/search returns live listings with their public location and the same filters as the Easycoliv search, up to 50 a page, at 30 requests a minute per IP address in bursts of up to 60. Show that the listings come from Easycoliv and link each one to its page, as the API terms of use require.
A little clarity
Good questions. Clear answers.
The things you might like to know before getting started.
Does Easycoliv have an API for listings?
Yes, Easycoliv for Operators has a REST API for listings with scoped API keys, idempotency keys and upsert by external id. It is self-serve: owners and admins create keys on the Developers page, read-only on Free and the full API on Pro and Business.
How do I avoid duplicate listings when syncing?
To avoid duplicate listings, send an idempotency key and upsert by your own external id. A repeated request then updates the same Easycoliv listing instead of creating a new one.
How are Easycoliv webhooks secured?
Every Easycoliv webhook delivery is signed with HMAC-SHA256. You can rotate the signing secret at any time.
What happens if my webhook endpoint is down?
Easycoliv retries failed webhook deliveries with backoff. You can also replay events from the event log.
Which plans include the API?
The Easycoliv Free plan has read-only API access. The full API comes with Pro (5 webhooks) and Business (20 webhooks). Owners and admins create keys and webhooks themselves on the Developers page.
Does the Easycoliv API support OAuth?
Yes. API clients can use OAuth 2.0 client credentials: a client secret is exchanged at /v1/oauth/token for an access token that works for one hour. Owners and admins create and rotate client secrets on the Developers page.
Is there a public search API?
Yes. GET /v1/search returns live Easycoliv listings without a key, at 30 requests a minute per IP address. Show that the listings come from Easycoliv and link each one back to its page.
Keep exploring