API
Endpoints
One endpoint per admin-space action: its address, what it requires, and what it returns. The list is derived from the code; it cannot describe yesterday's version.
196 endpoints · 63 read · 104 write · 29 delete
196 of 196
search
/api/v1/search_everythingGET · POSTreadLecture. Cherche un mot dans tout l'espace admin d'un coup : tâches, fiches clients, contenus de publication (texte du post compris), conversations (fil compris), notes (publiées ou non), devis, réunions (transcript compris), formulaires de découverte et fichiers partagés. Rend au plus six résultats par nature, classés par pertinence, chacun avec sa nature et son adresse : c'est un point d'entrée, pas un inventaire, et la liste complète d'une nature se demande à l'outil qui la liste.Parametersquerystring · required
ReturnsLink to this endpointobject[]Each row carrieskindstring · always presentValuesclienttaskcontentconversationnotedecisionquotemeetingformfileidstring · always presenttitlestring · always presentsubtitlenull|string · always presenthrefstring · always presentatnull|string · always present
account
/api/v1/get_accountGET · POSTreadLecture. Réglages du compte au nom duquel la clé MCP agit : nom affiché, adresse, langue.No parameters.
ReturnsLink to this endpointobjectFieldsfull_namenull|string · always presentavatar_urlnull|string · always presentlocalestring · always presentemailnull|string · always presentprovider_avatar_urlnull|string · always present
/api/v1/update_accountPOSTwriteÉcriture. Modifie le nom affiché et la langue du compte au nom duquel la clé MCP agit.Parametersfull_namestring · required
ReturnsLink to this endpointobjectFieldsfull_namenull|string · always presentavatar_urlnull|string · always presentlocalestring · always presentemailnull|string · always presentprovider_avatar_urlnull|string · always present
/api/v1/upload_account_avatarPOSTwriteÉcriture. Remplace l'avatar du compte. L'image est attendue en data URL complète, ce qui la rend peu commode depuis un assistant.ParametersdataUrlstring · required
ReturnsLink to this endpointobjectFieldsfull_namenull|string · always presentavatar_urlnull|string · always presentlocalestring · always presentemailnull|string · always presentprovider_avatar_urlnull|string · always present
/api/v1/remove_account_avatarPOSTwriteÉcriture. Retire l'avatar du compte et rétablit l'initiale.No parameters.
ReturnsLink to this endpointobjectFieldsfull_namenull|string · always presentavatar_urlnull|string · always presentlocalestring · always presentemailnull|string · always presentprovider_avatar_urlnull|string · always present
agencies
/api/v1/list_my_agenciesGET · POSTreadLecture. Les agences auxquelles appartient le compte au nom duquel la clé agit, et laquelle il regarde. Presque toujours une seule.No parameters.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentnamestring · always presentrolestring · always presentValuesowneradminmemberactiveboolean · always present
/api/v1/get_agency_setupGET · POSTreadLecture. Où en est l'installation de l'agence : a-t-elle un premier client, une marque posée, un second membre. Trois réponses, utiles pour savoir quoi proposer à quelqu'un qui vient d'arriver.No parameters.
ReturnsLink to this endpointobjectFieldshasClientboolean · always presenthasCompanyboolean · always presenthasBrandboolean · always presenthasTeammateboolean · always present
/api/v1/create_agencyPOSTwriteÉcriture. Crée une agence et en fait le compte propriétaire. Geste rare : il ouvre un espace neuf, vide, et n'a de sens que pour quelqu'un qui n'en a pas encore. Ne donne accès à rien d'existant.Parametersnamestring · required
ReturnsLink to this endpointobjectFieldsagency_idstring · always present
/api/v1/set_active_agencyPOSTwriteÉcriture. Change l'agence que le compte regarde. Tout ce que les autres outils lisent et écrivent en découle : c'est un changement de contexte, pas un réglage d'affichage.Parametersagency_idstring · required
ReturnsLink to this endpointobjectFieldsagency_idstring · always present
admin-locale
/api/v1/set_admin_localePOSTwriteÉcriture. Change la langue dans laquelle le compte lit l'espace admin.Parameterslocalestring · requiredValuesfrenes
ReturnsLink to this endpointobjectFieldslocalestring · always presentValuesfrenes
notifications
/api/v1/list_notificationsGET · POSTreadLecture. Dernières notifications du compte au nom duquel la clé MCP agit, lues et non lues, de la plus récente à la plus ancienne.Parameterslimitinteger — Combien de lignes rendre au plus (50 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presenttypestring · always presentValuesmentiontask_assignedtask_commentticket_openedticket_messageclient_file_addedcredential_activitynote_commentquestionnaire_answeredquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewedreadboolean · always presentcreated_atstring · always presenttitlestring · always presentbodystring · always presenthrefnull|string · always present
/api/v1/count_unread_notificationsGET · POSTreadLecture. Nombre de notifications non lues, sans en rendre le contenu./api/v1/mark_notification_readPOSTwriteÉcriture. Marque une notification comme lue. Rien ne disparaît du tiroir, seule la pastille s'éteint./api/v1/mark_all_notifications_readPOSTwriteÉcriture. Éteint toutes les pastilles d'un geste, sans rien retirer du tiroir./api/v1/delete_notificationPOSTdestructiveSuppression définitive, irréversible. Retire définitivement une notification du tiroir. Le fait annoncé (la tâche, le devis, le message) reste où il est : seul l'avis disparaît./api/v1/delete_read_notificationsPOSTdestructiveSuppression définitive, irréversible. Retire définitivement du tiroir toutes les notifications déjà lues, et elles seules. Rend le nombre de lignes retirées./api/v1/list_notification_settingsGET · POSTreadLecture. Réglages de notification du compte : un bloc par type recevable, avec l'état de chaque canal.No parameters.
ReturnsLink to this endpointobject[]Each row carriestypestring · always presentValuesmentiontask_assignedtask_commentticket_openedticket_messageclient_file_addedcredential_activitynote_commentquestionnaire_answeredquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewedlabelstring · always presentdescriptionstring · always presentchannelsobject · always present
/api/v1/set_notification_channelPOSTwriteÉcriture. Coche ou décoche un canal de notification pour un type donné, et rend les réglages relus.Parameterstypestring · requiredValuesmentiontask_assignedtask_commentticket_openedticket_messageclient_file_addedcredential_activitynote_commentquestionnaire_answeredquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewedchannelstring · requiredValuesin_appemailpushenabledboolean · required
ReturnsLink to this endpointobject[]Each row carriestypestring · always presentValuesmentiontask_assignedtask_commentticket_openedticket_messageclient_file_addedcredential_activitynote_commentquestionnaire_answeredquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewedlabelstring · always presentdescriptionstring · always presentchannelsobject · always present
/api/v1/set_notification_channel_for_all_typesPOSTwriteÉcriture. Ouvre ou coupe un canal de notification sur tous les types recevables d'un coup, et rend les réglages relus. Les deux autres canaux restent où ils étaient.Parameterschannelstring · requiredValuesin_appemailpushenabledboolean · required
ReturnsLink to this endpointobject[]Each row carriestypestring · always presentValuesmentiontask_assignedtask_commentticket_openedticket_messageclient_file_addedcredential_activitynote_commentquestionnaire_answeredquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewedlabelstring · always presentdescriptionstring · always presentchannelsobject · always present
push
/api/v1/list_push_devicesGET · POSTreadLecture. Appareils abonnés aux notifications push pour le compte au nom duquel la clé MCP agit, du plus récemment ajouté au plus ancien.No parameters.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentendpointstring · always presentuser_agentnull|string · always presentcreated_atstring · always presentlast_used_atnull|string · always present
/api/v1/save_push_subscriptionPOSTwriteÉcriture. Enregistre l'abonnement push d'un appareil, ou le met à jour s'il existe déjà. Les valeurs viennent du navigateur : rien d'utile à fabriquer à la main.Parametersendpointstring · requiredp256dhstring · requiredauthstring · requireduser_agentstring|null
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentendpointstring · always presentuser_agentnull|string · always presentcreated_atstring · always presentlast_used_atnull|string · always present
/api/v1/remove_push_subscriptionPOSTdestructiveSuppression définitive, irréversible. Retire l'abonnement push d'un appareil, qui cesse de sonner. Sans recours : il faudra le réautoriser depuis l'appareil lui-même.Parametersendpointstring · required
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentendpointstring · always presentuser_agentnull|string · always presentcreated_atstring · always presentlast_used_atnull|string · always present
admin-invitations
/api/v1/list_adminsGET · POSTreadLecture. Administrateurs de l'agence : qui a accès à l'espace admin.No parameters.
ReturnsLink to this endpointobject[]Each row carriesuser_idstring · always presentemailnull|string · always presentrolestring · always presentValuesowneradminmembergranted_atstring · always presentis_selfboolean · always present
/api/v1/list_admin_invitationsGET · POSTreadLecture. Invitations d'administrateur en cours, avec leur état et leur échéance.No parameters.
ReturnsLink to this endpointobject[]Each row carriesexpires_atstring · always presentaccepted_atnull|string · always presentrevoked_atnull|string · always presentidstring · always presentemailstring · always presentinvited_bynull|string · always presentcreated_atstring · always presentaccepted_bynull|string · always presentinvited_by_emailnull|string · always present
clients
/api/v1/list_clientsGET · POSTreadLecture. Toutes les fiches clients, de la plus récemment modifiée à la plus ancienne, avec leur statut commercial.Parameterslimitinteger — Combien de lignes rendre au plus (1000 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentnamestring · always presentcompanynull|string · always presentcountrystring · always presentsiretnull|string · always presentvat_numbernull|string · always presentemailnull|string · always presentphonenull|string · always presentaddress_line1null|string · always presentaddress_line2null|string · always presentpostal_codenull|string · always presentcitynull|string · always presentnotesnull|string · always presentlocalestring · always presentstatusstring · always presentValuesleadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelostreferrer_idnull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/get_clientGET · POSTreadLecture. Fiche client complète : identité, apporteur d'affaires, devis émis avec leurs signatures, formulaires de découverte reçus, et les données sur mesure de l'agence (`custom`), chacune avec son nom, sa clé, sa nature et la valeur de cette fiche.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsclientobject · always presentreferrernull|object · always presentquotesobject[] · always presentformsobject[] · always presentcustomobject[] · always present
/api/v1/upsert_clientPOSTwriteÉcriture. Crée une fiche client, ou met à jour celle dont l'identifiant est fourni. Sans identifiant, une fiche est créée.Parametersidstringnamestring · requiredcompanyany|string|""countrystringsiretany|string|""vat_numberany|string|""emailany|string|""phoneany|string|""address_line1any|string|""address_line2any|string|""postal_codeany|string|""cityany|string|""notesany|string|""localestringValuesfrenesstatusstringValuesleadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelostreferrer_idstring|""|null
ReturnsLink to this endpointobjectFieldsaddress_line1null|string · always presentaddress_line2null|string · always presentcitynull|string · always presentcompanynull|string · always presentcountrystring · always presentcreated_atstring · always presentcreated_bynull|string · always presentemailnull|string · always presentidstring · always presentnamestring · always presentnotesnull|string · always presentphonenull|string · always presentpostal_codenull|string · always presentsiretnull|string · always presentupdated_atstring · always presentvat_numbernull|string · always presentlocalestring · always presentstatusstring · always presentValuesleadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelostreferrer_idnull|string · always present
/api/v1/set_client_statusPOSTwriteÉcriture. Déplace un client sur le parcours commercial, de « lead » à « live », ou l'en sort : « inactive » pour une relation en sommeil, « lost » pour une affaire perdue.Parametersidstring · requiredstatusstring · requiredValuesleadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
ReturnsLink to this endpointobjectFieldsidstring · always presentstatusstring · always presentValuesleadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
/api/v1/delete_clientPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une fiche client. Irréversible : demander confirmation avant d'appeler.
tasks
/api/v1/list_client_membersGET · POSTreadLecture. Personnes rattachées aux espaces clients, à qui une tâche peut être assignée.No parameters.
ReturnsLink to this endpointobject[]Each row carriesuser_idstring · always presentemailnull|string · always presentnamenull|string · always presentavatar_urlnull|string · always presentclient_idstring · always present
/api/v1/list_tasksGET · POSTreadLecture. Tâches de l'équipe, éventuellement restreintes à une fiche client ou à une réunion, échéances les plus proches en tête et tâches sans date en queue. Se parcourt par tranches avec limit et offset, seul moyen d'atteindre la fin d'une longue liste, que le plafond de réponse coupe.Parametersclient_idstringmeeting_idstringlimitinteger — Combien de lignes rendre au plus (500 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presenttitlestring · always presentdescriptionnull|string · always presentstatusstring · always presentValuesproposedbacklogtododoingdoneprioritystring|null · always presentValueslowmediumhighurgentvisibilitystring · always presentValuespublicteamprivatecreated_bynull|string · always presentclient_idnull|string · always presentclient_namenull|string · always presentmeeting_idnull|string · always presentmeeting_titlenull|string · always presentstart_onnull|string · always presentdue_onnull|string · always presentrecurrencenull|object · always presentcompleted_atnull|string · always presentcreated_atstring · always presentupdated_atstring · always presentassignee_idsstring[] · always presentclient_assignee_idsstring[] · always presenttagsstring[] · always presentdepends_onobject[] · always presentblocksobject[] · always presentcomment_countnumber · always present
/api/v1/get_taskGET · POSTreadLecture. Une tâche et ses rattachements./api/v1/create_taskPOSTwriteÉcriture. Crée une tâche. Sa visibilité décide qui la voit : l'équipe et le client, l'équipe seule, ou son auteur et ceux à qui elle est confiée. Une règle « recurrence » ({ every, unit : day | week | month | year }) la fait se répéter : la suivante naît quand on la termine, à l'échéance décalée d'un pas, et exige donc une échéance. « depends_on_ids » dit les tâches qu'elle attend : elle est signalée bloquée tant que l'une d'elles n'est pas terminée.Parameterstitlestring · requireddescriptionstring|nullstatusstringValuesproposedbacklogtododoingdoneprioritystring|nullValueslowmediumhighurgentvisibilitystringValuespublicteamprivateclient_idstring|nullmeeting_idstring|nullstart_onstring|nulldue_onstring|nullassignee_idsstring[]client_assignee_idsstring[]tagsstring[]|string[]depends_on_idsstring[]recurrenceobject|null
ReturnsLink to this endpointobjectFieldsidstring · always presenttitlestring · always presentdescriptionnull|string · always presentstatusstring · always presentValuesproposedbacklogtododoingdoneprioritystring|null · always presentValueslowmediumhighurgentvisibilitystring · always presentValuespublicteamprivatecreated_bynull|string · always presentclient_idnull|string · always presentclient_namenull|string · always presentmeeting_idnull|string · always presentmeeting_titlenull|string · always presentstart_onnull|string · always presentdue_onnull|string · always presentrecurrencenull|object · always presentcompleted_atnull|string · always presentcreated_atstring · always presentupdated_atstring · always presentassignee_idsstring[] · always presentclient_assignee_idsstring[] · always presenttagsstring[] · always presentdepends_onobject[] · always presentblocksobject[] · always presentcomment_countnumber · always present
/api/v1/update_taskPOSTwriteÉcriture. Modifie une tâche : titre, statut, priorité, échéance, répétition, étiquettes, assignation, dépendances. Passer une tâche récurrente en « done » fait naître sa prochaine occurrence ; la rouvrir la reprend si personne n'y a touché. Une répétition posée sur une tâche sans échéance est refusée, comme une dépendance qui ferait tourner la chaîne en rond. « depends_on_ids » remplace la liste entière : [] libère la tâche.Parameterstitlestringdescriptionstring|nullstatusstringValuesproposedbacklogtododoingdoneprioritystring|nullValueslowmediumhighurgentvisibilitystringValuespublicteamprivateclient_idstring|nullmeeting_idstring|nullstart_onstring|nulldue_onstring|nullassignee_idsstring[]client_assignee_idsstring[]tagsstring[]|string[]depends_on_idsstring[]recurrenceobject|nullidstring · required
ReturnsLink to this endpointobjectFieldsidstring · always presenttitlestring · always presentdescriptionnull|string · always presentstatusstring · always presentValuesproposedbacklogtododoingdoneprioritystring|null · always presentValueslowmediumhighurgentvisibilitystring · always presentValuespublicteamprivatecreated_bynull|string · always presentclient_idnull|string · always presentclient_namenull|string · always presentmeeting_idnull|string · always presentmeeting_titlenull|string · always presentstart_onnull|string · always presentdue_onnull|string · always presentrecurrencenull|object · always presentcompleted_atnull|string · always presentcreated_atstring · always presentupdated_atstring · always presentassignee_idsstring[] · always presentclient_assignee_idsstring[] · always presenttagsstring[] · always presentdepends_onobject[] · always presentblocksobject[] · always presentcomment_countnumber · always present
/api/v1/delete_taskPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une tâche./api/v1/list_task_membersGET · POSTreadLecture. Membres de l'équipe à qui une tâche peut être assignée.No parameters.
ReturnsLink to this endpointobjectFieldscurrent_user_idstring · always presentmembersobject[] · always present
client-users
/api/v1/get_client_accessGET · POSTreadLecture. Qui peut ouvrir l'espace d'un client, et qui y a été invité sans avoir accepté.Parametersclient_idstring
ReturnsLink to this endpointobjectFieldsusersobject[] · always presentinvitationsobject[] · always present
/api/v1/invite_client_userPOSTwriteÉcriture. Invite une adresse à ouvrir l'espace d'un client. L'invitation part par courrier électronique. La langue, si elle est passée, se pose sur la fiche : l'e-mail, l'espace et les prochains devis de ce client la reprennent.Parametersclient_idstringemailstring · requiredlocalestringValuesfrenes
ReturnsLink to this endpointobjectFieldsinvitationobject · always presenturlstring · always presentdeliverystring · always presentValuessentnot_configuredfailed
/api/v1/revoke_client_invitationPOSTwriteÉcriture. Annule une invitation d'espace client qui n'a pas encore été acceptée.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsexpires_atstring · always presentaccepted_atnull|string · always presentrevoked_atnull|string · always presentidstring · always presentclient_idstring · always presentemailstring · always presentinvited_bynull|string · always presentcreated_atstring · always presentaccepted_bynull|string · always present
/api/v1/remove_client_userPOSTdestructiveSuppression définitive, irréversible. Retire à une personne son accès à l'espace d'un client.
custom-fields
/api/v1/list_custom_fieldsGET · POSTreadLecture. Catalogue des données sur mesure des fiches clients : pour chaque champ, sa clé, son intitulé, sa nature (texte, nombre, date, oui/non, adresse web, e-mail, téléphone, menu à choix) et le nombre de fiches renseignées.No parameters.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentkeystring · always presentlabelstring · always presenttypestring · always presentValuesnumberbooleanemailphonedatetextlong_texturlselectoptionsstring[] · always presenthintnull|string · always presentclientCountnumber · always present
/api/v1/list_client_custom_dataGET · POSTreadLecture. Toutes les fiches clients et leurs données sur mesure, en un appel : le catalogue d'abord, puis chaque client avec ses valeurs rangées par clé de champ. C'est la lecture à préférer pour comparer les clients entre eux ou repérer ce qui manque ; une fiche sans aucune valeur y figure avec un objet vide.Parameterslimitinteger — Combien de lignes rendre au plus (1000 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobjectFieldsfieldsobject[] · always presentclientsobject[] · always present
/api/v1/create_custom_fieldPOSTwriteÉcriture. Ajoute une donnée sur mesure au vocabulaire de l'agence. Elle apparaît aussitôt, vide, sur toutes les fiches. La clé de machine se dérive de l'intitulé, elle ne se choisit pas. Un champ « select » exige ses options ; aucun autre n'en accepte.Parameterslabelstring|string · requiredtypestring · requiredValuestextlong_textnumberurlemailphonedatebooleanselectoptionsany|string[]|string[]hintany|string|string
ReturnsLink to this endpointobjectFieldsidstring · always presentkeystring · always presentlabelstring · always presenttypestring · always presentValuesnumberbooleanemailphonedatetextlong_texturlselectoptionsstring[] · always presenthintnull|string · always presentclientCountnumber · always present
/api/v1/update_custom_fieldPOSTwriteÉcriture. Modifie une donnée sur mesure : intitulé, nature, options, aide. La clé de machine ne change jamais. Attention, changer la nature d'un champ ou retirer une option efface les réponses que la nouvelle définition ne sait plus relire, sur toutes les fiches : demander confirmation avant d'appeler.Parametersidstring · requiredlabelstring|string · requiredtypestring · requiredValuestextlong_textnumberurlemailphonedatebooleanselectoptionsany|string[]|string[]hintany|string|string
ReturnsLink to this endpointobjectFieldsidstring · always presentkeystring · always presentlabelstring · always presenttypestring · always presentValuesnumberbooleanemailphonedatetextlong_texturlselectoptionsstring[] · always presenthintnull|string · always presentclientCountnumber · always present
/api/v1/delete_custom_fieldPOSTdestructiveSuppression définitive, irréversible. Retire une donnée sur mesure du vocabulaire, et avec elle les réponses de toutes les fiches. Irréversible : demander confirmation avant d'appeler./api/v1/set_client_custom_valuePOSTwriteÉcriture. Renseigne une donnée sur mesure pour une fiche client. La valeur est relue selon la nature du champ et enregistrée sous forme canonique (nombre à point décimal, date « AAAA-MM-JJ », « true » ou « false », option écrite comme dans le catalogue). Une valeur vide efface la réponse.Parametersclient_idstring · requiredfield_idstring · requiredvaluestring · required
ReturnsLink to this endpointobjectFieldsfield_idstring · always presentvaluenull|string · always present
referrers
/api/v1/list_referrersGET · POSTreadLecture. Catalogue des apporteurs d'affaires.No parameters.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentnamestring · always presentclientCountnumber · always present
/api/v1/create_referrerPOSTwriteÉcriture. Ajoute un apporteur d'affaires au catalogue.Parametersnamestring|string · required
ReturnsLink to this endpointobjectFieldsidstring · always presentnamestring · always presentclientCountnumber · always present
/api/v1/rename_referrerPOSTwriteÉcriture. Renomme un apporteur d'affaires.Parametersidstring · requirednamestring|string · required
ReturnsLink to this endpointobjectFieldsidstring · always presentnamestring · always presentclientCountnumber · always present
/api/v1/delete_referrerPOSTdestructiveSuppression définitive, irréversible. Retire un apporteur d'affaires du catalogue.
quotes
/api/v1/create_quotePOSTwriteÉcriture. Crée un devis rattaché à une fiche client, dans sa première version. Sans langue précisée, celle du client s'applique.Parametersclient_idstring · requiredtitlestring · requiredlocalestringValuesfrenes
ReturnsLink to this endpointobjectFieldsidstring · always presentslugstring · always present
/api/v1/get_quote_for_editGET · POSTreadLecture. Devis complet tel que l'éditeur le voit : versions, prestations, totaux, régime de TVA.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsquoteobject · always presentcompanynull|object · always presentversionsobject[] · always presentcurrentVersionnull|object · always presentcurrentLinesobject[] · always presentdraftobject · always presentsignaturenull|object · always presentlastSignednull|object · always present
/api/v1/update_quote_metaPOSTwriteÉcriture. Modifie l'en-tête d'un devis : titre, langue, durée de validité.Parametersidstring · requiredtitlestring · requiredlocalestring · requiredValuesfrenesvalidity_daysinteger · requiredregimestring · requiredValuesFR_20UE_AUTOLIQHORS_UEEXONEREvat_exemption_noteany|string|""
ReturnsLink to this endpointobjectFieldsokboolean · always present
/api/v1/save_quote_draftPOSTwriteÉcriture. Enregistre le brouillon de la version en cours, sans la publier ni créer de version nouvelle. Ce qui n'est pas nommé reste tel quel : omettre description_md ou note_md les conserve, un texte vide les efface. Les prestations, elles, remplacent toujours la liste entière.Parametersquote_idstring · requireddescription_mdany|string|""note_mdany|string|""linesobject[] · requiredlast_editorstring · required
ReturnsLink to this endpointobjectFieldsokboolean · always present
/api/v1/save_new_quote_versionPOSTwriteÉcriture. Fige une nouvelle version du devis. C'est elle que le client verra à l'adresse publique. Ce qui n'est pas nommé est repris du brouillon : omettre description_md ou note_md publie les textes en cours, un texte vide publie du vide.Parametersquote_idstring · requireddescription_mdany|string|""note_mdany|string|""linesobject[] · required
ReturnsLink to this endpointobjectFieldsversion_idstring · always presentversion_numbernumber · always present
/api/v1/restore_quote_versionPOSTwriteÉcriture. Remet le brouillon du devis sur le contenu d'une version déjà publiée : description, notes et prestations. Rien n'est publié et aucune version n'est retirée, le client continue de lire celle qu'il lisait ; il faut publier ensuite pour lui remettre ce contenu, qui deviendra une version de plus. Le brouillon en cours est remplacé, et ce qu'il portait de non publié est perdu.Parametersquote_idstring · requiredversion_idstring · requiredlast_editorstring
ReturnsLink to this endpointobjectFieldsdescription_mdstring · always presentnote_mdstring · always presentlinesobject[] · always presentversion_numbernumber · always present
quote-comments
/api/v1/add_quote_comment_as_adminPOSTwriteÉcriture. Écrit dans le fil de commentaires d'une version de devis, au nom de l'agence. Le fil est visible du client.Parametersslugstring · requiredversioninteger · requiredbodystring · requiredparent_idstring|nullanchorobject|null
ReturnsLink to this endpointobjectFieldsidstring · always presentparent_idnull|string · always presentauthor_namestring · always presentis_adminboolean · always presentbodystring · always presentcreated_atstring · always presentanchor_typestring|null · always presentValuesnoteslinetotalscontextanchor_line_idnull|string · always presentanchor_excerptnull|string · always present
task-comments
/api/v1/list_task_commentsGET · POSTreadLecture. Fil d'une tâche, du plus ancien message au plus récent.Parameterstask_idstring · requiredlimitinteger — Combien de lignes rendre au plus (300 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesparent_idnull|string · always presentanchor_exactnull|string · always presentanchor_prefixnull|string · always presentanchor_suffixnull|string · always presentresolved_atnull|string · always presentresolved_bynull|string · always presentresolved_by_namenull|string · always presentidstring · always presentauthor_idnull|string · always presentauthor_namestring · always presentauthor_avatar_urlnull|string · always presentauthor_sidestring · always presentValuesclientteambodystring · always presentcreated_atstring · always presentedited_atnull|string · always presentshared_with_clientstringValuesfalsetrue
/api/v1/add_task_commentPOSTwriteÉcriture. Écrit un message dans le fil d'une tâche, au nom du compte connecté. Sur une tâche publique rattachée à une fiche, le client lit ce fil. Une mention s'écrit « @[Nom](identifiant de compte) » et ne prévient que quelqu'un qui voit déjà la tâche. « parent_id » range le message sous une question déjà posée ; « anchor » l'attache à un passage de la description, en reprenant le texte exact du passage et ce qui l'entoure.Parameterstask_idstring · requiredbodystring · requiredparent_idstring|nullanchorobject|null
ReturnsLink to this endpointobjectFieldsparent_idnull|string · always presentanchor_exactnull|string · always presentanchor_prefixnull|string · always presentanchor_suffixnull|string · always presentresolved_atnull|string · always presentresolved_bynull|string · always presentresolved_by_namenull|string · always presentidstring · always presentauthor_idnull|string · always presentauthor_namestring · always presentauthor_avatar_urlnull|string · always presentauthor_sidestring · always presentValuesclientteambodystring · always presentcreated_atstring · always presentedited_atnull|string · always presentshared_with_clientstringValuesfalsetrue
/api/v1/resolve_task_commentPOSTwriteÉcriture. Clôt la question posée par un fil de tâche (resolved: true) ou la rouvre (false). Se pose sur le premier message d'un fil, jamais sur une réponse, et ne notifie personne.Parameterscomment_idstring · requiredresolvedboolean · required
ReturnsLink to this endpointobjectFieldsparent_idnull|string · always presentanchor_exactnull|string · always presentanchor_prefixnull|string · always presentanchor_suffixnull|string · always presentresolved_atnull|string · always presentresolved_bynull|string · always presentresolved_by_namenull|string · always presentidstring · always presentauthor_idnull|string · always presentauthor_namestring · always presentauthor_avatar_urlnull|string · always presentauthor_sidestring · always presentValuesclientteambodystring · always presentcreated_atstring · always presentedited_atnull|string · always presentshared_with_clientstringValuesfalsetrue
/api/v1/update_task_commentPOSTwriteÉcriture. Corrige un message du fil d'une tâche, écrit par le compte au nom duquel la clé MCP agit. Un message écrit par quelqu'un d'autre est refusé, par le moteur lui-même. Le fil affichera « modifié » à côté de sa date. Les mentions se réécrivent comme à l'envoi, et une personne que la correction vient de nommer en est prévenue.Parameterstask_idstring · requiredcomment_idstring · requiredbodystring · required
ReturnsLink to this endpointobjectFieldsparent_idnull|string · always presentanchor_exactnull|string · always presentanchor_prefixnull|string · always presentanchor_suffixnull|string · always presentresolved_atnull|string · always presentresolved_bynull|string · always presentresolved_by_namenull|string · always presentidstring · always presentauthor_idnull|string · always presentauthor_namestring · always presentauthor_avatar_urlnull|string · always presentauthor_sidestring · always presentValuesclientteambodystring · always presentcreated_atstring · always presentedited_atnull|string · always presentshared_with_clientstringValuesfalsetrue
/api/v1/delete_task_commentPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un message du fil d'une tâche, écrit par le compte au nom duquel la clé MCP agit. Refusé pour un message auquel on a répondu : il se corrige, il ne se supprime plus.Parameterstask_idstring · requiredcomment_idstring · required
ReturnsLink to this endpointobjectFieldsidstring · always present
task-views
/api/v1/list_task_viewsGET · POSTreadLecture. Vues enregistrées de la liste des tâches du compte au nom duquel la clé MCP agit, et laquelle s'ouvre par défaut.No parameters.
ReturnsLink to this endpointobjectFieldsviewsobject[] · always presentdefault_view_idnull|string · always present
/api/v1/create_task_viewPOSTwriteÉcriture. Enregistre un jeu de filtres, de tri, de regroupement et d'affichage (liste ou tableau) sous un nom, et peut en faire la vue ouverte par défaut.Parametersnamestring|string · requiredstateobject · requiredmakeDefaultboolean · = false
ReturnsLink to this endpointobjectFieldsidstring · always presentnamestring · always presentstateobject · always present
/api/v1/update_task_viewPOSTwriteÉcriture. Renomme une vue enregistrée, remplace ses réglages, ou les deux.Parametersidstring · requirednamestring|stringstateobject
ReturnsLink to this endpointobjectFieldsidstring · always presentnamestring · always presentstateobject · always present
/api/v1/delete_task_viewPOSTdestructiveSuppression définitive, irréversible. Supprime une vue enregistrée. Les tâches ne bougent pas./api/v1/set_default_task_viewPOSTwriteÉcriture. Désigne la vue qui s'ouvre par défaut sur la liste des tâches, ou n'en désigne plus aucune avec id nul.Parametersidstring|null · required
ReturnsLink to this endpointobjectFieldsdefault_view_idnull|string · always present
meetings
/api/v1/list_meetingsGET · POSTreadLecture. Réunions enregistrées, de la plus récente à la plus ancienne. Le transcript n'y figure pas, seule sa longueur.Parameterslimitinteger — Combien de lignes rendre au plus (300 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentsourcestring · always presentexternal_idnull|string · always presenttitlestring · always presentlocalestring · always presentstarted_atstring · always presentended_atnull|string · always presentduration_secondsnull|number · always presentparticipantsobject[] · always presenttagsstring[] · always presentsummarynull|string · always presenttranscript_charsnumber · always presentcreated_atstring · always presentclient_idnull|string · always presentclient_namenull|string · always present
/api/v1/get_meetingGET · POSTreadLecture. Une réunion et son résumé. Le transcript intégral n'est rendu que si include_transcript vaut vrai, car il peut peser plusieurs dizaines de milliers de mots.Parametersidstring · requiredinclude_transcriptboolean · = false — Joindre le transcript intégral, qui peut être très long.
ReturnsLink to this endpointobjectFieldscreated_atstring · always presentidstring · always presentlocalestring · always presentclient_idnull|string · always presenttitlestring · always presentsourcestring · always presentexternal_idnull|string · always presentstarted_atstring · always presentended_atnull|string · always presentduration_secondsnull|number · always presenttagsstring[] · always presentsummarynull|string · always presenttranscript_charsnumber · always presentclient_namenull|string · always presentparticipantsobject[] · always presentmeeting_urlnull|string · always presentrecording_urlnull|string · always presentmetadataobject · always presenttranscriptnull|string · always presentapi_key_namenull|string · always presentupdated_atstring · always present
/api/v1/set_meeting_clientPOSTwriteÉcriture. Rattache une réunion à une fiche client, ou l'en détache avec client_id nul. À l'arrivée, le rattachement se déduit des adresses des participants ; cet outil sert à le corriger quand la déduction s'est tue ou s'est trompée.Parametersidstring · requiredclient_idstring|null · required
ReturnsLink to this endpointobjectFieldsokboolean · always present
/api/v1/resummarize_meetingPOSTwriteÉcriture. Réécrit le résumé d'une réunion à partir de son transcript et de ce que l'application sait de son client, en rattachant la fiche si personne ne l'a fait. Écrase le résumé précédent, et rend written, skipped (pas de transcript) ou failed.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsoutcomestring · always presentValuesfailedwrittenskipped
/api/v1/delete_meetingPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une réunion, son résumé et son transcript.
meeting-proposals
/api/v1/list_meeting_proposalsGET · POSTreadLecture. Modifications qu'une réunion propose sur une fiche client, une note ou une tâche existante : ce qu'on lit aujourd'hui, ce que la réunion dit d'y mettre, et le passage qui l'établit. Sans filtre, toutes ; sinon celles d'une réunion ou d'une fiche. Rien n'est encore écrit : chacune attend d'être acceptée ou jetée.Parametersmeeting_idstringclient_idstringlimitinteger — Combien de lignes rendre au plus (200 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentmeeting_idstring · always presentclient_idnull|string · always presenttargetstring · always presentValuesclienttasknotedecisionclient_custom_valueoperationstring · always presentValuescreateupdatetarget_idnull|string · always presentchangesobject[] · always presentevidencestring · always presentstatusstring · always presentValuesapprovedrejectedpendingapplied_idnull|string · always presentdecided_atnull|string · always presentcreated_atstring · always presenttarget_namenull|string · always present
/api/v1/approve_meeting_proposalPOSTwriteÉcriture. Accepte une proposition et applique la modification, par la même porte que l'écran (validation et règles comprises). changes corrige une valeur avant de l'accepter, champ par champ ; les champs absents gardent ce que la proposition portait. Refuse quand la valeur a changé depuis la réunion, force passe outre après relecture.Parametersidstring · requiredchangesobject[]forceboolean
ReturnsLink to this endpointobjectFieldsokboolean · always presentapplied_idnull|string · always present
/api/v1/reject_meeting_proposalPOSTwriteÉcriture. Jette une proposition. Elle reste en base, marquée refusée, pour qu'un nouveau résumé de la même réunion ne la repropose pas.
recall
/api/v1/list_meeting_recordingsGET · POSTreadLecture. Enregistrements de visio demandés à Recall : ce qui est prévu, en cours, terminé ou raté, du plus récent au plus ancien.Parameterslimitinteger — Combien de lignes rendre au plus (50 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentmeeting_urlstring · always presentjoin_atnull|string · always presentstatusstring · always presentValuesfaileddonescheduledrecordingcancellederrornull|string · always presentmeeting_idnull|string · always presentcreated_atstring · always present
/api/v1/list_upcoming_meetingsGET · POSTreadLecture. Réunions en cours et à venir, de la plus proche à la plus lointaine, avec le lien de la visio pour y entrer. Elles viennent des agendas connectés et des enregistrements lancés à la main : une réunion sans lien de visio n'y figure pas, et ce qui est déjà terminé se lit par listMeetings.Parametershoursinteger — Horizon en heures (24 par défaut, 336 au maximum). Ce qui est en cours est rendu quoi qu'il arrive.limitinteger — Combien de lignes rendre au plus (50 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presenttitlenull|string · always presentmeeting_urlstring · always presentjoin_atnull|string · always presentstatusstring · always presentValuesfaileddonescheduledrecordingcancelledoriginstring · always presentValuescalendarmanualmeetmeeting_idnull|string · always presentcreated_atstring · always present
/api/v1/start_meeting_recordingPOSTwriteÉcriture. Envoie un bot enregistrer une visio (Google Meet, Zoom, Teams). Sans join_at le bot part tout de suite, ce qui peut échouer faute de machine disponible : au-delà de dix minutes d'avance, l'arrivée est garantie. Une réunion déjà couverte rend le bot existant au lieu d'en créer un second.Parametersmeeting_urlstring · requiredjoin_atstring|nulltitlestring|null
ReturnsLink to this endpointobjectFieldsstatusstring · always presentValuescreatedreusedrecordingobject · always present
/api/v1/start_instant_meetingPOSTwriteÉcriture. Ouvre une visio Google Meet et y envoie le bot dans la foulée. La salle est créée au nom de la personne dont l'agenda est connecté, n'est posée dans aucun agenda et n'invite personne : le lien rendu est celui à partager. Demande que cet agenda ait accordé l'ouverture de visio, ce qui se fait en le reconnectant.Parameterstitlestring|null
ReturnsLink to this endpointobjectFieldsmeeting_urlstring · always presentrecordingobject · always present
/api/v1/cancel_meeting_recordingPOSTwriteÉcriture. Rappelle un bot, avant son départ ou pendant la visio. Un enregistrement en cours est perdu, il n'y a pas de reprise.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsidstring · always presentmeeting_urlstring · always presentjoin_atnull|string · always presentstatusstring · always presentValuesfaileddonescheduledrecordingcancellederrornull|string · always presentmeeting_idnull|string · always presentcreated_atstring · always present
/api/v1/get_meeting_recording_urlGET · POSTreadLecture. URL fraîche pour réécouter l'enregistrement d'une réunion, à partir de son identifiant. Ces liens expirent vite et Recall ne garde le média que quelques jours : la réponse vaut null passé ce délai.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsurlnull|string · always present
recall-calendar
/api/v1/list_calendar_connectionsGET · POSTreadLecture. Agendas connectés à l'enregistrement automatique : adresse Google autorisée, état de la connexion, pause éventuelle, dernière synchronisation.No parameters.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentuser_idstring · always presentplatform_emailnull|string · always presentstatusstring · always presentValuespendingconnecteddisconnectedactiveboolean · always presenterrornull|string · always presentsynced_atnull|string · always presentmeet_auto_joinboolean · always presentmeet_subscription_namenull|string · always presentmeet_subscription_expire_atnull|string · always presentmeet_errornull|string · always presentcreated_atstring · always present
/api/v1/start_calendar_connectionPOSTwriteÉcriture. Ouvre une autorisation Google pour l'agenda du compte appelant et rend l'adresse où se rendre. N'accorde rien par elle-même : il faut ensuite consentir chez Google pour que l'agenda soit connecté./api/v1/set_calendar_activePOSTwriteÉcriture. Suspend ou reprend l'enregistrement automatique d'un agenda. Les bots déjà planifiés ne sont pas rappelés, seule la suite est concernée.Parametersidstring · requiredactiveboolean · required
ReturnsLink to this endpointobjectFieldsidstring · always presentuser_idstring · always presentplatform_emailnull|string · always presentstatusstring · always presentValuespendingconnecteddisconnectedactiveboolean · always presenterrornull|string · always presentsynced_atnull|string · always presentmeet_auto_joinboolean · always presentmeet_subscription_namenull|string · always presentmeet_subscription_expire_atnull|string · always presentmeet_errornull|string · always presentcreated_atstring · always present
/api/v1/set_meet_auto_joinPOSTwriteÉcriture. Allume ou éteint l'enregistrement des réunions Meet ouvertes hors agenda, pour un agenda connecté. Allumer pose l'abonnement Google s'il manque ; éteindre le laisse en place et se rallume aussitôt.Parametersidstring · requiredenabledboolean · required
ReturnsLink to this endpointobjectFieldsidstring · always presentuser_idstring · always presentplatform_emailnull|string · always presentstatusstring · always presentValuespendingconnecteddisconnectedactiveboolean · always presenterrornull|string · always presentsynced_atnull|string · always presentmeet_auto_joinboolean · always presentmeet_subscription_namenull|string · always presentmeet_subscription_expire_atnull|string · always presentmeet_errornull|string · always presentcreated_atstring · always present
/api/v1/retry_meet_subscriptionPOSTwriteÉcriture. Repose l'abonnement Google aux réunions ouvertes hors agenda, après un échec. Sans effet quand l'abonnement est déjà en place et sain.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsidstring · always presentuser_idstring · always presentplatform_emailnull|string · always presentstatusstring · always presentValuespendingconnecteddisconnectedactiveboolean · always presenterrornull|string · always presentsynced_atnull|string · always presentmeet_auto_joinboolean · always presentmeet_subscription_namenull|string · always presentmeet_subscription_expire_atnull|string · always presentmeet_errornull|string · always presentcreated_atstring · always present
/api/v1/disconnect_calendarPOSTdestructiveSuppression définitive, irréversible. Retire un agenda : Recall cesse de le suivre et la connexion disparaît. Il faudra repasser par l'autorisation Google pour la rétablir.
questionnaires
/api/v1/list_questionnairesGET · POSTreadLecture. Questionnaires de l'agence, avec pour chacun son nombre de questions, d'envois et de réponses reçues.Parameterslimitinteger — Combien de lignes rendre au plus (200 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presenttitlestring · always presentdescriptionnull|string · always presentlocalestring · always presentquestionsnumber · always presentsentnumber · always presentcompletednumber · always presentupdated_atstring · always present
/api/v1/get_questionnaireGET · POSTreadLecture. Un questionnaire et sa structure entière : sections, questions, options.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsidstring · always presenttitlestring · always presentdescriptionnull|string · always presentlocalestring · always presentcontentobject · always presentupdated_atstring · always present
/api/v1/upsert_questionnairePOSTwriteÉcriture. Crée ou modifie un questionnaire. Modifier ne touche à aucune réponse déjà reçue : chaque envoi garde la copie des questions telles qu'elles ont été posées.Parametersidstringtitlestring · requireddescriptionstringlocalestring · = "fr"Valuesfrenescontentobject · required
ReturnsLink to this endpointobjectFieldsidstring · always present
/api/v1/duplicate_questionnairePOSTwriteÉcriture. Copie un questionnaire sous un nouveau nom, pour en faire une variante qu'on modifie ensuite.Parametersidstring · requiredtitlestring · required
ReturnsLink to this endpointobjectFieldsidstring · always present
/api/v1/delete_questionnairePOSTdestructiveSuppression définitive, irréversible. Supprime un questionnaire de la bibliothèque. Les envois déjà faits restent lisibles./api/v1/send_questionnairePOSTwriteÉcriture. Envoie un questionnaire à un client : crée le lien à jeton et, sauf mention contraire, l'envoie par e-mail à l'adresse de la fiche.Parametersquestionnaire_idstring · requiredclient_idstring · requiredemailstringnotifyboolean · = true
ReturnsLink to this endpointobjectFieldsidstring · always presenturlstring · always presentsentboolean · always present
/api/v1/list_questionnaire_responsesGET · POSTreadLecture. Envois faits et où ils en sont, éventuellement filtrés sur un client ou un questionnaire.Parametersclient_idstringquestionnaire_idstringlimitinteger — Combien de lignes rendre au plus (500 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentclient_idstring · always presentclient_namenull|string · always presentquestionnaire_idnull|string · always presentquestionnaire_titlestring · always presentemailnull|string · always presentlocalestring · always presenttokenstring · always presentsent_atnull|string · always presentopened_atnull|string · always presentcompleted_atnull|string · always presentupdated_atstring · always presentanswerednumber · always presenttotalnumber · always present
/api/v1/get_questionnaire_responseGET · POSTreadLecture. Une réponse, question par question, telle qu'elle a été posée.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsresponseobject · always presentcontentobject · always presentanswersobject · always present
/api/v1/delete_questionnaire_responsePOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un envoi et les réponses qu'il portait.
credentials
/api/v1/get_credential_boardGET · POSTreadLecture. Identifiants déposés pour un client et demandes en cours. Les secrets restent chiffrés et ne sont jamais rendus ici.Parametersclient_idstring
ReturnsLink to this endpointobjectFieldscredentialsobject[] · always presentrequestsobject[] · always presenteventsobject[] · always presentsidestring · always presentValuesclientagencykey_availableboolean · always present
/api/v1/create_credentialPOSTwriteÉcriture. Dépose un identifiant chiffré pour un client. Le secret transite par la conversation : préférer l'écran quand c'est possible.Parametersclient_idstringlabelstring · requiredtypestring · requiredValuesloginapi_keyvaluesobject · requiredrequest_idstring
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idstring · always presentlabelstring · always presenttypestring · always presentValuesloginapi_keykey_versionnumber · always presentcreated_bynull|string · always presentcreated_sidestring · always presentValuesclientagencycreated_atstring · always presentupdated_atstring · always present
/api/v1/update_credentialPOSTwriteÉcriture. Modifie un identifiant déposé. Remplacer le secret écrase l'ancien sans recours.Parametersidstring · requiredlabelstringvaluesobject
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idstring · always presentlabelstring · always presenttypestring · always presentValuesloginapi_keykey_versionnumber · always presentcreated_bynull|string · always presentcreated_sidestring · always presentValuesclientagencycreated_atstring · always presentupdated_atstring · always present
/api/v1/delete_credentialPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un identifiant déposé./api/v1/create_credential_requestPOSTwriteÉcriture. Demande un identifiant à un client. Aucun secret n'entre ici, seulement la demande.Parametersclient_idstringlabelstring · requiredtypestring · requiredValuesloginapi_keymessagestring
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idstring · always presentlabelstring · always presenttypestring · always presentValuesloginapi_keymessagenull|string · always presentstatusstring · always presentValuesopencancelledfulfilleddeclinedrequested_sidestring · always presentValuesclientagencyrequested_by_labelstring · always presentfulfilled_credential_idnull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/close_credential_requestPOSTwriteÉcriture. Clôt une demande d'identifiant.Parametersidstring · requiredstatusstring · requiredValuesdeclinedcancelled
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idstring · always presentlabelstring · always presenttypestring · always presentValuesloginapi_keymessagenull|string · always presentstatusstring · always presentValuesopencancelledfulfilleddeclinedrequested_sidestring · always presentValuesclientagencyrequested_by_labelstring · always presentfulfilled_credential_idnull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/get_key_rotation_statusGET · POSTreadLecture. État du chiffrement des identifiants : version de clé en service et nombre de secrets restant à re-chiffrer.No parameters.
ReturnsLink to this endpointobjectFieldscurrentnull|number · always presentavailablenumber[] · always presentcountsobject[] · always presentorphanednumber[] · always present
bills
/api/v1/list_client_billsGET · POSTreadLecture. Factures adressées à un client : numéro, date d'émission, total TVA comprise, TVA, nom du PDF. Aucune URL n'est rendue ici.Parametersclient_idstringlimitinteger — Combien de lignes rendre au plus (500 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentclient_idstring · always presentnumberstring · always presentissued_onstring · always presentdue_onnull|string · always presentpaid_onnull|string · always presenttotal_centsnumber · always presentvat_centsnumber · always presentfile_namestring · always presentsize_bytesnumber · always presentcreated_atstring · always present
/api/v1/create_client_billPOSTwriteÉcriture. Enregistre une facture pour un client et pousse son PDF, attendu en data URL complète. Le numéro, la date d'émission et les montants en centimes sont affirmés par l'appelant : l'écran, lui, les lit dans le document et les fait valider.Parametersclient_idstring · requirednumberstring · requiredissued_onstring · requireddue_onstring|nulltotal_centsinteger · requiredvat_centsinteger · requiredfile_namestring · requireddata_urlstring · required
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idstring · always presentnumberstring · always presentissued_onstring · always presentdue_onnull|string · always presentpaid_onnull|string · always presenttotal_centsnumber · always presentvat_centsnumber · always presentfile_namestring · always presentsize_bytesnumber · always presentcreated_atstring · always present
/api/v1/set_client_bill_due_datePOSTwriteÉcriture. Pose ou corrige l'échéance d'une facture déjà déposée, `null` l'effaçant. C'est la seule valeur d'une facture enregistrée qui se modifie : les autres recopient un document immuable. Une échéance antérieure à la date d'émission est refusée.Parametersidstring · requireddue_onstring|null · required
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idstring · always presentnumberstring · always presentissued_onstring · always presentdue_onnull|string · always presentpaid_onnull|string · always presenttotal_centsnumber · always presentvat_centsnumber · always presentfile_namestring · always presentsize_bytesnumber · always presentcreated_atstring · always present
/api/v1/set_client_bill_payment_datePOSTwriteÉcriture. Indique qu'une facture a été réglée, à la date où l'agence l'a constaté, `null` la remettant en attente. C'est la seule valeur d'une facture qui ne vienne pas du document : une facture est émise avant d'être payée. Une date antérieure à la date d'émission est refusée, et le client n'en est pas averti.Parametersidstring · requiredpaid_onstring|null · required
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idstring · always presentnumberstring · always presentissued_onstring · always presentdue_onnull|string · always presentpaid_onnull|string · always presenttotal_centsnumber · always presentvat_centsnumber · always presentfile_namestring · always presentsize_bytesnumber · always presentcreated_atstring · always present
/api/v1/delete_client_billPOSTdestructiveSuppression définitive, irréversible. Retire définitivement une facture de la fiche d'un client, et son PDF avec. N'annule rien en comptabilité : ce qui annule une facture est un avoir, qui se dépose comme le document qu'il est.
metrics
/api/v1/list_client_metricsGET · POSTreadLecture. Mesures (KPI) suivies pour un client, chacune avec tous ses relevés : nom, unité, sens favorable, façon de réunir les relevés, décimales, puis les valeurs avec la période qu'elles couvrent et leurs notes.Parametersclient_idstring
ReturnsLink to this endpointobjectFieldsmetricsobject[] · always present
/api/v1/create_client_metricPOSTwriteÉcriture. Crée une mesure sur la fiche d'un client. Le nom et l'unité sont obligatoires ; la mesure est visible dans l'espace du client dès sa création, même sans relevé. `aggregation` dit comment réunir plusieurs relevés quand on les regroupe (sum pour un chiffre d'affaires, average pour un taux, last pour un stock) : le défaut est la somme, et il est faux pour un taux. Un nom déjà pris sur cette fiche est refusé.Parametersclient_idstring · requirednamestring · requiredunitstring · requireddescriptionstring|nulldirectionstring · = "up"Valuesupdownneutralaggregationstring · = "sum"Valuessumaveragelastdecimalsinteger · = 0
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idstring · always presentnamestring · always presentunitstring · always presentdescriptionnull|string · always presentdirectionstring · always presentValuesupdownneutralaggregationstring · always presentValuessumlastaveragedecimalsnumber · always presentcreated_atstring · always present
/api/v1/update_client_metricPOSTwriteÉcriture. Corrige une mesure : son nom, son unité, ce qu'elle décrit, son sens favorable, sa façon de réunir les relevés et ses décimales d'affichage. Ne touche à aucun relevé, et ne change jamais la fiche à laquelle elle appartient.Parametersidstring · requirednamestring · requiredunitstring · requireddescriptionstring|nulldirectionstring · = "up"Valuesupdownneutralaggregationstring · = "sum"Valuessumaveragelastdecimalsinteger · = 0
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idstring · always presentnamestring · always presentunitstring · always presentdescriptionnull|string · always presentdirectionstring · always presentValuesupdownneutralaggregationstring · always presentValuessumlastaveragedecimalsnumber · always presentcreated_atstring · always present
/api/v1/delete_client_metricPOSTdestructiveSuppression définitive, irréversible. Supprime une mesure ET TOUS SES RELEVÉS, définitivement. Rien ne les reconstitue : demander confirmation avant d'appeler./api/v1/save_metric_readingPOSTwriteÉcriture. Enregistre un relevé sur une mesure : une valeur, la période qu'elle décrit et une note facultative. La période est donnée par ses deux bornes incluses (`period_start`, `period_end`, jours civils, égales pour un relevé quotidien) plus `grain`, qui dit le pas choisi et décide de ce qui s'écrira sous le point (day, week, month, quarter, year, custom). Deux pièges : un relevé qui couvre EXACTEMENT la même période est remplacé, et un relevé qui en chevauche partiellement un autre est refusé.Parametersmetric_idstring · requiredperiod_startstring · requiredperiod_endstring · requiredgrainstring · = "day"Valuesdayweekmonthquarteryearcustomvaluenumber · requirednotestring|null
ReturnsLink to this endpointobjectFieldsidstring · always presentmetric_idstring · always presentperiod_startstring · always presentperiod_endstring · always presentgrainstring · always presentValuescustomdayweekmonthyearquartervaluenumber · always presentnotenull|string · always present
/api/v1/save_metric_readingsPOSTwriteÉcriture. Enregistre PLUSIEURS relevés d'un coup sur une seule mesure : c'est ce qu'il faut appeler pour poser une série (douze mois de chiffre d'affaires, trente jours de trafic), plutôt que saveMetricReading autant de fois. Chaque relevé porte ses deux bornes incluses (`period_start`, `period_end`, jours civils, égales pour un relevé quotidien), son `grain` (day, week, month, quarter, year, custom), sa valeur et une note facultative. Tout ou rien : les chevauchements sont cherchés avant la moindre écriture, contre les relevés déjà posés ET entre les relevés de l'envoi, et un seul chevauchement fait refuser l'envoi entier en nommant la période fautive. Une période EXACTEMENT identique à un relevé existant le corrige, ce qui n'est pas un chevauchement. La réponse dit combien ont été créés et combien corrigés. Une mesure par appel : pour en remplir trois, faire trois appels.Parametersmetric_idstring · requiredreadingsobject[] · required
ReturnsLink to this endpointobjectFieldssavednumber · always presentreplacednumber · always present
/api/v1/delete_metric_readingPOSTdestructiveSuppression définitive, irréversible. Retire un relevé d'une mesure. La courbe se referme sur les points voisins ; la mesure, elle, reste.
files
/api/v1/get_client_file_boardGET · POSTreadLecture. Fichiers partagés avec un client : noms, types, tailles, qui les a déposés, et la place occupée. Aucune URL n'est rendue ici : pour lire un document, prendre son identifiant et appeler get_client_file_text.Parametersclient_idstringlimitinteger — Combien de lignes rendre au plus (500 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobjectFieldsclient_idstring · always presentfoldersobject[] · always presentfilesobject[] · always presentused_bytesnumber · always presentquota_bytesnumber · always present
/api/v1/get_client_file_textGET · POSTreadLecture. Le TEXTE d'un fichier partagé, par son identifiant (celui que rend get_client_file_board) : un PDF qui porte une couche de texte (certificat d'analyse, facture, contrat, rapport de laboratoire) ou un fichier textuel (txt, csv, md, json, xml, yaml). Rend une tranche de 12 000 caractères au plus, avec le nombre de pages du document et jusqu'où la lecture est allée ; quand `next_offset` n'est pas nul, rappeler le même outil avec cette valeur pour la suite. Ne rend jamais le fichier lui-même ni d'URL. Un PDF scanné (des pages qui sont des images) ne porte aucun texte : la réponse le dit alors dans `note` plutôt que de rendre un vide qu'on lirait comme un document vide. Une image, une vidéo, une archive, un .docx et un tableur sont refusés en le disant.Parametersidstring · requiredoffsetinteger · = 0
ReturnsLink to this endpointobjectFieldsidstring · always presentnamestring · always presentmime_typestring · always presentsize_bytesnumber · always presentpagesnull|number · always presentpages_readnull|number · always presentoffsetnumber · always presenttextstring · always presentnext_offsetnull|number · always presentnotenull|string · always present
/api/v1/create_client_file_linksPOSTwriteÉcriture. Fabrique des liens de téléchargement temporaires vers des fichiers partagés, à REMETTRE À UN SERVICE TIERS qui doit aller les chercher lui-même (envoyer des visuels sur une boutique, un outil de publication, un CMS). Rend une URL absolue par fichier, valable trente minutes et dix téléchargements, suivie sans compte : c'est ce qu'attend un service qui télécharge une image par son adresse. À n'employer que pour cela, et jamais pour montrer un fichier à quelqu'un, qui le voit déjà dans son espace : ce qui détient l'URL ouvre le fichier. Chaque téléchargement revérifie que celui qui a demandé le lien y a toujours droit, et laisse une trace.Parametersidsstring[] · required
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentnamestring · always presentmime_typestring · always presentsize_bytesnumber · always presenturlstring · always presentexpires_atstring · always present
/api/v1/confirm_client_file_uploadPOSTwriteÉcriture. Termine un envoi commencé ailleurs : relit la taille et le type dans le stockage, puis publie le fichier dans le dossier partagé.Parametersidstring · requiredthumb_uploadedboolean
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idnull|string · always presentnamestring · always presentmime_typestring · always presentsize_bytesnumber · always presenthas_thumbboolean · always presentfolder_idnull|string · always presentcreated_bynull|string · always presentcreated_sidestring · always presentValuesclientagencycreated_atstring · always present
/api/v1/delete_client_filePOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un fichier partagé, et l'octet avec./api/v1/delete_client_filesPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement plusieurs fichiers partagés d'un coup, et les octets avec. Rien n'est effacé si l'un d'eux ne peut pas l'être.Parametersidsstring[] · required
ReturnsLink to this endpointobjectFieldsidsstring[] · always present
file-folders
/api/v1/create_client_file_folderPOSTwriteÉcriture. Crée un dossier dans le dossier partagé d'un client, à la racine ou dans un autre dossier. Deux dossiers de même nom ne cohabitent pas au même endroit.Parametersclient_idstringparent_idstring|nullnamestring · required
ReturnsLink to this endpointobjectFieldsidstring · always presentparent_idnull|string · always presentnamestring · always presentclient_idstring · always presentcreated_atstring · always present
/api/v1/rename_client_file_folderPOSTwriteÉcriture. Renomme un dossier du dossier partagé. Ce qu'il contient n'est pas touché et ne change pas de place.Parametersidstring · requirednamestring · required
ReturnsLink to this endpointobjectFieldsidstring · always presentparent_idnull|string · always presentnamestring · always presentclient_idstring · always presentcreated_atstring · always present
/api/v1/delete_client_file_folderPOSTwriteÉcriture. Supprime un dossier du dossier partagé. Aucun fichier n'est supprimé : son contenu, sous-dossiers compris, remonte dans le dossier qui le contenait./api/v1/move_client_file_itemsPOSTwriteÉcriture. Range des fichiers et des dossiers dans un autre dossier, ou les remet à la racine. Aucun octet ne bouge, et un dossier ne peut pas être rangé dans l'un de ses sous-dossiers.Parametersfile_idsstring[] · = []folder_idsstring[] · = []to_folder_idstring|null
ReturnsLink to this endpointobjectFieldsfile_idsstring[] · always presentfolder_idsstring[] · always presentto_folder_idnull|string · always present
decisions
/api/v1/list_decisionsGET · POSTreadLecture. Décisions de l'agence : ce qui a été tranché, le motif, l'option écartée, le jour et avec qui. Sans status, seules les décisions qui valent encore ; avec « all », l'histoire complète, remplacées et abandonnées comprises. Sans client_id, toutes ; avec null, celles qui ne concernent aucune fiche.Parametersclient_idstring|nullstatusstringValuesactivesupersededabandonedalllimitinteger — Combien de lignes rendre au plus (300 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentclient_idnull|string · always presenttitlestring · always presentrationalestring · always presentrejectednull|string · always presentdecided_onstring · always presentdecided_withnull|string · always presentstatusstring · always presentValuesactivesupersededabandonedsuperseded_bynull|string · always presentmeeting_idnull|string · always presentnote_idnull|string · always presentevidencenull|string · always presentcreated_bynull|string · always presentcreated_atstring · always presentupdated_atstring · always presentclient_namenull|string · always presentcreated_by_namenull|string · always present
/api/v1/get_decisionGET · POSTreadLecture. Une décision et sa chaîne : ce qu'elle a remplacé, ce qui l'a remplacée, la réunion d'où elle vient et la note qui la développe. Lue de haut en bas, la chaîne dit pourquoi on en est là.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsdecisionobject · always presentsupersedesnull|object · always presentsupersededBynull|object · always presentmeeting_titlenull|string · always presentnote_namenull|string · always present
/api/v1/create_decisionPOSTwriteÉcriture. Note une décision : ce qui est tranché (au présent, comme un fait), pourquoi, et ce qui a été écarté. N'écrase rien. À n'employer que pour ce que quelqu'un pourrait contredire demain, jamais pour un fait qui a déjà son champ. Si elle contredit une décision qui vaut encore, c'est supersedeDecision qu'il faut.Parameterstitlestring · requiredrationalestring · requiredrejectedstring|nullclient_idstring|nulldecided_onstringdecided_withstring|nullmeeting_idstring|nullnote_idstring|nullevidencestring|null
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idnull|string · always presenttitlestring · always presentrationalestring · always presentrejectednull|string · always presentdecided_onstring · always presentdecided_withnull|string · always presentstatusstring · always presentValuesactivesupersededabandonedsuperseded_bynull|string · always presentmeeting_idnull|string · always presentnote_idnull|string · always presentevidencenull|string · always presentcreated_bynull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/supersede_decisionPOSTwriteÉcriture. Remplace une décision par une nouvelle : celle d'avant cesse de valoir et pointe vers celle-ci, sans rien perdre de son motif. C'est le geste du revirement (« finalement on ne fait plus ça, on fait ça »). Refusé sur une décision déjà remplacée ou abandonnée.Parametersidstring · requiredtitlestring · requiredrationalestring · requiredrejectedstring|nullclient_idstring|nulldecided_onstringdecided_withstring|nullmeeting_idstring|nullnote_idstring|nullevidencestring|null
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idnull|string · always presenttitlestring · always presentrationalestring · always presentrejectednull|string · always presentdecided_onstring · always presentdecided_withnull|string · always presentstatusstring · always presentValuesactivesupersededabandonedsuperseded_bynull|string · always presentmeeting_idnull|string · always presentnote_idnull|string · always presentevidencenull|string · always presentcreated_bynull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/update_decisionPOSTwriteÉcriture. Corrige une décision : sa formulation, son motif, sa date, la fiche ou la source qu'elle cite, ou son statut (abandoned quand on ne fait plus ça sans que rien ne prenne la place, active pour revenir dessus). Mise à jour partielle. Ce n'est PAS le geste du revirement, qui est supersedeDecision : réécrire un motif efface le pourquoi d'avant.Parametersidstring · requiredtitlestringrationalestringrejectedstring|nullclient_idstring|nulldecided_onstringdecided_withstring|nullmeeting_idstring|nullnote_idstring|nullevidencestring|nullstatusstringValuesactiveabandoned
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idnull|string · always presenttitlestring · always presentrationalestring · always presentrejectednull|string · always presentdecided_onstring · always presentdecided_withnull|string · always presentstatusstring · always presentValuesactivesupersededabandonedsuperseded_bynull|string · always presentmeeting_idnull|string · always presentnote_idnull|string · always presentevidencenull|string · always presentcreated_bynull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/delete_decisionPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une décision, son motif et sa place dans la chaîne. Réservé à ce qui n'aurait jamais dû être noté (un doublon, un contresens) : une décision réellement prise se remplace ou s'abandonne, elle ne s'efface pas.
assistant-conversations
/api/v1/list_assistant_conversationsGET · POSTreadLecture. Vos conversations avec l'assistant de l'espace admin, de la plus récente à la plus ancienne : leur titre et leur dernière activité. « search » ne filtre que sur le titre. Celles des autres membres de l'agence ne sont jamais rendues.Parameterssearchstring — Ne garde que les conversations dont le TITRE contient ces mots. Le contenu des messages n'est pas fouillé, et un fil jamais nommé ne ressort donc d'aucune recherche.limitinteger — Combien de lignes rendre au plus (100 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presenttitlenull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/get_assistant_conversationGET · POSTreadLecture. Une de vos conversations avec l'assistant, avec tout ce qui s'y est dit : les messages, les outils appelés et ce qu'ils ont rendu. À demander pour reprendre le fil d'un échange passé.Parametersidstring · required — Identifiant de la conversation.
ReturnsLink to this endpointobjectFieldsidstring · always presenttitlenull|string · always presentcreated_atstring · always presentupdated_atstring · always presentturnsobject|object|object[] · always present
/api/v1/rename_assistant_conversationPOSTwriteÉcriture. Corrige le titre d'une de vos conversations. Ce qu'elle contient ne bouge pas : c'est le nom qu'on lit dans la liste, rien d'autre.Parametersidstring · required — Identifiant de la conversation.titlestring · required — Titre de la conversation, tel qu'il se lit dans la liste.
ReturnsLink to this endpointobjectFieldsidstring · always presenttitlenull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/delete_assistant_conversationPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une de vos conversations avec l'assistant, et tout ce qui s'y est dit. Rien ne se récupère ensuite.Parametersidstring · required — Identifiant de la conversation.
ReturnsLink to this endpointobjectFieldsidstring · always present
media
/api/v1/list_media_conversationsGET · POSTreadLecture. Les fils du Studio, du plus récemment nourri au plus ancien : leur titre, leur rangement et leur dernière activité. Sans filtre, seuls les fils en cours ; « archived » rend ceux qui sont rangés, « all » les deux.Parametersarchivedstring — « active » (défaut) pour les conversations en cours, « archived » pour celles qui sont rangées, « all » pour les deux.Valuesactivearchivedalllimitinteger — Combien de lignes rendre au plus (100 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presenttitlenull|string · always presentarchived_atnull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/get_media_conversationGET · POSTreadLecture. Un fil du Studio : son titre, s'il est rangé, et quand il a servi pour la dernière fois. Ce qu'il contient se lit par listMediaGenerations, avec son identifiant.Parametersidstring · required — Identifiant de la conversation.
ReturnsLink to this endpointobjectFieldsidstring · always presenttitlenull|string · always presentarchived_atnull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/create_media_conversationPOSTwriteÉcriture. Ouvre un fil dans le Studio. N'écrase rien. Le titre est facultatif : sans lui, la première consigne écrite dans le fil le nomme toute seule.Parameterstitlestring — Titre du fil, tel qu'il se lit dans la liste.
ReturnsLink to this endpointobjectFieldsidstring · always presenttitlenull|string · always presentarchived_atnull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/rename_media_conversationPOSTwriteÉcriture. Corrige le titre d'un fil. Ce qu'il contient ne bouge pas : c'est le nom qu'on lit dans la liste, rien d'autre.Parametersidstring · required — Identifiant de la conversation.titlestring · required — Titre du fil, tel qu'il se lit dans la liste.
ReturnsLink to this endpointobjectFieldsidstring · always presenttitlenull|string · always presentarchived_atnull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/set_media_conversation_archivedPOSTwriteÉcriture. Range un fil (archived: true) ou le reprend (false). Rien ne se perd dans un sens ni dans l'autre : un fil rangé sort de la liste courante et se rouvre quand on en a de nouveau besoin. Tant qu'il est rangé, aucune demande ne peut y être ajoutée.Parametersidstring · required — Identifiant de la conversation.archivedboolean · required — true range la conversation, false la reprend. Rien ne se perd dans un sens ni dans l'autre.
ReturnsLink to this endpointobjectFieldsidstring · always presenttitlenull|string · always presentarchived_atnull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/list_media_generationsGET · POSTreadLecture. Les demandes d'un fil, de la plus récente à la plus ancienne : ce qui a été demandé, dans quel format et quel cadrage, où en est chaque demande, et ce que le rendu a coûté. Sans conversation_id, toutes les demandes de l'agence. Le rendu lui-même se regarde dans l'espace d'administration.Parametersconversation_idstring — Ne rend que les demandes de cette conversation. Sans lui, toutes.limitinteger — Combien de lignes rendre au plus (100 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentconversation_idstring · always presentpromptstring · always presentformatstring · always presentValuesimagevideoorientationstring · always presentValuesportraitlandscapemodelstring · always presentstatusstring · always presentValuesfailedpendingrunningreadyinput_countnumber · always presentmime_typenull|string · always presentwidthnull|number · always presentheightnull|number · always presentduration_secondsnull|number · always presentcost_usdnull|number · always presenterrornull|string · always presentcreated_atstring · always present
/api/v1/get_media_generationGET · POSTreadLecture. Une demande de génération et son état : en attente, en cours, rendue, ou échouée avec la raison. C'est ce qu'on relit pour savoir si un rendu lancé il y a deux minutes est arrivé.Parametersidstring · required — Identifiant de la génération.
ReturnsLink to this endpointobjectFieldsidstring · always presentconversation_idstring · always presentpromptstring · always presentformatstring · always presentValuesimagevideoorientationstring · always presentValuesportraitlandscapemodelstring · always presentstatusstring · always presentValuesfailedpendingrunningreadyinput_countnumber · always presentmime_typenull|string · always presentwidthnull|number · always presentheightnull|number · always presentduration_secondsnull|number · always presentcost_usdnull|number · always presenterrornull|string · always presentcreated_atstring · always present
/api/v1/create_media_generationPOSTwriteÉcriture. Demande une image ou un plan de six secondes à partir d'une consigne écrite, en portrait ou en paysage, avec jusqu'à quatre images de référence. Sans conversation_id, la demande rejoint le fil le plus récemment nourri, ou en ouvre un si l'agence n'en a aucun ; un fil rangé la refuse. N'écrase rien et ne lance rien : la demande naît en attente, c'est advanceMediaGeneration qui l'envoie au modèle.Parametersconversation_idstring — La conversation où poser la demande. Sans lui, la plus récemment nourrie, ou une nouvelle si l'agence n'en a aucune.promptstring · required — Ce qu'on veut voir, en toutes lettres. La consigne part telle quelle au modèle.formatstring · required — « image » pour un visuel fixe, « video » pour un plan de six secondes avec le son.Valuesimagevideoorientationstring · required — « portrait » (9:16, une story) ou « landscape » (16:9, un post ou une bannière).Valuesportraitlandscapeimagesstring[] — Images de référence en data URL, quatre au plus. Le modèle s'en inspire pour une image ; pour une vidéo, la première sert de premier plan.
ReturnsLink to this endpointobjectFieldsidstring · always presentconversation_idstring · always presentpromptstring · always presentformatstring · always presentValuesimagevideoorientationstring · always presentValuesportraitlandscapemodelstring · always presentstatusstring · always presentValuesfailedpendingrunningreadyinput_countnumber · always presentmime_typenull|string · always presentwidthnull|number · always presentheightnull|number · always presentduration_secondsnull|number · always presentcost_usdnull|number · always presenterrornull|string · always presentcreated_atstring · always present
/api/v1/advance_media_generationPOSTwriteÉcriture. Fait avancer une demande d'un cran : l'envoie au modèle si elle attendait, relit le travail en cours, et range le rendu quand il arrive. À rappeler toutes les quelques dizaines de secondes tant que l'état n'est ni « ready » ni « failed ». Sans effet sur ce qui a fini, et une demande déjà en vol n'est jamais relancée : elle ne se paie pas deux fois.Parametersidstring · required — Identifiant de la génération.
ReturnsLink to this endpointobjectFieldsidstring · always presentconversation_idstring · always presentpromptstring · always presentformatstring · always presentValuesimagevideoorientationstring · always presentValuesportraitlandscapemodelstring · always presentstatusstring · always presentValuesfailedpendingrunningreadyinput_countnumber · always presentmime_typenull|string · always presentwidthnull|number · always presentheightnull|number · always presentduration_secondsnull|number · always presentcost_usdnull|number · always presenterrornull|string · always presentcreated_atstring · always present
/api/v1/delete_media_generationPOSTdestructiveSuppression définitive, irréversible. Supprime une génération, ses images de référence et son rendu. Les octets partent avec la ligne : ce qui n'a pas été téléchargé est perdu.Parametersidstring · required — Identifiant de la génération.
ReturnsLink to this endpointobjectFieldsidstring · always present
notes
/api/v1/list_admin_notesGET · POSTreadLecture. Notes de l'équipe : nom, fiche client rattachée, auteur, dates, nombre de commentaires, date de publication au client (null si la note n'est pas partie). Sans le corps des notes. Sans client_id, rend toutes les notes ; avec null, celles qui ne sont rattachées à aucune fiche.Parametersclient_idstring|nulllimitinteger — Combien de lignes rendre au plus (300 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobjectFieldsclient_idnull|string · always presentfoldersobject[] · always presentnotesobject[] · always present
/api/v1/get_admin_noteGET · POSTreadLecture. Une note en entier, corps Markdown compris : ce qui s'écrit en ce moment, l'instantané publié au client s'il y en a un, ses médias, et l'annuaire des personnes que son fil peut interpeller.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsnoteobject · always presentpublicationnull|object · always presentcreated_by_namenull|string · always presentmediaobject[] · always presentcurrent_user_idstring · always presentteamobject[] · always presentmembersobject[] · always presentfoldersobject[] · always present
/api/v1/create_admin_notePOSTwriteÉcriture. Ouvre une note, rattachée ou non à une fiche client. Le client ne la voit pas : le corps Markdown peut être fourni d'emblée ou écrit ensuite par updateAdminNote, puis remis par publishAdminNote.Parametersnamestring · requiredclient_idstring|nullfolder_idstring|nullcontentstring
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idnull|string · always presentfolder_idnull|string · always presentnamestring · always presentcontentstring · always presentcreated_bynull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/update_admin_notePOSTwriteÉcriture. Écrit une note : son nom, son corps Markdown ou la fiche client qu'elle vise. Mise à jour partielle, les champs absents restent en place ; client_id à null détache la note de sa fiche. Rien n'arrive au client tant que publishAdminNote n'a pas été rappelé, et changer la fiche d'une note publiée la dépublie.Parametersidstring · requirednamestringclient_idstring|nullfolder_idstring|nullcontentstring
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idnull|string · always presentfolder_idnull|string · always presentnamestring · always presentcontentstring · always presentcreated_bynull|string · always presentcreated_atstring · always presentupdated_atstring · always present
/api/v1/publish_admin_notePOSTwriteÉcriture. Publie une note au client de sa fiche : elle devient un rapport, lisible dans son espace, fil de commentaires et médias compris. Refusé si la note n'est rattachée à aucune fiche. Sans versions conservées, la dernière publication fait foi.Parametersidstring · required
ReturnsLink to this endpointobjectFieldsnote_idstring · always presentclient_idstring · always presentnamestring · always presentcontentstring · always presentpublished_atstring · always present
/api/v1/unpublish_admin_notePOSTwriteÉcriture. Retire une note de l'espace de son client : elle redevient interne, son fil se referme et ses médias avec. Rien n'est supprimé, republier la rend d'un coup./api/v1/delete_admin_notePOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une note, tout son fil de commentaires, et ce que le client en lisait si elle était publiée./api/v1/list_note_commentsGET · POSTreadLecture. Fil d'une note, du plus ancien message au plus récent.Parametersnote_idstring · requiredlimitinteger — Combien de lignes rendre au plus (300 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesparent_idnull|string · always presentanchor_exactnull|string · always presentanchor_prefixnull|string · always presentanchor_suffixnull|string · always presentresolved_atnull|string · always presentresolved_bynull|string · always presentresolved_by_namenull|string · always presentidstring · always presentauthor_idnull|string · always presentauthor_namestring · always presentauthor_avatar_urlnull|string · always presentauthor_sidestring · always presentValuesclientteambodystring · always presentcreated_atstring · always presentedited_atnull|string · always presentshared_with_clientstringValuesfalsetrue
/api/v1/add_note_commentPOSTwriteÉcriture. Écrit un message dans le fil d'une note, au nom de l'administrateur de la clé. Sur une note publiée, le client le lit ; « @[Nom](uuid) » notifie la personne nommée si elle voit la note. « parent_id » range le message sous une question déjà posée ; « anchor » l'attache à un passage du texte, en reprenant le passage exact et ce qui l'entoure.Parametersnote_idstring · requiredbodystring · requiredparent_idstring|nullanchorobject|null
ReturnsLink to this endpointobjectFieldsparent_idnull|string · always presentanchor_exactnull|string · always presentanchor_prefixnull|string · always presentanchor_suffixnull|string · always presentresolved_atnull|string · always presentresolved_bynull|string · always presentresolved_by_namenull|string · always presentidstring · always presentauthor_idnull|string · always presentauthor_namestring · always presentauthor_avatar_urlnull|string · always presentauthor_sidestring · always presentValuesclientteambodystring · always presentcreated_atstring · always presentedited_atnull|string · always presentshared_with_clientstringValuesfalsetrue
/api/v1/resolve_note_commentPOSTwriteÉcriture. Clôt la question posée par un fil de note (resolved: true) ou la rouvre (false). Se pose sur le premier message d'un fil, jamais sur une réponse, et ne notifie personne.Parameterscomment_idstring · requiredresolvedboolean · required
ReturnsLink to this endpointobjectFieldsparent_idnull|string · always presentanchor_exactnull|string · always presentanchor_prefixnull|string · always presentanchor_suffixnull|string · always presentresolved_atnull|string · always presentresolved_bynull|string · always presentresolved_by_namenull|string · always presentidstring · always presentauthor_idnull|string · always presentauthor_namestring · always presentauthor_avatar_urlnull|string · always presentauthor_sidestring · always presentValuesclientteambodystring · always presentcreated_atstring · always presentedited_atnull|string · always presentshared_with_clientstringValuesfalsetrue
/api/v1/update_note_commentPOSTwriteÉcriture. Corrige un message du fil d'une note, écrit par le compte au nom duquel la clé MCP agit. Un message écrit par quelqu'un d'autre est refusé par le moteur. Le fil affichera « modifié » à côté de sa date. Corriger ne change pas le public du message : ce qui a été écrit avant la publication de la note reste interne.Parametersnote_idstring · requiredcomment_idstring · requiredbodystring · required
ReturnsLink to this endpointobjectFieldsparent_idnull|string · always presentanchor_exactnull|string · always presentanchor_prefixnull|string · always presentanchor_suffixnull|string · always presentresolved_atnull|string · always presentresolved_bynull|string · always presentresolved_by_namenull|string · always presentidstring · always presentauthor_idnull|string · always presentauthor_namestring · always presentauthor_avatar_urlnull|string · always presentauthor_sidestring · always presentValuesclientteambodystring · always presentcreated_atstring · always presentedited_atnull|string · always presentshared_with_clientstringValuesfalsetrue
/api/v1/delete_note_commentPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un message du fil d'une note, écrit par le compte au nom duquel la clé MCP agit. Refusé pour un message auquel on a répondu : il se corrige, il ne se supprime plus.Parametersnote_idstring · requiredcomment_idstring · required
ReturnsLink to this endpointobjectFieldsidstring · always present
note-folders
/api/v1/create_note_folderPOSTwriteÉcriture. Crée un dossier dans le carnet interne, à la racine ou dans un autre dossier. Deux dossiers de même nom ne cohabitent pas au même endroit.Parametersparent_idstring|nullnamestring · required
ReturnsLink to this endpointobjectFieldsidstring · always presentparent_idnull|string · always presentnamestring · always presentcreated_atstring · always present
/api/v1/rename_note_folderPOSTwriteÉcriture. Renomme un dossier du carnet interne. Ce qu'il contient n'est pas touché et ne change pas de place.Parametersidstring · requirednamestring · required
ReturnsLink to this endpointobjectFieldsidstring · always presentparent_idnull|string · always presentnamestring · always presentcreated_atstring · always present
/api/v1/delete_note_folderPOSTwriteÉcriture. Supprime un dossier du carnet interne. Aucune note n'est supprimée : son contenu, sous-dossiers compris, remonte dans le dossier qui le contenait./api/v1/move_note_itemsPOSTwriteÉcriture. Range des notes et des dossiers du carnet dans un autre dossier, ou les remet à la racine. Aucun texte n'est réécrit, et un dossier ne peut pas être rangé dans l'un de ses sous-dossiers.Parametersnote_idsstring[] · = []folder_idsstring[] · = []to_folder_idstring|null
ReturnsLink to this endpointobjectFieldsnote_idsstring[] · always presentfolder_idsstring[] · always presentto_folder_idnull|string · always present
tickets
/api/v1/get_ticket_boardGET · POSTreadLecture. Conversations avec un client : sujet, état, nombre de messages, date et aperçu du dernier. Sans le contenu des fils.Parametersclient_idstringlimitinteger — Combien de lignes rendre au plus (300 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobjectFieldsclient_idstring · always presentticketsobject[] · always presentcurrent_user_idstring · always presentsidestring · always presentValuesclientagency
/api/v1/get_ticket_inboxGET · POSTreadLecture. Toutes les conversations, tous clients confondus, de la plus récemment active à la plus ancienne : fiche, sujet, état et aperçu du dernier message. Pour savoir ce qui attend une réponse sans ouvrir les dossiers un par un.Parameterslimitinteger — Combien de lignes rendre au plus (300 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobjectFieldsticketsobject[] · always presentcurrent_user_idstring · always presentsidestring · always presentValuesclientagency
/api/v1/count_tickets_to_handleGET · POSTreadLecture. Nombre de conversations à traiter : ouvertes ou en cours, quel que soit le dernier à avoir écrit. C'est le chiffre de la ligne Messages de la navigation. Sans le contenu des fils./api/v1/list_ticket_messagesGET · POSTreadLecture. Fil d'une conversation, du plus ancien message au plus récent.Parametersticket_idstring · requiredlimitinteger — Combien de lignes rendre au plus (300 par défaut et au maximum).offsetinteger — Combien de lignes sauter, pour aller chercher la suite de la liste.
ReturnsLink to this endpointobject[]Each row carriesidstring · always presentauthor_idnull|string · always presentauthor_namestring · always presentauthor_avatar_urlnull|string · always presentauthor_sidestring · always presentValuesclientagencybodystring · always presentattachmentsobject[] · always presentcreated_atstring · always present
/api/v1/create_ticketPOSTwriteÉcriture. Lance une conversation avec un client, avec son premier message. Le client en est prévenu, et il lit ce message : il est écrit au nom de Noki Mind. `file_ids` joint des fichiers déjà envoyés au stockage, ce que cet outil ne sait pas faire : en pratique il reste vide ici (voir prepareClientFileUpload, non publié).Parametersclient_idstringsubjectstring · requiredbodystring · = ""file_idsstring[]
ReturnsLink to this endpointobjectFieldsidstring · always presentclient_idstring · always presentsubjectstring · always presentstatusstring · always presentValuesopenin_progressresolvedclosedcreated_bynull|string · always presentcreated_sidestring · always presentValuesclientagencylast_message_atstring · always presentclosed_atnull|string · always presentcreated_atstring · always presentmessage_countnumber · always presentpreviewnull|object · always present
/api/v1/add_ticket_messagePOSTwriteÉcriture. Répond dans une conversation, au nom de Noki Mind. Le client en est prévenu et lit le message. Répondre à une conversation archivée la rouvre. Même remarque que pour createTicket sur `file_ids`.Parametersticket_idstring · requiredbodystring · = ""file_idsstring[]
ReturnsLink to this endpointobjectFieldsmessageobject · always presentstatusstring · always presentValuesopenin_progressresolvedclosedclosed_atnull|string · always present
/api/v1/set_ticket_statusPOSTwriteÉcriture. Dit où en est une conversation : open (lancée), in_progress (en cours), resolved (réglée), closed (archivée).Parametersidstring · requiredstatusstring · requiredValuesopenin_progressresolvedclosed
ReturnsLink to this endpointobjectFieldsidstring · always presentstatusstring · always presentValuesopenin_progressresolvedclosedclosed_atnull|string · always present
company
/api/v1/get_companyGET · POSTreadLecture. Fiche de la société : identité légale, adresse, coordonnées bancaires./api/v1/upsert_companyPOSTwriteÉcriture. Enregistre la fiche de la société. Elle est unique, l'appel la remplace.Parametersnamestring · requiredlegal_namestringsiretstringvat_numberstringcountrystringaddressstringcontact_emailstringphonestringbank_namestringibanstringbicstring
ReturnsLink to this endpointobjectFieldsnamestring · always presentlegal_namenull|string · always presentsiretnull|string · always presentvat_numbernull|string · always presentcountrynull|string · always presentaddressnull|string · always presentcontact_emailnull|string · always presentphonenull|string · always presentbank_namenull|string · always presentibannull|string · always presentbicnull|string · always presentupdated_atstring · always present
company-search
/api/v1/search_french_companiesGET · POSTreadLecture. Cherche une entreprise française dans l'annuaire public (données INSEE) pour pré-remplir une fiche client.Parametersquerystring · required
ReturnsLink to this endpointobject[]Each row carriessirenstring · always presentsiretstring · always presentnamestring · always presentvatNumberstring · always presentaddressLine1string · always presentaddressLine2string · always presentpostalCodestring · always presentcitystring · always presentactiveboolean · always present
design
/api/v1/get_designGET · POSTreadLecture. Réglages de marque appliqués aux devis : couleurs, logo, typographie./api/v1/upsert_designPOSTwriteÉcriture. Enregistre les réglages de marque appliqués aux devis.Parametersprimary_colorstringsecondary_colorstringprimary_foregroundstring · = "cream"Valuescreaminksecondary_foregroundstring · = "cream"Valuescreamink
ReturnsLink to this endpointobjectFieldslogo_urlnull|string · always presentlogo_pathnull|string · always presentprimary_colornull|string · always presentsecondary_colornull|string · always presentprimary_foregroundstring · always presentsecondary_foregroundstring · always presentupdated_atstring · always present
/api/v1/upload_design_logoPOSTwriteÉcriture. Remplace le logo de la marque. L'image est attendue en data URL complète, ce qui la rend peu commode depuis un assistant.ParametersdataUrlstring · required
ReturnsLink to this endpointobjectFieldslogo_urlnull|string · always presentlogo_pathnull|string · always presentprimary_colornull|string · always presentsecondary_colornull|string · always presentprimary_foregroundstring · always presentsecondary_foregroundstring · always presentupdated_atstring · always present
/api/v1/remove_design_logoPOSTwriteÉcriture. Retire le logo de la marque.No parameters.
ReturnsLink to this endpointobjectFieldslogo_urlnull|string · always presentlogo_pathnull|string · always presentprimary_colornull|string · always presentsecondary_colornull|string · always presentprimary_foregroundstring · always presentsecondary_foregroundstring · always presentupdated_atstring · always present
editor-images
/api/v1/upload_editor_imagePOSTwriteÉcriture. Dépose une image à poser dans une description de tâche, un corps de note ou un message de fil, et rend son identifiant : l'écrire dans le texte se fait ensuite en Markdown, sous l'adresse /api/images/<id>. L'image est attendue en data URL complète, ce qui la rend peu commode depuis un assistant.Parametersdata_urlstring · requiredwidthintegerheightinteger
ReturnsLink to this endpointobjectFieldsidstring · always presentwidthnull|number · always presentheightnull|number · always present
editor-files
/api/v1/confirm_editor_file_uploadPOSTwriteÉcriture. Termine le dépôt d'une pièce jointe commencé ailleurs : relit la taille dans le stockage, puis rend le nom et l'identifiant du fichier. On l'écrit ensuite dans le texte sous la forme d'un lien Markdown, [nom](attachment:<id>). En pratique il reste inutilisable ici : l'envoi lui-même demande une autorisation d'écriture qui n'est pas publiée (voir prepareEditorFileUpload).Parametersfile_idstring · required
ReturnsLink to this endpointobjectFieldsidstring · always presentnamestring · always presentmimeTypestring · always presentsizeBytesnumber · always present
translation
/api/v1/translate_subjectPOSTwriteÉcriture. Traduit le titre et le texte d'une note, d'une tâche, d'une réunion (son compte rendu, jamais son transcript) ou d'un contenu de publication, dans l'une des quatre langues fr, en, es, de. Rien n'est réécrit : l'original reste tel quel. L'issue vaut réponse : « translated » avec le texte, « empty » s'il n'y a rien à traduire, « unavailable » si aucun modèle n'est configuré, « failed » si la traduction n'a pas abouti.Parameterssubjectstring · requiredValuesnotetaskmeetingsocial_contentidstring · requiredlocalestring · requiredValuesfrenesde
ReturnsLink to this endpointobject|object|object|object|object
The Noki Mind API
The key, the scopes, the envelopes, the call ceiling and the refusal codes: everything to know before calling.