Developer documentation

Guides and reference for the ElefyMove Open API.

The master calendar

ElefyMove’s calendar is the single source of truth for anything bookable. Every date range carries a state — AVAILABLE, HELD, BOOKED, or BLOCKED — and conflicts resolve first-come-first-served across every channel.

Method	Endpoint	Scope	What it does
GET	`/api/public/v1/listings/{id}/availability`	`availability:read`	Read a listing's unified calendar over a date range — available, held, booked, or blocked.
GET	`/api/public/v1/availability`	`availability:read`	Read availability across up to 50 listings in one call. An id you don't own or that doesn't exist is listed under notFound instead of failing the request.
GET	`/api/public/v1/listings/{id}/blocks`	`availability:read`	Read your own active external-channel blocks for a listing, optionally narrowed to a date range.
POST	`/api/public/v1/listings/{id}/blocks`	`availability:write`	Create or update an external-channel block, identified by your own reference.
POST	`/api/public/v1/listings/{id}/blocks/batch`	`availability:write`	Create or update up to 100 external-channel blocks on one listing in a single call, with a pass/fail result per item.
DELETE	`/api/public/v1/listings/{id}/blocks/batch`	`availability:write`	Remove up to 100 external-channel blocks on one listing in a single call, with a pass/fail result per item.
DELETE	`/api/public/v1/listings/{id}/blocks/{externalRef}`	`availability:write`	Remove an external-channel block you previously wrote.

curl "https://elefymove.com/api/public/v1/listings/{listingId}/availability?from=2026-09-01&to=2026-09-30" \
  -H "X-Api-Key: efy_live_xxxxxxxxxxxxxxxxxxxxxxxx"

# Response — 200 OK
[
  { "from": "2026-09-01", "to": "2026-09-14", "state": "AVAILABLE" },
  { "from": "2026-09-15", "to": "2026-09-20", "state": "BLOCKED", "source": "partner-site", "externalRef": "HMXYZ123" },
  { "from": "2026-09-21", "to": "2026-09-30", "state": "AVAILABLE" }
]

Syncing a whole portfolio? GET /availability reads up to 50 listings in one call — pass their ids as a comma-separated listingIds. An id you don't own or that doesn't exist is folded into the response's notFound array rather than failing the whole request.

External blocks

When a stay is booked on your own platform, write a block carrying your reference. Blocks are dates + a reference only — no guest personal data crosses the API. GET /listings/:id/blocks reads your own active blocks back, optionally narrowed by from/to.

The batch endpoints write or delete up to 100 blocks on one listing in a single call. Each block gets its own result — check every item in the response rather than assuming the whole batch landed; one bad date range never rolls back the others.

Temporary holds

Place a short-lived hold (up to 10 minutes per call) while a guest completes checkout on your side, then either confirm it into a block or release it early. Not ready in time? POST /holds/:id/extend re-arms the expiry — but a hold's total lifetime, measured from when it was created (not from the extension), is capped at 30 minutes. An extension that would cross that cap is refused with a 409, so extending repeatedly cannot hold inventory indefinitely.

Method	Endpoint	Scope	What it does
GET	`/api/public/v1/holds`	`holds:write`	List your own holds, newest first. Defaults to active holds only; widen the filter with ?status=all.
GET	`/api/public/v1/holds/{id}`	`holds:write`	Read one of your holds by id.
POST	`/api/public/v1/listings/{id}/holds`	`holds:write`	Hold a date range while a guest completes checkout on your side. The losing request gets a 409 carrying SLOT_TAKEN.
POST	`/api/public/v1/holds/{id}/extend`	`holds:write`	Push a hold's expiry further out from now. A hold's total lifetime is capped at 30 minutes from creation — an extension that would cross that cap is refused with a 409.
DELETE	`/api/public/v1/holds/{id}`	`holds:write`	Release one of your holds before it expires.

curl -X POST "https://elefymove.com/api/public/v1/listings/{listingId}/holds" \
  -H "X-Api-Key: efy_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{"from": "2026-09-15", "to": "2026-09-20", "ttlSeconds": 300}'

# Response — 201 Created
{ "holdId": "hld_9f3a2c1b", "expiresAt": "2026-08-13T10:15:00Z" }

Losing a conflict

If another channel takes the dates first, the losing request gets a machine-readable 409 — surface it to your guest and refresh availability:

# Same request, the dates were just taken by another channel
# Response — 409 Conflict
{
  "code": "SLOT_TAKEN",
  "conflictingState": "HELD",
  "wonBy": "external"
}