Skip to content

ioumi API: create an API token and set permissions

The ioumi API lets other programs talk to ioumi directly. Your CRM, your funnel or an automation tool such as Make, Zapier or n8n can use it to read and create data in ioumi, without anyone having to click by hand. This keeps your data in sync between ioumi and your other tools automatically.

APIWebhook
DirectionYour system asks ioumi or sends data to ioumiioumi contacts your system
WhenWhen your system needs something or wants to create somethingImmediately, when something happens in ioumi
ExampleCreate a customer from your CRM in ioumiContract signed, start onboarding in your project tool

You often use both together. The Webhooks article explains how webhooks work.

The API gives you access to the core areas of ioumi: contacts, deals, sales and payments. You can retrieve data, create new data and update it. You can see exactly which functions are available in the API documentation. We keep expanding the API.

Everything you create through the API follows the same rules as in ioumi itself, for example for VAT or payment plans. Whatever the app does not allow, the API rejects as well.

  • Automatically create new leads from your CRM or funnel as contacts in ioumi
  • Automatically unlock access to your course or community after the contract is signed, together with a webhook
  • Pull sales and payments into your own reporting
  • Report invoices from your own invoicing software back to ioumi, see External billing mode

Every request to the API needs an API token. It proves that the request comes from you and defines what it is allowed to do.

  1. Open Settings › Integrations.
  2. Under API Tokens, click Generate API Token.
  3. Give the token a Name that later tells you what it is for, for example “Make lead import”.
  4. Under Permissions, select only what this connection really needs.
  5. Click Generate and copy the token right away.

For each token, you define what it is allowed to do, separately by area and by whether it may only read data or also create and change it. You enable particularly far-reaching actions, such as sending contracts or refunds, individually.

You can create as many tokens as you like with different permissions. It is better to create several tokens with few permissions than one with all of them, for example a separate token for the lead import that can only create contacts. If a token is no longer needed, you delete exactly that one without disrupting your other connections.

You find the complete technical reference with all endpoints, fields and examples in ioumi under Settings › Integrations › API Documentation. It is meant for developers who build the connection.