Cas d'usage
Explorer
Docs
Tarifs

API Web

La référence officielle pour les routes API utilisées par Organigram.ai. Contrairement aux références des packages, ces points de terminaison documentent la couche d'application elle-même, y compris les routes JSON au style RPC, les uploads, les rappels d'authentification, les webhooks et les intégrations côté serveur.

Conventions

  • La plupart des mutations d'application sont envoyées sous forme de POST requêtes avec un corps JSON contenant un action field.
  • Les routes d'upload et de webhook désactivent le parseur de corps par défaut de Next.js lorsqu'elles ont besoin de corps bruts ou multipart/form-data.
  • L'authentification varie selon la route : certains points de terminaison sont publics, tandis que d'autres nécessitent une session NextAuth, un jeton sans portefeuille ou un secret spécifique au fournisseur.

Routes d'action

/api

Point d'entrée RPC-style hérité qui délègue une action payload vers la route d'application concrète.

ChampValeur
MéthodesPOST
AuthDépend de l'action déléguée
CorpsPayload JSON avec un action champ
NotesPréférez le chemin concret une fois que l'endpoint cible est connu.

/api/account

Opérations sur le compte, le profil et la vie privée pour l'utilisateur connecté actuel.

ChampValeur
MéthodesPOST
AuthSession requise
CorpsPayload JSON avec un action champ
NotesAccessible également via /api avec le même action payload.

Actions

ActionAuthDescription
getProfileSession requiseCharge le profil attaché à l'utilisateur actuel.
createProfileSession requiseCrée un profil pour l'utilisateur actuel.
deleteUserSession requiseSupprime le compte utilisateur au nom de l'utilisateur actuel.
updateProfileSession requiseMet à jour les champs du profil pour l'utilisateur actuel.
getProfilePostalAddressesSession requiseLoads the current user postal-address sources.
updatePrivacySettingsSession requisePersiste les paramètres de confidentialité de l'utilisateur actuel.
getUserContactsSession requiseRetourne les contacts liés à l'utilisateur actuel.
getNotificationPreferencesSession requiseLoads the notification preferences attached to the current user.
requestNotificationEmailVerificationSession requiseSends a verification code before persisting the account email address.
updateNotificationPreferencesSession requisePersists notification event email toggles for the current user.
verifyNotificationEmailCodeSession requiseValidates an account email verification code for the current user.
unlinkGoogleWorkspaceIdentitySession requiseDisconnects the current user Google Workspace identity and revokes administrator proofs.

/api/workspace

Lecture et mutations d'espace de travail, y compris les changements de membreship et de propriété.

ChampValeur
MéthodesPOST
AuthMélangé
CorpsPayload JSON avec un action champ
NotesAccessible également via /api avec le même action payload.

Actions

ActionAuthDescription
getWorkspaceAccès public ou session-awareCharge un espace de travail par son identifiant lorsque l'appelant est autorisé à le voir.
getWorkspaceBySlugAccès public ou session-awareCharge un espace de travail par son slug lorsque l'appelant est autorisé à le voir.
createWorkspaceSession requiseCrée un nouveau espace de travail personnel ou organisationnel pour l'utilisateur actuel.
updateWorkspaceSession requiseMet à jour les détails de l'espace de travail.
deleteWorkspaceSession requiseSupprime un espace de travail.
removeUserFromWorkspaceSession requiseRetire un membre d'un espace de travail.
editUserRoleInWorkspaceSession requiseModifie le rôle d'un membre au sein d'un espace de travail.
getWorkspaceUserEntriesSession requiseLists workspace member entry identities with encrypted profile content references only.
getWorkspaceFilesSession requiseLists workspace file metadata without exposing file contents.
inviteWorkspaceMemberAdministrator session requiredEmails a single-use link inviting someone to join some organs of the workspace.
listWorkspaceInvitationsAdministrator session requiredLists pending workspace invitations and accepted ones.
revokeWorkspaceInvitationAdministrator session requiredDeletes a workspace invitation.
acceptWorkspaceInvitationSession requiseJoins the draft organs of a workspace invitation; deployed organs wait for a proposal.
enableGoogleWorkspaceAccessForWorkspaceSession requiseAllows users from a verified Google Workspace tenant to access a workspace.
disableGoogleWorkspaceAccessForWorkspaceSession requiseRevokes Google Workspace tenant access for a workspace without removing the verified administrator proof.

