API

Puntos de entrada

Un punto de entrada por acción del área de administración: su dirección, lo que exige y lo que devuelve. La lista se deriva del código; no puede describir la versión de ayer.

196 puntos de entrada · 63 de lectura · 104 de escritura · 29 de eliminación

196 de 196

account

  • /api/v1/get_accountGET · POSTreadLecture. Réglages du compte au nom duquel la clé MCP agit : nom affiché, adresse, langue.

    Sin parámetros.

    Devuelve object
    Campos
    • full_name null|string · siempre presente
    • avatar_url null|string · siempre presente
    • locale string · siempre presente
    • email null|string · siempre presente
    • provider_avatar_url null|string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/update_accountPOSTwriteÉcriture. Modifie le nom affiché et la langue du compte au nom duquel la clé MCP agit.
    Parámetros
    • full_name string · obligatorio
    Devuelve object
    Campos
    • full_name null|string · siempre presente
    • avatar_url null|string · siempre presente
    • locale string · siempre presente
    • email null|string · siempre presente
    • provider_avatar_url null|string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • dataUrl string · obligatorio
    Devuelve object
    Campos
    • full_name null|string · siempre presente
    • avatar_url null|string · siempre presente
    • locale string · siempre presente
    • email null|string · siempre presente
    • provider_avatar_url null|string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/remove_account_avatarPOSTwriteÉcriture. Retire l'avatar du compte et rétablit l'initiale.

    Sin parámetros.

    Devuelve object
    Campos
    • full_name null|string · siempre presente
    • avatar_url null|string · siempre presente
    • locale string · siempre presente
    • email null|string · siempre presente
    • provider_avatar_url null|string · siempre presente
    Enlace a este punto de entrada

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.

    Sin parámetros.

    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • name string · siempre presente
    • role string · siempre presenteValores
      owneradminmember
    • active boolean · siempre presente
    Enlace a este punto de entrada
  • /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.

    Sin parámetros.

    Devuelve object
    Campos
    • hasClient boolean · siempre presente
    • hasCompany boolean · siempre presente
    • hasBrand boolean · siempre presente
    • hasTeammate boolean · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • name string · obligatorio
    Devuelve object
    Campos
    • agency_id string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • agency_id string · obligatorio
    Devuelve object
    Campos
    • agency_id string · siempre presente
    Enlace a este punto de entrada

