Lister les villas | VillaSlot Documentation

GET /api/v1/properties

Les villas de l’organisation de la clé. Les villas archivées sont exclues par défaut — elles ne prennent plus de nouvelles réservations.

Autorisation

Rôle dans l’organisation	Cet endpoint
`owner`	Autorisé
`admin`	Autorisé
`member`	Autorisé

Paramètres de requête

Paramètre	Type	Par défaut	Description
`page`	entier	`1`	Numéro de page, à partir de 1
`limit`	entier	`20`	Taille de page, plafonnée à 100
`search`	chaîne	—	Correspond au nom de la villa
`status`	enum	`active`	`active`, `archived` ou `all`

Exemple

bash

curl -H "x-api-key: $VILLASLOT_API_KEY" \
  "https://villaslot.app/api/v1/properties?limit=50&status=all"

Réponse

200 OK — la page, avec pagination: {total, page, limit, totalPages}.

json

{
  "success": true,
  "data": [
    {
      "id": "1f0a…",
      "organizationId": "a379bb76-…",
      "name": "Villa Suar",
      "photoUrl": "https://…/villa.jpg",
      "status": "active",
      "nightlyRate": 4500000,
      "checkInMinute": 840,
      "checkOutMinute": 720,
      "createdAt": "2026-01-04T08:00:00.000Z",
      "updatedAt": "2026-01-04T08:00:00.000Z"
    }
  ],
  "pagination": {"total": 4, "page": 1, "limit": 50, "totalPages": 1}
}

checkInMinute et checkOutMinute sont des minutes locales dans le fuseau horaire de l’organisation, de 0 à 1439. Les valeurs par défaut sont 840 (14:00) et 720 (12:00). Chaque villa a sa propre paire ; les réservations existantes gardent leurs instants enregistrés. Configurez les heures dans les réglages de la villa.

Ce qu’il refuse

422 Unprocessable Entity — status ne fait pas partie des trois valeurs acceptées.
401 Unauthorized — clé absente ou invalide, ou clé dont le porteur a quitté l’organisation.
404 Not Found — identifiant inconnu, ou identifiant appartenant à une autre organisation. Les deux sont volontairement indiscernables.
429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.