/api/organigram

Mutations d'organigramme, d'organe, de procédure, d'entrée et d'actif pour les utilisateurs authentifiés.

ChampValeur
MéthodesPOST
AuthSession requise
CorpsPayload JSON avec un action champ
NotesAccessible également via /api avec le même action payload.

Actions

ActionAuthDescription
createOrganigramFromTemplateSession requiseCrée un organigramme à partir de données et d'options de modèle.
getOrganigramSession requiseRécupère un organigramme par son identifiant.
updateOrganigramSession requiseEnregistre les modifications de l'organigramme.
mergeOrganigramJsonSession requiseFusionne le JSON importé de l'organigramme dans un organigramme existant.
deleteOrganigramSession requiseSupprime un organigramme.
retainGovernanceRecordsSession requiseArchives the meetings and register records of an organigram so it can be deleted.
saveDeployedOrganigramSession requiseStocke les résultats de déploiement pour un organigramme.
createOrganSession requiseCrée un organe.
updateOrganSession requiseMise à jour d'un organe.
deleteOrganSession requiseSuppression d'un organe.
createProcedureSession requiseCréation d'une procédure et de ses autorisations ciblées.
updateProcedureSession requiseMise à jour d'une procédure et de ses autorisations ciblées.
deleteProcedureSession requiseSuppression d'une procédure.
getEntryReferenceSession requiseResolves an entry reference for the authenticated user without profile contents.
getPrivateReferenceSession requiseResolves an entry reference for the authenticated user without profile contents.
deleteEntrySession requiseSupprime une entrée.
createAssetSession requiseCrée un actif.
updateAssetSession requiseMet à jour un actif.
getAssetSession requiseRécupère un actif par adresse.
addAssetToOrganigramSession requiseLie un actif à un organigramme.
deleteAssetSession requiseRetire un actif d'un organigramme.
createOrganigramLayerSession requiseCreates an empty shared organigram layer.
updateOrganigramLayerSession requiseUpdates a shared organigram layer.
reorderOrganigramLayersSession requiseReorders shared organigram layers.
deleteOrganigramLayerSession requiseDeletes a shared organigram layer.

/api/organization

Recherches d'organisation plus mutations d'organisation authentifiées.

ChampValeur
MéthodesPOST
AuthMélangé
CorpsPayload JSON avec un action champ
NotesAccessible également via /api avec le même action payload.

Actions

