Aller au contenu principal
Projects

Lire un projet

Rend un projet de l'organisation de la clé, avec ses adresses (chantier et facturation) et le détail de chacun de ses contacts : rôle dans le projet, identité et coordonnées. Les dates sont des date-heures UTC au format ISO 8601. Les devis n'y figurent pas : chaque événement quote.* porte l'identifiant de son projet.

GET
/v1/projects/{id}

Les événements ne portent que l'identifiant des contacts : c'est cet appel qui permet de créer la fiche du client dans un autre logiciel, à partir de l'identifiant reçu dans project.created. La donnée renvoyée est toujours l'état courant du projet, et non une copie au moment de l'événement.

Un champ sans valeur est renvoyé à null, jamais omis.

Exemple d'appel complet :

curl https://api.revelhome.app/v1/projects/prj_01JD3K8Z9XQ4T7M2B6N5V0WCRE \
  -H "Authorization: Bearer <clé_api>" \
  -H "X-API-Version: 2026.12-beta1"
Authorizationstringheaderobligatoire

Clé API de l'organisation, transmise en Authorization: Bearer <clé_api>.

idstringobligatoire

Identifiant public du projet (prj_…), tel que reçu dans data.id d'un événement project.*. Pendant le préavis de 2026.12-beta1, l'ancien numéro est encore accepté.

Exemple: prj_01JD3K8Z9XQ4T7M2B6N5V0WCRE
X-API-Versionstringheaderobligatoire

Version du contrat au format AAAA.MM (année.mois). Version courante : 2026.12-beta1.

Motif: ^\d{4}\.\d{2}(-[a-z0-9]+)?$
Exemple: 2026.12-beta1

Réponse

application/json

Projet de l'organisation de la clé.

assigned_toobject[]obligatoire

Membres de l'équipe commerciale rattachés au projet.

billing_citystring | nullobligatoire

Ville de facturation.

billing_postal_codestring | nullobligatoire

Code postal de facturation.

billing_street_addressstring | nullobligatoire

Adresse de facturation.

citystring | nullobligatoire

Ville du chantier.

Exemple: Nantes
contactsobject[]obligatoire

Contacts du projet, avec leur rôle et leurs coordonnées.

created_atstring | nullobligatoire

Date-heure UTC, ISO 8601.

Exemple: 2026-10-28T09:14:00Z
descriptionstring | nullobligatoire
idstring | integerobligatoire

Identifiant public du projet (prj_…). Une réponse déclarée en 2026.07-beta1 rend encore l'ancien numéro, pendant le préavis.

Exemple: prj_01JD3K8Z9XQ4T7M2B6N5V0WCRE
namestring | nullobligatoire
Exemple: Rénovation cuisine
postal_codestring | nullobligatoire

Code postal du chantier.

Exemple: 44000
statusenum<string>obligatoire

Statut du projet.

Options disponibles: created, contact_invited, quote_saved, quote_read, accepted, payment_requested, deposit_paid, reception_pending, reception_reserves, reception_completed, balance_paid, holdback_paid, complete, needs_attention, lost, canceled, deleted
Exemple: accepted
street_addressstring | nullobligatoire

Adresse du chantier.

Exemple: 12 rue des Lilas
updated_atstring | nullobligatoire

Date-heure UTC, ISO 8601.

Exemple: 2026-10-29T16:02:31Z