admin-locale

  • /api/v1/set_admin_localePOSTwriteÉcriture. Change la langue dans laquelle le compte lit l'espace admin.
    Parámetros
    • locale string · obligatorioValores
      frenes
    Devuelve object
    Campos
    • locale string · siempre presenteValores
      frenes
    Enlace a este punto de entrada

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.
    Parámetros
    • limit integerCombien de lignes rendre au plus (50 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • type string · siempre presenteValores
      mentiontask_assignedtask_commentticket_openedticket_messageclient_file_addedcredential_activitynote_commentquestionnaire_answeredquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewed
    • read boolean · siempre presente
    • created_at string · siempre presente
    • title string · siempre presente
    • body string · siempre presente
    • href null|string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/count_unread_notificationsGET · POSTreadLecture. Nombre de notifications non lues, sans en rendre le contenu.

    Sin parámetros.

    Devuelve number
    Enlace a este punto de entrada
  • /api/v1/mark_notification_readPOSTwriteÉcriture. Marque une notification comme lue. Rien ne disparaît du tiroir, seule la pastille s'éteint.
    Parámetros
    • id string · obligatorio
    Devuelve void
    Enlace a este punto de entrada
  • /api/v1/mark_all_notifications_readPOSTwriteÉcriture. Éteint toutes les pastilles d'un geste, sans rien retirer du tiroir.

    Sin parámetros.

    Devuelve void
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve void
    Enlace a este punto de entrada
  • /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.

    Sin parámetros.

    Devuelve number
    Enlace a este punto de entrada
  • /api/v1/list_notification_settingsGET · POSTreadLecture. Réglages de notification du compte : un bloc par type recevable, avec l'état de chaque canal.

    Sin parámetros.

    Devuelve object[]
    Cada fila lleva
    • type string · siempre presenteValores
      mentiontask_assignedtask_commentticket_openedticket_messageclient_file_addedcredential_activitynote_commentquestionnaire_answeredquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewed
    • label string · siempre presente
    • description string · siempre presente
    • channels object · siempre presente
    Enlace a este punto de entrada
  • /api/v1/set_notification_channelPOSTwriteÉcriture. Coche ou décoche un canal de notification pour un type donné, et rend les réglages relus.
    Parámetros
    • type string · obligatorioValores
      mentiontask_assignedtask_commentticket_openedticket_messageclient_file_addedcredential_activitynote_commentquestionnaire_answeredquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewed
    • channel string · obligatorioValores
      in_appemailpush
    • enabled boolean · obligatorio
    Devuelve object[]
    Cada fila lleva
    • type string · siempre presenteValores
      mentiontask_assignedtask_commentticket_openedticket_messageclient_file_addedcredential_activitynote_commentquestionnaire_answeredquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewed
    • label string · siempre presente
    • description string · siempre presente
    • channels object · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • channel string · obligatorioValores
      in_appemailpush
    • enabled boolean · obligatorio
    Devuelve object[]
    Cada fila lleva
    • type string · siempre presenteValores
      mentiontask_assignedtask_commentticket_openedticket_messageclient_file_addedcredential_activitynote_commentquestionnaire_answeredquote_commentquote_signedbill_addedbill_duesocial_assignedsocial_to_approvesocial_reviewed
    • label string · siempre presente
    • description string · siempre presente
    • channels object · siempre presente
    Enlace a este punto de entrada

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.

    Sin parámetros.

    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • endpoint string · siempre presente
    • user_agent null|string · siempre presente
    • created_at string · siempre presente
    • last_used_at null|string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • endpoint string · obligatorio
    • p256dh string · obligatorio
    • auth string · obligatorio
    • user_agent string|null
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • endpoint string · siempre presente
    • user_agent null|string · siempre presente
    • created_at string · siempre presente
    • last_used_at null|string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • endpoint string · obligatorio
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • endpoint string · siempre presente
    • user_agent null|string · siempre presente
    • created_at string · siempre presente
    • last_used_at null|string · siempre presente
    Enlace a este punto de entrada

admin-invitations

  • /api/v1/list_adminsGET · POSTreadLecture. Administrateurs de l'agence : qui a accès à l'espace admin.

    Sin parámetros.

    Devuelve object[]
    Cada fila lleva
    • user_id string · siempre presente
    • email null|string · siempre presente
    • role string · siempre presenteValores
      owneradminmember
    • granted_at string · siempre presente
    • is_self boolean · siempre presente
    Enlace a este punto de entrada
  • /api/v1/list_admin_invitationsGET · POSTreadLecture. Invitations d'administrateur en cours, avec leur état et leur échéance.

    Sin parámetros.

    Devuelve object[]
    Cada fila lleva
    • expires_at string · siempre presente
    • accepted_at null|string · siempre presente
    • revoked_at null|string · siempre presente
    • id string · siempre presente
    • email string · siempre presente
    • invited_by null|string · siempre presente
    • created_at string · siempre presente
    • accepted_by null|string · siempre presente
    • invited_by_email null|string · siempre presente
    Enlace a este punto de entrada

clients

  • /api/v1/list_clientsGET · POSTreadLecture. Toutes les fiches clients, de la plus récemment modifiée à la plus ancienne, avec leur statut commercial.
    Parámetros
    • limit integerCombien de lignes rendre au plus (1000 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • name string · siempre presente
    • company null|string · siempre presente
    • country string · siempre presente
    • siret null|string · siempre presente
    • vat_number null|string · siempre presente
    • email null|string · siempre presente
    • phone null|string · siempre presente
    • address_line1 null|string · siempre presente
    • address_line2 null|string · siempre presente
    • postal_code null|string · siempre presente
    • city null|string · siempre presente
    • notes null|string · siempre presente
    • locale string · siempre presente
    • status string · siempre presenteValores
      leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
    • referrer_id null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • client object · siempre presente
    • referrer null|object · siempre presente
    • quotes object[] · siempre presente
    • forms object[] · siempre presente
    • custom object[] · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string
    • name string · obligatorio
    • company any|string|""
    • country string
    • siret any|string|""
    • vat_number any|string|""
    • email any|string|""
    • phone any|string|""
    • address_line1 any|string|""
    • address_line2 any|string|""
    • postal_code any|string|""
    • city any|string|""
    • notes any|string|""
    • locale stringValores
      frenes
    • status stringValores
      leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
    • referrer_id string|""|null
    Devuelve object
    Campos
    • address_line1 null|string · siempre presente
    • address_line2 null|string · siempre presente
    • city null|string · siempre presente
    • company null|string · siempre presente
    • country string · siempre presente
    • created_at string · siempre presente
    • created_by null|string · siempre presente
    • email null|string · siempre presente
    • id string · siempre presente
    • name string · siempre presente
    • notes null|string · siempre presente
    • phone null|string · siempre presente
    • postal_code null|string · siempre presente
    • siret null|string · siempre presente
    • updated_at string · siempre presente
    • vat_number null|string · siempre presente
    • locale string · siempre presente
    • status string · siempre presenteValores
      leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
    • referrer_id null|string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • status string · obligatorioValores
      leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
    Devuelve object
    Campos
    • id string · siempre presente
    • status string · siempre presenteValores
      leadfirst-callform-sentauditsecond-callquote-draftquote-sentsignedbuildliveinactivelost
    Enlace a este punto de entrada
  • /api/v1/delete_clientPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une fiche client. Irréversible : demander confirmation avant d'appeler.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada

tasks

  • /api/v1/list_client_membersGET · POSTreadLecture. Personnes rattachées aux espaces clients, à qui une tâche peut être assignée.

    Sin parámetros.

    Devuelve object[]
    Cada fila lleva
    • user_id string · siempre presente
    • email null|string · siempre presente
    • name null|string · siempre presente
    • avatar_url null|string · siempre presente
    • client_id string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • client_id string
    • meeting_id string
    • limit integerCombien de lignes rendre au plus (500 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • title string · siempre presente
    • description null|string · siempre presente
    • status string · siempre presenteValores
      proposedbacklogtododoingdone
    • priority string|null · siempre presenteValores
      lowmediumhighurgent
    • visibility string · siempre presenteValores
      publicteamprivate
    • created_by null|string · siempre presente
    • client_id null|string · siempre presente
    • client_name null|string · siempre presente
    • meeting_id null|string · siempre presente
    • meeting_title null|string · siempre presente
    • start_on null|string · siempre presente
    • due_on null|string · siempre presente
    • recurrence null|object · siempre presente
    • completed_at null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    • assignee_ids string[] · siempre presente
    • client_assignee_ids string[] · siempre presente
    • tags string[] · siempre presente
    • depends_on object[] · siempre presente
    • blocks object[] · siempre presente
    • comment_count number · siempre presente
    Enlace a este punto de entrada
  • /api/v1/get_taskGET · POSTreadLecture. Une tâche et ses rattachements.
    Parámetros
    • id string · obligatorio
    Devuelve null|object
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • title string · obligatorio
    • description string|null
    • status stringValores
      proposedbacklogtododoingdone
    • priority string|nullValores
      lowmediumhighurgent
    • visibility stringValores
      publicteamprivate
    • client_id string|null
    • meeting_id string|null
    • start_on string|null
    • due_on string|null
    • assignee_ids string[]
    • client_assignee_ids string[]
    • tags string[]|string[]
    • depends_on_ids string[]
    • recurrence object|null
    Devuelve object
    Campos
    • id string · siempre presente
    • title string · siempre presente
    • description null|string · siempre presente
    • status string · siempre presenteValores
      proposedbacklogtododoingdone
    • priority string|null · siempre presenteValores
      lowmediumhighurgent
    • visibility string · siempre presenteValores
      publicteamprivate
    • created_by null|string · siempre presente
    • client_id null|string · siempre presente
    • client_name null|string · siempre presente
    • meeting_id null|string · siempre presente
    • meeting_title null|string · siempre presente
    • start_on null|string · siempre presente
    • due_on null|string · siempre presente
    • recurrence null|object · siempre presente
    • completed_at null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    • assignee_ids string[] · siempre presente
    • client_assignee_ids string[] · siempre presente
    • tags string[] · siempre presente
    • depends_on object[] · siempre presente
    • blocks object[] · siempre presente
    • comment_count number · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • title string
    • description string|null
    • status stringValores
      proposedbacklogtododoingdone
    • priority string|nullValores
      lowmediumhighurgent
    • visibility stringValores
      publicteamprivate
    • client_id string|null
    • meeting_id string|null
    • start_on string|null
    • due_on string|null
    • assignee_ids string[]
    • client_assignee_ids string[]
    • tags string[]|string[]
    • depends_on_ids string[]
    • recurrence object|null
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • title string · siempre presente
    • description null|string · siempre presente
    • status string · siempre presenteValores
      proposedbacklogtododoingdone
    • priority string|null · siempre presenteValores
      lowmediumhighurgent
    • visibility string · siempre presenteValores
      publicteamprivate
    • created_by null|string · siempre presente
    • client_id null|string · siempre presente
    • client_name null|string · siempre presente
    • meeting_id null|string · siempre presente
    • meeting_title null|string · siempre presente
    • start_on null|string · siempre presente
    • due_on null|string · siempre presente
    • recurrence null|object · siempre presente
    • completed_at null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    • assignee_ids string[] · siempre presente
    • client_assignee_ids string[] · siempre presente
    • tags string[] · siempre presente
    • depends_on object[] · siempre presente
    • blocks object[] · siempre presente
    • comment_count number · siempre presente
    Enlace a este punto de entrada
  • /api/v1/delete_taskPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une tâche.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada
  • /api/v1/list_task_tagsGET · POSTreadLecture. Étiquettes de tâches déjà employées, avec le nombre de tâches qui les portent.

    Sin parámetros.

    Devuelve object[]
    Cada fila lleva
    • tag string · siempre presente
    • count number · siempre presente
    • color string|nullValores
      bluevioletgreenyelloworangered
    Enlace a este punto de entrada
  • /api/v1/list_task_membersGET · POSTreadLecture. Membres de l'équipe à qui une tâche peut être assignée.

    Sin parámetros.

    Devuelve object
    Campos
    • current_user_id string · siempre presente
    • members object[] · siempre presente
    Enlace a este punto de entrada

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é.
    Parámetros
    • client_id string
    Devuelve object
    Campos
    • users object[] · siempre presente
    • invitations object[] · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • client_id string
    • email string · obligatorio
    • locale stringValores
      frenes
    Devuelve object
    Campos
    • invitation object · siempre presente
    • url string · siempre presente
    • delivery string · siempre presenteValores
      sentnot_configuredfailed
    Enlace a este punto de entrada
  • /api/v1/revoke_client_invitationPOSTwriteÉcriture. Annule une invitation d'espace client qui n'a pas encore été acceptée.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • expires_at string · siempre presente
    • accepted_at null|string · siempre presente
    • revoked_at null|string · siempre presente
    • id string · siempre presente
    • client_id string · siempre presente
    • email string · siempre presente
    • invited_by null|string · siempre presente
    • created_at string · siempre presente
    • accepted_by null|string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/remove_client_userPOSTdestructiveSuppression définitive, irréversible. Retire à une personne son accès à l'espace d'un client.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada

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.

    Sin parámetros.

    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • key string · siempre presente
    • label string · siempre presente
    • type string · siempre presenteValores
      numberbooleanemailphonedatetextlong_texturlselect
    • options string[] · siempre presente
    • hint null|string · siempre presente
    • clientCount number · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • limit integerCombien de lignes rendre au plus (1000 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object
    Campos
    • fields object[] · siempre presente
    • clients object[] · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • label string|string · obligatorio
    • type string · obligatorioValores
      textlong_textnumberurlemailphonedatebooleanselect
    • options any|string[]|string[]
    • hint any|string|string
    Devuelve object
    Campos
    • id string · siempre presente
    • key string · siempre presente
    • label string · siempre presente
    • type string · siempre presenteValores
      numberbooleanemailphonedatetextlong_texturlselect
    • options string[] · siempre presente
    • hint null|string · siempre presente
    • clientCount number · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • label string|string · obligatorio
    • type string · obligatorioValores
      textlong_textnumberurlemailphonedatebooleanselect
    • options any|string[]|string[]
    • hint any|string|string
    Devuelve object
    Campos
    • id string · siempre presente
    • key string · siempre presente
    • label string · siempre presente
    • type string · siempre presenteValores
      numberbooleanemailphonedatetextlong_texturlselect
    • options string[] · siempre presente
    • hint null|string · siempre presente
    • clientCount number · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • client_id string · obligatorio
    • field_id string · obligatorio
    • value string · obligatorio
    Devuelve object
    Campos
    • field_id string · siempre presente
    • value null|string · siempre presente
    Enlace a este punto de entrada

referrers

  • /api/v1/list_referrersGET · POSTreadLecture. Catalogue des apporteurs d'affaires.

    Sin parámetros.

    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • name string · siempre presente
    • clientCount number · siempre presente
    Enlace a este punto de entrada
  • /api/v1/create_referrerPOSTwriteÉcriture. Ajoute un apporteur d'affaires au catalogue.
    Parámetros
    • name string|string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • name string · siempre presente
    • clientCount number · siempre presente
    Enlace a este punto de entrada
  • /api/v1/rename_referrerPOSTwriteÉcriture. Renomme un apporteur d'affaires.
    Parámetros
    • id string · obligatorio
    • name string|string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • name string · siempre presente
    • clientCount number · siempre presente
    Enlace a este punto de entrada
  • /api/v1/delete_referrerPOSTdestructiveSuppression définitive, irréversible. Retire un apporteur d'affaires du catalogue.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • client_id string · obligatorio
    • title string · obligatorio
    • locale stringValores
      frenes
    Devuelve object
    Campos
    • id string · siempre presente
    • slug string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/get_quote_for_editGET · POSTreadLecture. Devis complet tel que l'éditeur le voit : versions, prestations, totaux, régime de TVA.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • quote object · siempre presente
    • company null|object · siempre presente
    • versions object[] · siempre presente
    • currentVersion null|object · siempre presente
    • currentLines object[] · siempre presente
    • draft object · siempre presente
    • signature null|object · siempre presente
    • lastSigned null|object · siempre presente
    Enlace a este punto de entrada
  • /api/v1/update_quote_metaPOSTwriteÉcriture. Modifie l'en-tête d'un devis : titre, langue, durée de validité.
    Parámetros
    • id string · obligatorio
    • title string · obligatorio
    • locale string · obligatorioValores
      frenes
    • validity_days integer · obligatorio
    • regime string · obligatorioValores
      FR_20UE_AUTOLIQHORS_UEEXONERE
    • vat_exemption_note any|string|""
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • quote_id string · obligatorio
    • description_md any|string|""
    • note_md any|string|""
    • lines object[] · obligatorio
    • last_editor string · obligatorio
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • quote_id string · obligatorio
    • description_md any|string|""
    • note_md any|string|""
    • lines object[] · obligatorio
    Devuelve object
    Campos
    • version_id string · siempre presente
    • version_number number · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • quote_id string · obligatorio
    • version_id string · obligatorio
    • last_editor string
    Devuelve object
    Campos
    • description_md string · siempre presente
    • note_md string · siempre presente
    • lines object[] · siempre presente
    • version_number number · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • slug string · obligatorio
    • version integer · obligatorio
    • body string · obligatorio
    • parent_id string|null
    • anchor object|null
    Devuelve object
    Campos
    • id string · siempre presente
    • parent_id null|string · siempre presente
    • author_name string · siempre presente
    • is_admin boolean · siempre presente
    • body string · siempre presente
    • created_at string · siempre presente
    • anchor_type string|null · siempre presenteValores
      noteslinetotalscontext
    • anchor_line_id null|string · siempre presente
    • anchor_excerpt null|string · siempre presente
    Enlace a este punto de entrada

task-comments

  • /api/v1/list_task_commentsGET · POSTreadLecture. Fil d'une tâche, du plus ancien message au plus récent.
    Parámetros
    • task_id string · obligatorio
    • limit integerCombien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • parent_id null|string · siempre presente
    • anchor_exact null|string · siempre presente
    • anchor_prefix null|string · siempre presente
    • anchor_suffix null|string · siempre presente
    • resolved_at null|string · siempre presente
    • resolved_by null|string · siempre presente
    • resolved_by_name null|string · siempre presente
    • id string · siempre presente
    • author_id null|string · siempre presente
    • author_name string · siempre presente
    • author_avatar_url null|string · siempre presente
    • author_side string · siempre presenteValores
      clientteam
    • body string · siempre presente
    • created_at string · siempre presente
    • edited_at null|string · siempre presente
    • shared_with_client stringValores
      falsetrue
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • task_id string · obligatorio
    • body string · obligatorio
    • parent_id string|null
    • anchor object|null
    Devuelve object
    Campos
    • parent_id null|string · siempre presente
    • anchor_exact null|string · siempre presente
    • anchor_prefix null|string · siempre presente
    • anchor_suffix null|string · siempre presente
    • resolved_at null|string · siempre presente
    • resolved_by null|string · siempre presente
    • resolved_by_name null|string · siempre presente
    • id string · siempre presente
    • author_id null|string · siempre presente
    • author_name string · siempre presente
    • author_avatar_url null|string · siempre presente
    • author_side string · siempre presenteValores
      clientteam
    • body string · siempre presente
    • created_at string · siempre presente
    • edited_at null|string · siempre presente
    • shared_with_client stringValores
      falsetrue
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • comment_id string · obligatorio
    • resolved boolean · obligatorio
    Devuelve object
    Campos
    • parent_id null|string · siempre presente
    • anchor_exact null|string · siempre presente
    • anchor_prefix null|string · siempre presente
    • anchor_suffix null|string · siempre presente
    • resolved_at null|string · siempre presente
    • resolved_by null|string · siempre presente
    • resolved_by_name null|string · siempre presente
    • id string · siempre presente
    • author_id null|string · siempre presente
    • author_name string · siempre presente
    • author_avatar_url null|string · siempre presente
    • author_side string · siempre presenteValores
      clientteam
    • body string · siempre presente
    • created_at string · siempre presente
    • edited_at null|string · siempre presente
    • shared_with_client stringValores
      falsetrue
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • task_id string · obligatorio
    • comment_id string · obligatorio
    • body string · obligatorio
    Devuelve object
    Campos
    • parent_id null|string · siempre presente
    • anchor_exact null|string · siempre presente
    • anchor_prefix null|string · siempre presente
    • anchor_suffix null|string · siempre presente
    • resolved_at null|string · siempre presente
    • resolved_by null|string · siempre presente
    • resolved_by_name null|string · siempre presente
    • id string · siempre presente
    • author_id null|string · siempre presente
    • author_name string · siempre presente
    • author_avatar_url null|string · siempre presente
    • author_side string · siempre presenteValores
      clientteam
    • body string · siempre presente
    • created_at string · siempre presente
    • edited_at null|string · siempre presente
    • shared_with_client stringValores
      falsetrue
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • task_id string · obligatorio
    • comment_id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada

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.

    Sin parámetros.

    Devuelve object
    Campos
    • views object[] · siempre presente
    • default_view_id null|string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • name string|string · obligatorio
    • state object · obligatorio
    • makeDefault boolean · = false
    Devuelve object
    Campos
    • id string · siempre presente
    • name string · siempre presente
    • state object · siempre presente
    Enlace a este punto de entrada
  • /api/v1/update_task_viewPOSTwriteÉcriture. Renomme une vue enregistrée, remplace ses réglages, ou les deux.
    Parámetros
    • id string · obligatorio
    • name string|string
    • state object
    Devuelve object
    Campos
    • id string · siempre presente
    • name string · siempre presente
    • state object · siempre presente
    Enlace a este punto de entrada
  • /api/v1/delete_task_viewPOSTdestructiveSuppression définitive, irréversible. Supprime une vue enregistrée. Les tâches ne bougent pas.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string|null · obligatorio
    Devuelve object
    Campos
    • default_view_id null|string · siempre presente
    Enlace a este punto de entrada

social

  • /api/v1/list_social_contentsGET · POSTreadLecture. Contenus de publication, des parutions les plus proches aux plus lointaines, avec leurs étiquettes et leurs visuels. Sans client_id, tous ; avec un identifiant, ceux d'une fiche ; avec null, ceux qui ne visent aucune fiche, c'est-à-dire les idées notées avant leur destination. Un contenu porte son texte, son fil et ses visuels : la réponse est vite pleine, et « offset » est le seul moyen d'atteindre la fin de la liste.
    Parámetros
    • client_id string|null
    • limit integerCombien de lignes rendre au plus (500 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • client_id null|string · siempre presente
    • client_name null|string · siempre presente
    • title string · siempre presente
    • body null|string · siempre presente
    • tags string[] · siempre presente
    • status string · siempre presenteValores
      tododoingdraftto_approveto_improveapprovedscheduledpublished
    • scheduled_on null|string · siempre presente
    • scheduled_time null|string · siempre presente
    • published_url null|string · siempre presente
    • published_at null|string · siempre presente
    • assignee_ids string[] · siempre presente
    • media object|object[] · siempre presente
    • comments object[] · siempre presente
    • created_by null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/get_social_contentGET · POSTreadLecture. Un contenu et tout ce qui l'entoure : son texte, ses étiquettes, sa date de parution, ses assignés, ses visuels et les retours du client.
    Parámetros
    • id string · obligatorio
    Devuelve null|object
    Enlace a este punto de entrada
  • /api/v1/create_social_contentPOSTwriteÉcriture. Crée un contenu de publication. Le client est facultatif : une idée de post peut se noter avant sa destination, mais sans lui on ne cite que des visuels qui vivent ailleurs, un fichier déposé appartenant toujours à une fiche. « media » pose le carrousel dans l'ordre voulu : un visuel déposé s'y désigne par « file_id », un visuel cité par « url ». Poser le contenu d'emblée en « to_approve » invite les contacts du client à le relire.
    Parámetros
    • title string · obligatorio
    • body string|null
    • status stringValores
      drafttododoingto_approveto_improveapprovedscheduledpublished
    • tags string[]|string[]
    • client_id string|null
    • scheduled_on string|null
    • scheduled_time string|null
    • published_url string|null
    • assignee_ids string[]
    • media object|object[]
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id null|string · siempre presente
    • client_name null|string · siempre presente
    • title string · siempre presente
    • body null|string · siempre presente
    • tags string[] · siempre presente
    • status string · siempre presenteValores
      tododoingdraftto_approveto_improveapprovedscheduledpublished
    • scheduled_on null|string · siempre presente
    • scheduled_time null|string · siempre presente
    • published_url null|string · siempre presente
    • published_at null|string · siempre presente
    • assignee_ids string[] · siempre presente
    • media object|object[] · siempre presente
    • comments object[] · siempre presente
    • created_by null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/update_social_contentPOSTwriteÉcriture. Modifie un contenu : titre, texte, étiquettes, statut, date et heure de parution, liens, assignation. Le faire passer en « to_approve » invite les contacts du client à le relire ; « approved », « to_improve » et le retour en production restent des états que l'agence pose, la réponse du client passant par son espace.
    Parámetros
    • title string
    • body string|null
    • status stringValores
      drafttododoingto_approveto_improveapprovedscheduledpublished
    • tags string[]|string[]
    • client_id string|null
    • scheduled_on string|null
    • scheduled_time string|null
    • published_url string|null
    • assignee_ids string[]
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id null|string · siempre presente
    • client_name null|string · siempre presente
    • title string · siempre presente
    • body null|string · siempre presente
    • tags string[] · siempre presente
    • status string · siempre presenteValores
      tododoingdraftto_approveto_improveapprovedscheduledpublished
    • scheduled_on null|string · siempre presente
    • scheduled_time null|string · siempre presente
    • published_url null|string · siempre presente
    • published_at null|string · siempre presente
    • assignee_ids string[] · siempre presente
    • media object|object[] · siempre presente
    • comments object[] · siempre presente
    • created_by null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/delete_social_contentPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un contenu, avec ses visuels et les retours du client qui l'accompagnent.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada
  • /api/v1/add_social_commentPOSTwriteÉcriture. Écrit un commentaire de l'équipe sous un contenu, à n'importe quelle étape. Il n'emporte aucune décision : valider ou renvoyer un contenu reste le geste du client. Il n'est visible du client que si le contenu l'était déjà au moment où il est écrit ; sous un brouillon, il reste interne, et le contenu soumis plus tard ne le publie pas.
    Parámetros
    • id string · obligatorio
    • comment string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id null|string · siempre presente
    • client_name null|string · siempre presente
    • title string · siempre presente
    • body null|string · siempre presente
    • tags string[] · siempre presente
    • status string · siempre presenteValores
      tododoingdraftto_approveto_improveapprovedscheduledpublished
    • scheduled_on null|string · siempre presente
    • scheduled_time null|string · siempre presente
    • published_url null|string · siempre presente
    • published_at null|string · siempre presente
    • assignee_ids string[] · siempre presente
    • media object|object[] · siempre presente
    • comments object[] · siempre presente
    • created_by null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/reorder_social_mediaPOSTwriteÉcriture. Range les visuels d'un contenu dans l'ordre du carrousel : « media_ids » est la liste complète, fichiers déposés et liens cités mêlés, dans l'ordre voulu, et le premier est celui que le réseau montrera sans qu'on clique. Refuse si la liste n'est pas exactement celle du contenu.
    Parámetros
    • id string · obligatorio
    • media_ids string[] · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id null|string · siempre presente
    • client_name null|string · siempre presente
    • title string · siempre presente
    • body null|string · siempre presente
    • tags string[] · siempre presente
    • status string · siempre presenteValores
      tododoingdraftto_approveto_improveapprovedscheduledpublished
    • scheduled_on null|string · siempre presente
    • scheduled_time null|string · siempre presente
    • published_url null|string · siempre presente
    • published_at null|string · siempre presente
    • assignee_ids string[] · siempre presente
    • media object|object[] · siempre presente
    • comments object[] · siempre presente
    • created_by null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/set_social_tag_colorPOSTwriteÉcriture. Donne une couleur à une étiquette de contenu, ou la lui reprend avec « color: null ». Six teintes : blue, violet, green, yellow, orange, red. La couleur appartient au mot et vaut partout où il est posé. Rend le vocabulaire à jour.
    Parámetros
    • tag string|string · obligatorio
    • color string|null · obligatorioValores
      bluevioletgreenyelloworangered
    Devuelve object[]
    Cada fila lleva
    • tag string · siempre presente
    • count number · siempre presente
    • color string|nullValores
      bluevioletgreenyelloworangered
    Enlace a este punto de entrada
  • /api/v1/delete_social_tagPOSTdestructiveSuppression définitive, irréversible. Retire une étiquette de tous les contenus qui la portent, ce qui la fait sortir du vocabulaire, et efface sa couleur. Rien ne se souvient de quels contenus la portaient. Rend le vocabulaire à jour.
    Parámetros
    • tag string|string · obligatorio
    Devuelve object[]
    Cada fila lleva
    • tag string · siempre presente
    • count number · siempre presente
    • color string|nullValores
      bluevioletgreenyelloworangered
    Enlace a este punto de entrada
  • /api/v1/list_social_tagsGET · POSTreadLecture. Étiquettes de contenus déjà employées, avec le nombre de contenus qui les portent et la couleur choisie. C'est le vocabulaire de l'équipe (le réseau, le format, la campagne) : il n'y a pas d'autre catalogue.

    Sin parámetros.

    Devuelve object[]
    Cada fila lleva
    • tag string · siempre presente
    • count number · siempre presente
    • color string|nullValores
      bluevioletgreenyelloworangered
    Enlace a este punto de entrada

social-views

  • /api/v1/list_social_viewsGET · POSTreadLecture. Vues enregistrées du calendrier de publication du compte au nom duquel la clé MCP agit, et laquelle s'ouvre par défaut.

    Sin parámetros.

    Devuelve object
    Campos
    • views object[] · siempre presente
    • default_view_id null|string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/create_social_viewPOSTwriteÉcriture. Enregistre un jeu de filtres, de tri, de regroupement et d'affichage (liste, tableau ou calendrier) sous un nom, et peut en faire la vue ouverte par défaut.
    Parámetros
    • name string|string · obligatorio
    • state object · obligatorio
    • makeDefault boolean · = false
    Devuelve object
    Campos
    • id string · siempre presente
    • name string · siempre presente
    • state object · siempre presente
    Enlace a este punto de entrada
  • /api/v1/update_social_viewPOSTwriteÉcriture. Renomme une vue enregistrée du calendrier de publication, remplace ses réglages, ou les deux.
    Parámetros
    • id string · obligatorio
    • name string|string
    • state object
    Devuelve object
    Campos
    • id string · siempre presente
    • name string · siempre presente
    • state object · siempre presente
    Enlace a este punto de entrada
  • /api/v1/delete_social_viewPOSTdestructiveSuppression définitive, irréversible. Supprime une vue enregistrée du calendrier. Les contenus ne bougent pas.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada
  • /api/v1/set_default_social_viewPOSTwriteÉcriture. Désigne la vue qui s'ouvre par défaut sur le calendrier de publication, ou n'en désigne plus aucune avec id nul.
    Parámetros
    • id string|null · obligatorio
    Devuelve object
    Campos
    • default_view_id null|string · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • limit integerCombien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • source string · siempre presente
    • external_id null|string · siempre presente
    • title string · siempre presente
    • locale string · siempre presente
    • started_at string · siempre presente
    • ended_at null|string · siempre presente
    • duration_seconds null|number · siempre presente
    • participants object[] · siempre presente
    • tags string[] · siempre presente
    • summary null|string · siempre presente
    • transcript_chars number · siempre presente
    • created_at string · siempre presente
    • client_id null|string · siempre presente
    • client_name null|string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • include_transcript boolean · = falseJoindre le transcript intégral, qui peut être très long.
    Devuelve object
    Campos
    • created_at string · siempre presente
    • id string · siempre presente
    • locale string · siempre presente
    • client_id null|string · siempre presente
    • title string · siempre presente
    • source string · siempre presente
    • external_id null|string · siempre presente
    • started_at string · siempre presente
    • ended_at null|string · siempre presente
    • duration_seconds null|number · siempre presente
    • tags string[] · siempre presente
    • summary null|string · siempre presente
    • transcript_chars number · siempre presente
    • client_name null|string · siempre presente
    • participants object[] · siempre presente
    • meeting_url null|string · siempre presente
    • recording_url null|string · siempre presente
    • metadata object · siempre presente
    • transcript null|string · siempre presente
    • api_key_name null|string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • client_id string|null · obligatorio
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • outcome string · siempre presenteValores
      failedwrittenskipped
    Enlace a este punto de entrada
  • /api/v1/delete_meetingPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement une réunion, son résumé et son transcript.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • meeting_id string
    • client_id string
    • limit integerCombien de lignes rendre au plus (200 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • meeting_id string · siempre presente
    • client_id null|string · siempre presente
    • target string · siempre presenteValores
      clienttasknotedecisionclient_custom_value
    • operation string · siempre presenteValores
      createupdate
    • target_id null|string · siempre presente
    • changes object[] · siempre presente
    • evidence string · siempre presente
    • status string · siempre presenteValores
      approvedrejectedpending
    • applied_id null|string · siempre presente
    • decided_at null|string · siempre presente
    • created_at string · siempre presente
    • target_name null|string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • changes object[]
    • force boolean
    Devuelve object
    Campos
    • ok boolean · siempre presente
    • applied_id null|string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • ok boolean · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • limit integerCombien de lignes rendre au plus (50 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • meeting_url string · siempre presente
    • join_at null|string · siempre presente
    • status string · siempre presenteValores
      faileddonescheduledrecordingcancelled
    • error null|string · siempre presente
    • meeting_id null|string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • hours integerHorizon en heures (24 par défaut, 336 au maximum). Ce qui est en cours est rendu quoi qu'il arrive.
    • limit integerCombien de lignes rendre au plus (50 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • title null|string · siempre presente
    • meeting_url string · siempre presente
    • join_at null|string · siempre presente
    • status string · siempre presenteValores
      faileddonescheduledrecordingcancelled
    • origin string · siempre presenteValores
      calendarmanualmeet
    • meeting_id null|string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • meeting_url string · obligatorio
    • join_at string|null
    • title string|null
    Devuelve object
    Campos
    • status string · siempre presenteValores
      createdreused
    • recording object · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • title string|null
    Devuelve object
    Campos
    • meeting_url string · siempre presente
    • recording object · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • meeting_url string · siempre presente
    • join_at null|string · siempre presente
    • status string · siempre presenteValores
      faileddonescheduledrecordingcancelled
    • error null|string · siempre presente
    • meeting_id null|string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • url null|string · siempre presente
    Enlace a este punto de entrada

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.

    Sin parámetros.

    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • user_id string · siempre presente
    • platform_email null|string · siempre presente
    • status string · siempre presenteValores
      pendingconnecteddisconnected
    • active boolean · siempre presente
    • error null|string · siempre presente
    • synced_at null|string · siempre presente
    • meet_auto_join boolean · siempre presente
    • meet_subscription_name null|string · siempre presente
    • meet_subscription_expire_at null|string · siempre presente
    • meet_error null|string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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é.

    Sin parámetros.

    Devuelve object
    Campos
    • url string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • active boolean · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • user_id string · siempre presente
    • platform_email null|string · siempre presente
    • status string · siempre presenteValores
      pendingconnecteddisconnected
    • active boolean · siempre presente
    • error null|string · siempre presente
    • synced_at null|string · siempre presente
    • meet_auto_join boolean · siempre presente
    • meet_subscription_name null|string · siempre presente
    • meet_subscription_expire_at null|string · siempre presente
    • meet_error null|string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • enabled boolean · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • user_id string · siempre presente
    • platform_email null|string · siempre presente
    • status string · siempre presenteValores
      pendingconnecteddisconnected
    • active boolean · siempre presente
    • error null|string · siempre presente
    • synced_at null|string · siempre presente
    • meet_auto_join boolean · siempre presente
    • meet_subscription_name null|string · siempre presente
    • meet_subscription_expire_at null|string · siempre presente
    • meet_error null|string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • user_id string · siempre presente
    • platform_email null|string · siempre presente
    • status string · siempre presenteValores
      pendingconnecteddisconnected
    • active boolean · siempre presente
    • error null|string · siempre presente
    • synced_at null|string · siempre presente
    • meet_auto_join boolean · siempre presente
    • meet_subscription_name null|string · siempre presente
    • meet_subscription_expire_at null|string · siempre presente
    • meet_error null|string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • limit integerCombien de lignes rendre au plus (200 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • title string · siempre presente
    • description null|string · siempre presente
    • locale string · siempre presente
    • questions number · siempre presente
    • sent number · siempre presente
    • completed number · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/get_questionnaireGET · POSTreadLecture. Un questionnaire et sa structure entière : sections, questions, options.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • title string · siempre presente
    • description null|string · siempre presente
    • locale string · siempre presente
    • content object · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string
    • title string · obligatorio
    • description string
    • locale string · = "fr"Valores
      frenes
    • content object · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/duplicate_questionnairePOSTwriteÉcriture. Copie un questionnaire sous un nouveau nom, pour en faire une variante qu'on modifie ensuite.
    Parámetros
    • id string · obligatorio
    • title string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/delete_questionnairePOSTdestructiveSuppression définitive, irréversible. Supprime un questionnaire de la bibliothèque. Les envois déjà faits restent lisibles.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • ok true · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • questionnaire_id string · obligatorio
    • client_id string · obligatorio
    • email string
    • notify boolean · = true
    Devuelve object
    Campos
    • id string · siempre presente
    • url string · siempre presente
    • sent boolean · siempre presente
    Enlace a este punto de entrada
  • /api/v1/list_questionnaire_responsesGET · POSTreadLecture. Envois faits et où ils en sont, éventuellement filtrés sur un client ou un questionnaire.
    Parámetros
    • client_id string
    • questionnaire_id string
    • limit integerCombien de lignes rendre au plus (500 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • client_id string · siempre presente
    • client_name null|string · siempre presente
    • questionnaire_id null|string · siempre presente
    • questionnaire_title string · siempre presente
    • email null|string · siempre presente
    • locale string · siempre presente
    • token string · siempre presente
    • sent_at null|string · siempre presente
    • opened_at null|string · siempre presente
    • completed_at null|string · siempre presente
    • updated_at string · siempre presente
    • answered number · siempre presente
    • total number · siempre presente
    Enlace a este punto de entrada
  • /api/v1/get_questionnaire_responseGET · POSTreadLecture. Une réponse, question par question, telle qu'elle a été posée.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • response object · siempre presente
    • content object · siempre presente
    • answers object · siempre presente
    Enlace a este punto de entrada
  • /api/v1/delete_questionnaire_responsePOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un envoi et les réponses qu'il portait.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • ok true · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • client_id string
    Devuelve object
    Campos
    • credentials object[] · siempre presente
    • requests object[] · siempre presente
    • events object[] · siempre presente
    • side string · siempre presenteValores
      clientagency
    • key_available boolean · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • client_id string
    • label string · obligatorio
    • type string · obligatorioValores
      loginapi_key
    • values object · obligatorio
    • request_id string
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id string · siempre presente
    • label string · siempre presente
    • type string · siempre presenteValores
      loginapi_key
    • key_version number · siempre presente
    • created_by null|string · siempre presente
    • created_side string · siempre presenteValores
      clientagency
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/update_credentialPOSTwriteÉcriture. Modifie un identifiant déposé. Remplacer le secret écrase l'ancien sans recours.
    Parámetros
    • id string · obligatorio
    • label string
    • values object
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id string · siempre presente
    • label string · siempre presente
    • type string · siempre presenteValores
      loginapi_key
    • key_version number · siempre presente
    • created_by null|string · siempre presente
    • created_side string · siempre presenteValores
      clientagency
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/delete_credentialPOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un identifiant déposé.
    Parámetros
    • id string · obligatorio
    Devuelve void
    Enlace a este punto de entrada
  • /api/v1/create_credential_requestPOSTwriteÉcriture. Demande un identifiant à un client. Aucun secret n'entre ici, seulement la demande.
    Parámetros
    • client_id string
    • label string · obligatorio
    • type string · obligatorioValores
      loginapi_key
    • message string
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id string · siempre presente
    • label string · siempre presente
    • type string · siempre presenteValores
      loginapi_key
    • message null|string · siempre presente
    • status string · siempre presenteValores
      opencancelledfulfilleddeclined
    • requested_side string · siempre presenteValores
      clientagency
    • requested_by_label string · siempre presente
    • fulfilled_credential_id null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/close_credential_requestPOSTwriteÉcriture. Clôt une demande d'identifiant.
    Parámetros
    • id string · obligatorio
    • status string · obligatorioValores
      declinedcancelled
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id string · siempre presente
    • label string · siempre presente
    • type string · siempre presenteValores
      loginapi_key
    • message null|string · siempre presente
    • status string · siempre presenteValores
      opencancelledfulfilleddeclined
    • requested_side string · siempre presenteValores
      clientagency
    • requested_by_label string · siempre presente
    • fulfilled_credential_id null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/get_key_rotation_statusGET · POSTreadLecture. État du chiffrement des identifiants : version de clé en service et nombre de secrets restant à re-chiffrer.

    Sin parámetros.

    Devuelve object
    Campos
    • current null|number · siempre presente
    • available number[] · siempre presente
    • counts object[] · siempre presente
    • orphaned number[] · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • client_id string
    • limit integerCombien de lignes rendre au plus (500 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • client_id string · siempre presente
    • number string · siempre presente
    • issued_on string · siempre presente
    • due_on null|string · siempre presente
    • paid_on null|string · siempre presente
    • total_cents number · siempre presente
    • vat_cents number · siempre presente
    • file_name string · siempre presente
    • size_bytes number · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • client_id string · obligatorio
    • number string · obligatorio
    • issued_on string · obligatorio
    • due_on string|null
    • total_cents integer · obligatorio
    • vat_cents integer · obligatorio
    • file_name string · obligatorio
    • data_url string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id string · siempre presente
    • number string · siempre presente
    • issued_on string · siempre presente
    • due_on null|string · siempre presente
    • paid_on null|string · siempre presente
    • total_cents number · siempre presente
    • vat_cents number · siempre presente
    • file_name string · siempre presente
    • size_bytes number · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • due_on string|null · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id string · siempre presente
    • number string · siempre presente
    • issued_on string · siempre presente
    • due_on null|string · siempre presente
    • paid_on null|string · siempre presente
    • total_cents number · siempre presente
    • vat_cents number · siempre presente
    • file_name string · siempre presente
    • size_bytes number · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • paid_on string|null · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id string · siempre presente
    • number string · siempre presente
    • issued_on string · siempre presente
    • due_on null|string · siempre presente
    • paid_on null|string · siempre presente
    • total_cents number · siempre presente
    • vat_cents number · siempre presente
    • file_name string · siempre presente
    • size_bytes number · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • client_id string
    Devuelve object
    Campos
    • metrics object[] · siempre presente
    Enlace a este punto de entrada
  • /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é.
    Parámetros
    • client_id string · obligatorio
    • name string · obligatorio
    • unit string · obligatorio
    • description string|null
    • direction string · = "up"Valores
      updownneutral
    • aggregation string · = "sum"Valores
      sumaveragelast
    • decimals integer · = 0
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id string · siempre presente
    • name string · siempre presente
    • unit string · siempre presente
    • description null|string · siempre presente
    • direction string · siempre presenteValores
      updownneutral
    • aggregation string · siempre presenteValores
      sumlastaverage
    • decimals number · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • name string · obligatorio
    • unit string · obligatorio
    • description string|null
    • direction string · = "up"Valores
      updownneutral
    • aggregation string · = "sum"Valores
      sumaveragelast
    • decimals integer · = 0
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id string · siempre presente
    • name string · siempre presente
    • unit string · siempre presente
    • description null|string · siempre presente
    • direction string · siempre presenteValores
      updownneutral
    • aggregation string · siempre presenteValores
      sumlastaverage
    • decimals number · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada
  • /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é.
    Parámetros
    • metric_id string · obligatorio
    • period_start string · obligatorio
    • period_end string · obligatorio
    • grain string · = "day"Valores
      dayweekmonthquarteryearcustom
    • value number · obligatorio
    • note string|null
    Devuelve object
    Campos
    • id string · siempre presente
    • metric_id string · siempre presente
    • period_start string · siempre presente
    • period_end string · siempre presente
    • grain string · siempre presenteValores
      customdayweekmonthyearquarter
    • value number · siempre presente
    • note null|string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • metric_id string · obligatorio
    • readings object[] · obligatorio
    Devuelve object
    Campos
    • saved number · siempre presente
    • replaced number · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • client_id string
    • limit integerCombien de lignes rendre au plus (500 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object
    Campos
    • client_id string · siempre presente
    • folders object[] · siempre presente
    • files object[] · siempre presente
    • used_bytes number · siempre presente
    • quota_bytes number · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • offset integer · = 0
    Devuelve object
    Campos
    • id string · siempre presente
    • name string · siempre presente
    • mime_type string · siempre presente
    • size_bytes number · siempre presente
    • pages null|number · siempre presente
    • pages_read null|number · siempre presente
    • offset number · siempre presente
    • text string · siempre presente
    • next_offset null|number · siempre presente
    • note null|string · siempre presente
    Enlace a este punto de entrada
  • /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é.
    Parámetros
    • id string · obligatorio
    • thumb_uploaded boolean
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id null|string · siempre presente
    • name string · siempre presente
    • mime_type string · siempre presente
    • size_bytes number · siempre presente
    • has_thumb boolean · siempre presente
    • folder_id null|string · siempre presente
    • created_by null|string · siempre presente
    • created_side string · siempre presenteValores
      clientagency
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/delete_client_filePOSTdestructiveSuppression définitive, irréversible. Supprime définitivement un fichier partagé, et l'octet avec.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • ids string[] · obligatorio
    Devuelve object
    Campos
    • ids string[] · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • client_id string
    • parent_id string|null
    • name string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • parent_id null|string · siempre presente
    • name string · siempre presente
    • client_id string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • name string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • parent_id null|string · siempre presente
    • name string · siempre presente
    • client_id string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • file_ids string[] · = []
    • folder_ids string[] · = []
    • to_folder_id string|null
    Devuelve object
    Campos
    • file_ids string[] · siempre presente
    • folder_ids string[] · siempre presente
    • to_folder_id null|string · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • client_id string|null
    • status stringValores
      activesupersededabandonedall
    • limit integerCombien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • client_id null|string · siempre presente
    • title string · siempre presente
    • rationale string · siempre presente
    • rejected null|string · siempre presente
    • decided_on string · siempre presente
    • decided_with null|string · siempre presente
    • status string · siempre presenteValores
      activesupersededabandoned
    • superseded_by null|string · siempre presente
    • meeting_id null|string · siempre presente
    • note_id null|string · siempre presente
    • evidence null|string · siempre presente
    • created_by null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    • client_name null|string · siempre presente
    • created_by_name null|string · siempre presente
    Enlace a este punto de entrada
  • /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à.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • decision object · siempre presente
    • supersedes null|object · siempre presente
    • supersededBy null|object · siempre presente
    • meeting_title null|string · siempre presente
    • note_name null|string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • title string · obligatorio
    • rationale string · obligatorio
    • rejected string|null
    • client_id string|null
    • decided_on string
    • decided_with string|null
    • meeting_id string|null
    • note_id string|null
    • evidence string|null
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id null|string · siempre presente
    • title string · siempre presente
    • rationale string · siempre presente
    • rejected null|string · siempre presente
    • decided_on string · siempre presente
    • decided_with null|string · siempre presente
    • status string · siempre presenteValores
      activesupersededabandoned
    • superseded_by null|string · siempre presente
    • meeting_id null|string · siempre presente
    • note_id null|string · siempre presente
    • evidence null|string · siempre presente
    • created_by null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • title string · obligatorio
    • rationale string · obligatorio
    • rejected string|null
    • client_id string|null
    • decided_on string
    • decided_with string|null
    • meeting_id string|null
    • note_id string|null
    • evidence string|null
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id null|string · siempre presente
    • title string · siempre presente
    • rationale string · siempre presente
    • rejected null|string · siempre presente
    • decided_on string · siempre presente
    • decided_with null|string · siempre presente
    • status string · siempre presenteValores
      activesupersededabandoned
    • superseded_by null|string · siempre presente
    • meeting_id null|string · siempre presente
    • note_id null|string · siempre presente
    • evidence null|string · siempre presente
    • created_by null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • title string
    • rationale string
    • rejected string|null
    • client_id string|null
    • decided_on string
    • decided_with string|null
    • meeting_id string|null
    • note_id string|null
    • evidence string|null
    • status stringValores
      activeabandoned
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id null|string · siempre presente
    • title string · siempre presente
    • rationale string · siempre presente
    • rejected null|string · siempre presente
    • decided_on string · siempre presente
    • decided_with null|string · siempre presente
    • status string · siempre presenteValores
      activesupersededabandoned
    • superseded_by null|string · siempre presente
    • meeting_id null|string · siempre presente
    • note_id null|string · siempre presente
    • evidence null|string · siempre presente
    • created_by null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • search stringNe 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.
    • limit integerCombien de lignes rendre au plus (100 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • title null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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é.
    Parámetros
    • id string · obligatorioIdentifiant de la conversation.
    Devuelve object
    Campos
    • id string · siempre presente
    • title null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    • turns object|object|object[] · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorioIdentifiant de la conversation.
    • title string · obligatorioTitre de la conversation, tel qu'il se lit dans la liste.
    Devuelve object
    Campos
    • id string · siempre presente
    • title null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorioIdentifiant de la conversation.
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • archived string« active » (défaut) pour les conversations en cours, « archived » pour celles qui sont rangées, « all » pour les deux.Valores
      activearchivedall
    • limit integerCombien de lignes rendre au plus (100 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • title null|string · siempre presente
    • archived_at null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorioIdentifiant de la conversation.
    Devuelve object
    Campos
    • id string · siempre presente
    • title null|string · siempre presente
    • archived_at null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • title stringTitre du fil, tel qu'il se lit dans la liste.
    Devuelve object
    Campos
    • id string · siempre presente
    • title null|string · siempre presente
    • archived_at null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorioIdentifiant de la conversation.
    • title string · obligatorioTitre du fil, tel qu'il se lit dans la liste.
    Devuelve object
    Campos
    • id string · siempre presente
    • title null|string · siempre presente
    • archived_at null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorioIdentifiant de la conversation.
    • archived boolean · obligatoriotrue range la conversation, false la reprend. Rien ne se perd dans un sens ni dans l'autre.
    Devuelve object
    Campos
    • id string · siempre presente
    • title null|string · siempre presente
    • archived_at null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • conversation_id stringNe rend que les demandes de cette conversation. Sans lui, toutes.
    • limit integerCombien de lignes rendre au plus (100 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • conversation_id string · siempre presente
    • prompt string · siempre presente
    • format string · siempre presenteValores
      imagevideo
    • orientation string · siempre presenteValores
      portraitlandscape
    • model string · siempre presente
    • status string · siempre presenteValores
      failedpendingrunningready
    • input_count number · siempre presente
    • mime_type null|string · siempre presente
    • width null|number · siempre presente
    • height null|number · siempre presente
    • duration_seconds null|number · siempre presente
    • cost_usd null|number · siempre presente
    • error null|string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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é.
    Parámetros
    • id string · obligatorioIdentifiant de la génération.
    Devuelve object
    Campos
    • id string · siempre presente
    • conversation_id string · siempre presente
    • prompt string · siempre presente
    • format string · siempre presenteValores
      imagevideo
    • orientation string · siempre presenteValores
      portraitlandscape
    • model string · siempre presente
    • status string · siempre presenteValores
      failedpendingrunningready
    • input_count number · siempre presente
    • mime_type null|string · siempre presente
    • width null|number · siempre presente
    • height null|number · siempre presente
    • duration_seconds null|number · siempre presente
    • cost_usd null|number · siempre presente
    • error null|string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • conversation_id stringLa conversation où poser la demande. Sans lui, la plus récemment nourrie, ou une nouvelle si l'agence n'en a aucune.
    • prompt string · obligatorioCe qu'on veut voir, en toutes lettres. La consigne part telle quelle au modèle.
    • format string · obligatorio« image » pour un visuel fixe, « video » pour un plan de six secondes avec le son.Valores
      imagevideo
    • orientation string · obligatorio« portrait » (9:16, une story) ou « landscape » (16:9, un post ou une bannière).Valores
      portraitlandscape
    • images string[]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.
    Devuelve object
    Campos
    • id string · siempre presente
    • conversation_id string · siempre presente
    • prompt string · siempre presente
    • format string · siempre presenteValores
      imagevideo
    • orientation string · siempre presenteValores
      portraitlandscape
    • model string · siempre presente
    • status string · siempre presenteValores
      failedpendingrunningready
    • input_count number · siempre presente
    • mime_type null|string · siempre presente
    • width null|number · siempre presente
    • height null|number · siempre presente
    • duration_seconds null|number · siempre presente
    • cost_usd null|number · siempre presente
    • error null|string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorioIdentifiant de la génération.
    Devuelve object
    Campos
    • id string · siempre presente
    • conversation_id string · siempre presente
    • prompt string · siempre presente
    • format string · siempre presenteValores
      imagevideo
    • orientation string · siempre presenteValores
      portraitlandscape
    • model string · siempre presente
    • status string · siempre presenteValores
      failedpendingrunningready
    • input_count number · siempre presente
    • mime_type null|string · siempre presente
    • width null|number · siempre presente
    • height null|number · siempre presente
    • duration_seconds null|number · siempre presente
    • cost_usd null|number · siempre presente
    • error null|string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorioIdentifiant de la génération.
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • client_id string|null
    • limit integerCombien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object
    Campos
    • client_id null|string · siempre presente
    • folders object[] · siempre presente
    • notes object[] · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • note object · siempre presente
    • publication null|object · siempre presente
    • created_by_name null|string · siempre presente
    • media object[] · siempre presente
    • current_user_id string · siempre presente
    • team object[] · siempre presente
    • members object[] · siempre presente
    • folders object[] · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • name string · obligatorio
    • client_id string|null
    • folder_id string|null
    • content string
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id null|string · siempre presente
    • folder_id null|string · siempre presente
    • name string · siempre presente
    • content string · siempre presente
    • created_by null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • name string
    • client_id string|null
    • folder_id string|null
    • content string
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id null|string · siempre presente
    • folder_id null|string · siempre presente
    • name string · siempre presente
    • content string · siempre presente
    • created_by null|string · siempre presente
    • created_at string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • note_id string · siempre presente
    • client_id string · siempre presente
    • name string · siempre presente
    • content string · siempre presente
    • published_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada
  • /api/v1/list_note_commentsGET · POSTreadLecture. Fil d'une note, du plus ancien message au plus récent.
    Parámetros
    • note_id string · obligatorio
    • limit integerCombien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • parent_id null|string · siempre presente
    • anchor_exact null|string · siempre presente
    • anchor_prefix null|string · siempre presente
    • anchor_suffix null|string · siempre presente
    • resolved_at null|string · siempre presente
    • resolved_by null|string · siempre presente
    • resolved_by_name null|string · siempre presente
    • id string · siempre presente
    • author_id null|string · siempre presente
    • author_name string · siempre presente
    • author_avatar_url null|string · siempre presente
    • author_side string · siempre presenteValores
      clientteam
    • body string · siempre presente
    • created_at string · siempre presente
    • edited_at null|string · siempre presente
    • shared_with_client stringValores
      falsetrue
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • note_id string · obligatorio
    • body string · obligatorio
    • parent_id string|null
    • anchor object|null
    Devuelve object
    Campos
    • parent_id null|string · siempre presente
    • anchor_exact null|string · siempre presente
    • anchor_prefix null|string · siempre presente
    • anchor_suffix null|string · siempre presente
    • resolved_at null|string · siempre presente
    • resolved_by null|string · siempre presente
    • resolved_by_name null|string · siempre presente
    • id string · siempre presente
    • author_id null|string · siempre presente
    • author_name string · siempre presente
    • author_avatar_url null|string · siempre presente
    • author_side string · siempre presenteValores
      clientteam
    • body string · siempre presente
    • created_at string · siempre presente
    • edited_at null|string · siempre presente
    • shared_with_client stringValores
      falsetrue
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • comment_id string · obligatorio
    • resolved boolean · obligatorio
    Devuelve object
    Campos
    • parent_id null|string · siempre presente
    • anchor_exact null|string · siempre presente
    • anchor_prefix null|string · siempre presente
    • anchor_suffix null|string · siempre presente
    • resolved_at null|string · siempre presente
    • resolved_by null|string · siempre presente
    • resolved_by_name null|string · siempre presente
    • id string · siempre presente
    • author_id null|string · siempre presente
    • author_name string · siempre presente
    • author_avatar_url null|string · siempre presente
    • author_side string · siempre presenteValores
      clientteam
    • body string · siempre presente
    • created_at string · siempre presente
    • edited_at null|string · siempre presente
    • shared_with_client stringValores
      falsetrue
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • note_id string · obligatorio
    • comment_id string · obligatorio
    • body string · obligatorio
    Devuelve object
    Campos
    • parent_id null|string · siempre presente
    • anchor_exact null|string · siempre presente
    • anchor_prefix null|string · siempre presente
    • anchor_suffix null|string · siempre presente
    • resolved_at null|string · siempre presente
    • resolved_by null|string · siempre presente
    • resolved_by_name null|string · siempre presente
    • id string · siempre presente
    • author_id null|string · siempre presente
    • author_name string · siempre presente
    • author_avatar_url null|string · siempre presente
    • author_side string · siempre presenteValores
      clientteam
    • body string · siempre presente
    • created_at string · siempre presente
    • edited_at null|string · siempre presente
    • shared_with_client stringValores
      falsetrue
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • note_id string · obligatorio
    • comment_id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • parent_id string|null
    • name string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • parent_id null|string · siempre presente
    • name string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    • name string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • parent_id null|string · siempre presente
    • name string · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • note_ids string[] · = []
    • folder_ids string[] · = []
    • to_folder_id string|null
    Devuelve object
    Campos
    • note_ids string[] · siempre presente
    • folder_ids string[] · siempre presente
    • to_folder_id null|string · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • client_id string
    • limit integerCombien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object
    Campos
    • client_id string · siempre presente
    • tickets object[] · siempre presente
    • current_user_id string · siempre presente
    • side string · siempre presenteValores
      clientagency
    Enlace a este punto de entrada
  • /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.
    Parámetros
    • limit integerCombien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object
    Campos
    • tickets object[] · siempre presente
    • current_user_id string · siempre presente
    • side string · siempre presenteValores
      clientagency
    Enlace a este punto de entrada
  • /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.

    Sin parámetros.

    Devuelve number
    Enlace a este punto de entrada
  • /api/v1/list_ticket_messagesGET · POSTreadLecture. Fil d'une conversation, du plus ancien message au plus récent.
    Parámetros
    • ticket_id string · obligatorio
    • limit integerCombien de lignes rendre au plus (300 par défaut et au maximum).
    • offset integerCombien de lignes sauter, pour aller chercher la suite de la liste.
    Devuelve object[]
    Cada fila lleva
    • id string · siempre presente
    • author_id null|string · siempre presente
    • author_name string · siempre presente
    • author_avatar_url null|string · siempre presente
    • author_side string · siempre presenteValores
      clientagency
    • body string · siempre presente
    • attachments object[] · siempre presente
    • created_at string · siempre presente
    Enlace a este punto de entrada
  • /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é).
    Parámetros
    • client_id string
    • subject string · obligatorio
    • body string · = ""
    • file_ids string[]
    Devuelve object
    Campos
    • id string · siempre presente
    • client_id string · siempre presente
    • subject string · siempre presente
    • status string · siempre presenteValores
      openin_progressresolvedclosed
    • created_by null|string · siempre presente
    • created_side string · siempre presenteValores
      clientagency
    • last_message_at string · siempre presente
    • closed_at null|string · siempre presente
    • created_at string · siempre presente
    • message_count number · siempre presente
    • preview null|object · siempre presente
    Enlace a este punto de entrada
  • /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`.
    Parámetros
    • ticket_id string · obligatorio
    • body string · = ""
    • file_ids string[]
    Devuelve object
    Campos
    • message object · siempre presente
    • status string · siempre presenteValores
      openin_progressresolvedclosed
    • closed_at null|string · siempre presente
    Enlace a este punto de entrada
  • /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).
    Parámetros
    • id string · obligatorio
    • status string · obligatorioValores
      openin_progressresolvedclosed
    Devuelve object
    Campos
    • id string · siempre presente
    • status string · siempre presenteValores
      openin_progressresolvedclosed
    • closed_at null|string · siempre presente
    Enlace a este punto de entrada

company

  • /api/v1/get_companyGET · POSTreadLecture. Fiche de la société : identité légale, adresse, coordonnées bancaires.

    Sin parámetros.

    Devuelve null|object
    Enlace a este punto de entrada
  • /api/v1/upsert_companyPOSTwriteÉcriture. Enregistre la fiche de la société. Elle est unique, l'appel la remplace.
    Parámetros
    • name string · obligatorio
    • legal_name string
    • siret string
    • vat_number string
    • country string
    • address string
    • contact_email string
    • phone string
    • bank_name string
    • iban string
    • bic string
    Devuelve object
    Campos
    • name string · siempre presente
    • legal_name null|string · siempre presente
    • siret null|string · siempre presente
    • vat_number null|string · siempre presente
    • country null|string · siempre presente
    • address null|string · siempre presente
    • contact_email null|string · siempre presente
    • phone null|string · siempre presente
    • bank_name null|string · siempre presente
    • iban null|string · siempre presente
    • bic null|string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada

design

  • /api/v1/get_designGET · POSTreadLecture. Réglages de marque appliqués aux devis : couleurs, logo, typographie.

    Sin parámetros.

    Devuelve null|object
    Enlace a este punto de entrada
  • /api/v1/upsert_designPOSTwriteÉcriture. Enregistre les réglages de marque appliqués aux devis.
    Parámetros
    • primary_color string
    • secondary_color string
    • primary_foreground string · = "cream"Valores
      creamink
    • secondary_foreground string · = "cream"Valores
      creamink
    Devuelve object
    Campos
    • logo_url null|string · siempre presente
    • logo_path null|string · siempre presente
    • primary_color null|string · siempre presente
    • secondary_color null|string · siempre presente
    • primary_foreground string · siempre presente
    • secondary_foreground string · siempre presente
    • updated_at string · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • data_url string · obligatorio
    • width integer
    • height integer
    Devuelve object
    Campos
    • id string · siempre presente
    • width null|number · siempre presente
    • height null|number · siempre presente
    Enlace a este punto de entrada

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).
    Parámetros
    • file_id string · obligatorio
    Devuelve object
    Campos
    • id string · siempre presente
    • name string · siempre presente
    • mimeType string · siempre presente
    • sizeBytes number · siempre presente
    Enlace a este punto de entrada

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.
    Parámetros
    • subject string · obligatorioValores
      notetaskmeetingsocial_content
    • id string · obligatorio
    • locale string · obligatorioValores
      frenesde
    Devuelve object|object|object|object|object
    Enlace a este punto de entrada

La API de Noki Mind

La clave, los permisos, los sobres, el tope de llamadas y los códigos de rechazo: todo lo que hay que saber antes de llamar.

Volver a la guía