ActionAuthDescription
getPublicOrganizationsPublicAffiche les organisations publiques.
lookupCompanyPublicLooks up a company in the national register of its country, from its registration number.
listCompanyTrademarksPublicLists the trademarks registered by a company, when the register of its country provides them.
getCompanyStatutesAvailabilitySession requiseChecks whether public articles of association can be downloaded from the register of the company country.
downloadCompanyStatutesSession requiseDownloads the latest public articles of association of a company from the register of its country.
createOrganizationSession requiseCrée une organisation pour l'utilisateur actuel.
verifyOrganizationTaxIdAdministrator session requiredConfirms the registration number of the organization by matching the verified identity of the requesting administrator against the officers listed in the company register of its country.
listOrganizationMandatesAdministrator session requiredLists the active mandates by which RNE officers let administrators act on behalf of the company.
revokeOrganizationMandateVerified RNE officer session requiredRevokes a mandate and removes its holder from the administrators.
inviteOrganizationOfficerAdministrator session requiredEmails a single-use link inviting an officer to join an organization whose SIREN is not verified yet.
getOrganizationArchiveManifestAdministrator session requiredReturns everything Organigram reads in clear about the organization, for an export before deletion.
inviteOrganizationDelegateVerified RNE officer session requiredEmails a single-use link to someone who will administer the company under an officer mandate.
listPendingDelegatesAdministrator session requiredLists invited delegates waiting for an officer to sign their mandate.
appointOrganizationDelegateVerified RNE officer session requiredMakes an invited delegate administrator with a mandate the officer signed with their wallet.
acceptOrganizationInvitationSession requiseJoins an unverified organization as administrator with an invitation link.
attachStatutesToReferenceOrganOrganization-member session requiredLinks an uploaded articles of association file to the reference bylaws organ.
updateOrganizationSession requiseMet à jour les métadonnées de l'organisation.
updateOrganizationComplianceProfileSession requiseUpdates organization legal, tax, and default governance settings.
getOrganizationRegisterSituationAdministrator session requiredReturns whether the organization currently employs staff and processes personal data, as tracked by its conditional registers.
updateOrganizationRegisterSituationAdministrator session requiredUpdates whether the organization employs staff and processes personal data, refreshing the applicability of its conditional registers accordingly.
setOrganizationOfficialOrganigramSession requiseSets or clears the reference organigram used by organization pages.
getCertifiedComplianceStatusSession requiseCalculates the current Certified compliance status and its private proof reports.
saveCertifiedComplianceConfigurationSession requiseStores the validated component addresses for the organization compliance profile.
activateReferenceRegistersAdministrator session requiredAdds the missing reference-register layer without deploying it.
getCertifiedComplianceReportForExportAdministrator session requiredReturns one private Certified report for administrator export.
validateCertifiedSensitiveProposalSession requiseVerifies a proposed mutation of a Certified key organ before wallet signature.
getOrganizationByIdSession requiseRécupère une organisation par son identifiant.
getUserOrganizationsSession requiseListe les organisations liées à l'utilisateur actuel.

/api/subscription

Mises à jour des abonnements et recherches de factures pour l'utilisateur actuel ou le sponsor.

ChampValeur
MéthodesPOST
AuthSession requise
CorpsPayload JSON avec un action champ
NotesAccessible également via /api avec le même action payload.

Actions

ActionAuthDescription
authorizeOrganizationOperationSession requiseChecks whether the current user can run an operation that requires an active Certified Entity.
authorizeCertifiedProcedureUseSession requiseChecks whether the current user can use a Certified procedure.
quoteSponsoredTransactionSession requiseQuotes the euro price of a sponsored transaction from a gas estimate.
getEntityActivationSession requiseSyncs a confirmed Stripe intent for an organization, then returns its Certified Entity access state.
reconcilePersonalBillingSession requiseSyncs the current user’s personal storage and transaction subscriptions from a confirmed Stripe intent.
startCryptoEntitySubscriptionSession requiseCreates a Certified Entity Stripe invoice to be paid in EURC.
getCryptoInvoicePaymentSession requiseReturns the authenticated billing manager’s EURC payment request for a Stripe invoice.
declareCryptoInvoicePayerSession requiseDeclares, with its signature, the wallet that will send the EURC transfer for a Stripe invoice.
submitCryptoInvoiceTransactionSession requiseSubmits and verifies an Ethereum EURC transaction for an open Stripe invoice.
reconcileCryptoInvoicePaymentSession requiseRechecks the submitted EURC transaction of a Stripe invoice and records its payment once confirmed.
getBillingAddressSession requiseReturns the billing address of the current user or of an organization they manage.
updateBillingAddressSession requiseSaves the billing address of the current user or of an organization they manage.
getCryptoCreditSession requiseReturns the prepaid credit an organization billed in EURC holds for its next invoices.
startCryptoCreditTopUpSession requiseCreates the EURC payment request that brings an organization prepaid credit up to a target of at least 5 €.
renewCryptoInvoicePaymentSession requiseExtends an expired EURC payment request for the same open Stripe invoice.
updateSubscriptionSession requiseMise à jour des paramètres d'abonnement.
getIncomingInvoiceSession requiseRetourne la prochaine facture Stripe pour l'identifiant client fourni.
getPastInvoicesSession requiseListe les factures passées pour le client Stripe de l'utilisateur actuel.
getSponsoredTransactionsSession requiseLists the latest transactions sponsored by an organization, for its billing managers.
createBillingPortalSessionSession requiseReturns a Stripe customer portal URL for an organization billing manager.
deleteSubscriptionSession requiseAnnule ou supprime un abonnement sponsor pour l'utilisateur actuel.

/api/notification

Notification reads, sync, and read-state mutations.

ChampValeur
MéthodesPOST
AuthSession requise
CorpsPayload JSON avec un action champ
NotesAccessible également via /api avec le même action payload.

Actions

ActionAuthDescription
listNotificationsSession requiseLists the current user notifications and unread count.
markNotificationReadSession requiseMarks one notification as read.
markAllNotificationsReadSession requiseMarks all notifications as read.
syncWorkspaceNotificationsSession requiseSynchronizes proposal and asset notifications for one workspace.

/api/governance

Authenticated governance-case, register, document, and workflow operations for organization workspaces.

ChampValeur
MéthodesPOST
AuthSession requise
CorpsPayload JSON avec un action field and, except for getGovernanceBundle, a data object

Actions

ActionAuthDescription
getGovernanceBundleSession requiseLoads governance cases, register applicability, compliance tasks, and organization settings for an organigram.
createGovernanceCaseSession requiseCreates a governance case with an idempotency key.
createRecurringAssemblySession requiseCreates a schedule that automatically creates governance-case drafts at each due date.
deleteGovernanceCaseSession requisePermanently deletes a governance case before its first convocation, provided it has no linked on-chain proposal.
deleteRecurringAssemblySession requiseDeletes a recurring assembly schedule without deleting its existing drafts.
updateRecurringAssemblySession requiseUpdates a recurring assembly schedule without changing its existing drafts.
updateGovernanceCaseSession requiseUpdates an editable governance case and its agenda details.
confirmGovernanceRulesSession requiseConfirms and freezes the governance rules that apply to a case.
transitionGovernanceCaseSession requiseMoves a governance case through its lifecycle and triggers applicable workflow work.
sendGovernanceConvocationErratumSession requiseSends a corrected convocation to the case participants.
upsertGovernanceParticipantSession requiseCreates or updates a governance-case participant and voting rights.
synchronizeGovernanceParticipantsFromRightsSession requiseSynchronizes governance-case participants from the organigram rights.
upsertGovernanceDocumentSession requiseCreates or updates a document attached to a governance case.
upsertGovernanceResolutionSession requiseCreates or updates an agenda resolution for a governance case.
deleteGovernanceResolutionSession requiseDeletes an agenda resolution from a governance case.
prepareGovernanceMinutesSession requisePrepares the governance-case minutes document.
signGovernanceMinutesSession requiseVerifies and records the signature of the governance-case minutes.
recordGovernanceProposalCreatedSession requiseLinks an on-chain proposal to a governance-case resolution.
recordGovernanceProposalWorkflowEventSession requiseRecords an on-chain proposal workflow event for a governance case.
recordGovernanceWorkflowProposalOutputSession requiseRecords the on-chain proposal produced by a governance workflow.
upsertRegisterApplicabilitySession requiseConfirms or updates whether a governance register applies to an organigram.
createRegisterRecordSession requiseAdds a record to an applicable governance register.
runGovernanceAutomationSession requiseRuns the governance automations currently due for the signed-in user.

/api/recurringProposal

Authenticated recurring-proposal schedule and worker-prepared draft operations for organization workspaces.

ChampValeur
MéthodesPOST
AuthSession requise
CorpsPayload JSON avec un action field and a data object
NotesAccessible également via /api avec le même action payload.

Actions

ActionAuthDescription
getRecurringProposalBundleSession requiseLists the caller’s recurring-proposal schedules and prepared drafts for the requested category.
createRecurringProposalSession requiseCreates a reusable proposal template for a deployed procedure without creating an on-chain proposal.
disableRecurringProposalSession requiseDisables a recurring proposal and cancels its unsubmitted prepared drafts.
deleteRecurringProposalSession requiseDeletes a recurring proposal and its prepared drafts.
runRecurringProposalAutomationSession requisePrepares drafts for recurring proposals currently due and notifies their creator; it never signs or creates an on-chain proposal.
markPreparedRecurringProposalSubmittedSession requiseLinks a prepared recurring-proposal draft to the on-chain proposal created by its owner.

/api/equityTransfer

Collects the seller and buyer wallet signatures for an equity transfer before its governance proposal is created.

ChampValeur
MéthodesPOST
AuthSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitations
CorpsJSON body with an action and action-specific data
NotesAccessible également via /api avec le même action payload.

Actions

ActionAuthDescription
createSignatureRequestSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitationsCreates a seller-signed request for a buyer wallet signature.
getSignatureRequestSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitationsReturns the request to its seller or buyer.
signSignatureRequestSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitationsRecords the buyer wallet signature.
listSellerSignatureRequestsSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitationsLists open requests that a seller can turn into proposals.
renderSignatureRequestPdfSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitationsGenerates the transfer agreement PDF for a participant.
markSignatureRequestSubmittedSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitationsAnchors both wallet signatures to the on-chain proposal transaction.
listRegisterSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitationsLists settled equity movements after verifying their ProposalApplied event.
exportRegisterSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitationsGenerates a private CSV or PDF extract of the register.
listEligibleBuyersSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitationsLists KYC-verified users who explicitly share their information with the workspace or its organization.
getInvitationSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitationsNames the organization a transferee invitation link points to (invited wallet only).
createInvitationSession wallet must be either the seller or buyer named in the request, or a workspace member for buyer lookups and invitationsInvites a wallet to have its identity verified at the organization's expense.

Téléchargements et actifs générés

/api/ipfs/[...workspaceId]

Télécharge un fichier de workspace vers IPFS et suit l'utilisation de stockage facturable.

ChampValeur
MéthodesPOST
AuthSession avec accès au workspace requis
Corpsmultipart/form-data
NotesLe parseur de corps Next.js par défaut est désactivé pour ce route.

Opérations

OpérationDéclencheurAuthDescription
uploadSession avec accès au workspace requisTélécharge le premier fichier du payload multipart et retourne son nom de fichier et son CID.

/api/certifiedProof/[...workspaceId]

Génère, signe, stocke et facture un PDF certifié de preuve pour une transaction de workspace.

ChampValeur
MéthodesPOST
AuthSession avec accès au workspace requis
CorpsCorps JSON contenant les données de preuve de transaction

Opérations

OpérationDéclencheurAuthDescription
create certified proofSession avec accès au workspace requisCrée une preuve certifiée, télécharge le PDF signé et enregistre l'utilisation associée.

/api/agent/[...workspaceId]

Answers questions about a workspace and can return additive organigram previews.

ChampValeur
MéthodesGET, POST
AuthSession avec accès au workspace requis
Corpsmessage ou messages with optional threadId, sourceet, currentOrganigramId

Opérations

OpérationDéclencheurAuthDescription
ask workspace agentSession avec accès au workspace requisBuilds a safe workspace snapshot, persists the exchange in a workspace thread, and asks the configured inference service for a structured answer.
list workspace agent threadsSession avec accès au workspace requisLists persisted workspace agent conversations for the signed-in user across workspaces.
record workspace agent threadSession avec accès au workspace requisStores a workspace agent conversation created by another surface, such as the home hero.

Authentification, facturation et intégrations

/api/auth/[...nextauth]

Point de terminaison NextAuth utilisé pour le sign-in SIWE, la résolution de la session et les rappels d'authentification.

ChampValeur
MéthodesGET, POST
AuthGéré par NextAuth
CorpsParamètres de requête ou données de formulaire spécifiques au fournisseur
NotesAppuyé par le fournisseur de credentiel SIWE dans lib/auth/server.ts.

/api/gasStation

Relaie une transaction via la station de carburant après vérification de l'accès au signataire et au workspace.

ChampValeur
MéthodesPOST
AuthSession requise
CorpsCorps JSON avec txRequest, chainIdet, workspaceId

Modifier cette page

Sur cette page:

Conventions
/apiPoint d'entrée RPC-style hérité qui délègue une action payload vers la route d'application concrète.

Suivez-nous :

© 2026 Organigram SAS

Tous droits réservés.