canonical: https://jentic.com/apis/helloasso.com/helloasso

# HelloAsso API

Jentic publishes the only available OpenAPI specification for HelloAsso API, keeping it validated and agent-ready. HelloAsso is a French payments and crowdfunding platform for non-profit associations. The v5 API exposes checkout intents, organisations and forms, item and order lookups, and a directory search across organisations and forms - the building blocks for embedded donation and event-registration flows. Authentication uses OAuth 2.0 client credentials.

## For AI agents

Initiate checkout intents, list organisations and forms, and look up items and orders on HelloAsso across 35 endpoints.

## Scope

Does not handle accounting, payroll, tax filing, or French association legal registration - use for HelloAsso checkout intents, forms, organisations, and orders only.

## Capabilities

- Initialise a checkout intent for a donation or registration via POST `/organizations/{organizationSlug}/checkout-intents`
- Retrieve a checkout intent and its order once the payment is authorised via GET `/organizations/{organizationSlug}/checkout-intents/{checkoutIntentId}`
- Search the directory of organisations and forms via POST `/directory/organizations` and POST `/directory/forms`
- List the forms, items, and orders belonging to an organisation through the `/organizations/{organizationSlug}`/* endpoints
- Quick-create a simplified event form via POST `/organizations/{organizationSlug}/forms/{formType}/action/quick-create`
- Get detailed public data for a single form via GET `/organizations/{organizationSlug}/forms/{formType}/{formSlug}/public`
- Retrieve a single order or item by id via GET `/orders/{orderId}` or GET `/items/{itemId}`

## Use cases

### Embedded Donation Checkout

A French non-profit's website embeds donation flows by initialising a HelloAsso checkout intent and redirecting the donor to the returned payment URL. After payment, the website calls GET `/organizations/{organizationSlug}/checkout-intents/{checkoutIntentId}` to confirm the order and write a receipt record. HelloAsso handles card processing, SEPA, and tax-receipt rules.

Example prompt: Call POST `/organizations/myassociation/checkout-intents` with amount and itemBody, then poll GET `/organizations/myassociation/checkout-intents/{id}` until the order is authorised

### Event Registration Site

An association launches a paid event by quick-creating a form via `/organizations/{organizationSlug}/forms/{formType}/action/quick-create` and exposing it on its site. Registration orders are pulled with `/organizations/{organizationSlug}/forms/{formType}/{formSlug}/orders` for back-office reporting.

Example prompt: Quick-create an event form via the action/quick-create endpoint, then list its registrations via GET `/organizations/{slug}/forms/Event/{formSlug}/orders`

### Directory Discovery for Aggregators

An aggregator site lists French associations and their fundraising campaigns. POST `/directory/organizations` and POST `/directory/forms` apply structured filters such as category and location, returning paginated results suitable for index pages and search experiences.

Example prompt: Call POST `/directory/forms` with a category filter and paginate through the response to populate an index page

### AI Agent Donation Assistant

An AI assistant on a French association's site helps donors find the right campaign and complete a donation. Through Jentic, the agent searches for the checkout-intent operation, loads its body schema, and submits the donation amount and donor info on the user's behalf.

Example prompt: Search Jentic for 'create a helloasso checkout intent', load the operation, and execute it with the donor amount and selected form

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/organizations/{organizationSlug}/checkout-intents` | Initialise a checkout intent |
| GET | `/organizations/{organizationSlug}/checkout-intents/{checkoutIntentId}` | Retrieve a checkout intent and its order |
| POST | `/directory/organizations` | Search organisations in the directory |
| POST | `/directory/forms` | Search forms in the directory |
| POST | `/organizations/{organizationSlug}/forms/{formType}/action/quick-create` | Quick-create a simplified event form |
| GET | `/organizations/{organizationSlug}/forms/{formType}/{formSlug}/public` | Get public data for a form |
| GET | `/orders/{orderId}` | Retrieve a single order |
| GET | `/items/{itemId}` | Retrieve a single item |

## Key resources

- **Checkout Intents** — Initialise and retrieve payment checkout intents and their authorised orders
- **Organisations and Forms** — List organisations, manage and inspect their forms across form types
- **Directory** — Search across organisations and forms with structured filters
- **Items and Orders** — Retrieve item and order records by id or organisation context

## Why Jentic

- **Setup:** Wiring HelloAsso by hand means running the OAuth 2.0 client-credentials exchange, refreshing tokens, and attaching a bearer token on every call. Through Jentic you install once, import the HelloAsso API from the API Directory, store the client credentials once, and your agent calls it.
- **Permission scoping:** HelloAsso puts the organisation slug in the URL path (`/organizations/{organizationSlug}/...`), so a rule can pin your agent to one organisation: it can read that organisation's forms and orders and nothing else. You choose the operations it may call, so ones that create a checkout intent or quick-create a form are not included unless you add them.
- **Credential handling:** Your HelloAsso client id and secret are stored once, encrypted, by your own Jentic One instance and minted into tokens at execution time. They never enter the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a donation checkout' or 'list an organisation's forms', and Jentic returns the matching HelloAsso operation with its input schema and required organizationSlug parameter so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe API** — Stripe is a global payments platform - broader than HelloAsso's France-focused non-profit niche
- **PayPal Payments API** — PayPal supports donation buttons and global checkout - alternative to HelloAsso for non-profits without French specifics
- **Donorbox API** — Donorbox is a non-profit donation platform comparable to HelloAsso outside France
- **Ticketmaster Discovery API** — Ticketmaster handles large-scale ticketed events while HelloAsso handles association event registrations

## FAQ

### Why is there no official OpenAPI spec for HelloAsso API?

HelloAsso publishes a Swagger UI on api.helloasso.com/v5/swagger but the underlying OpenAPI is not directly redistributed. Jentic generates and maintains this spec so AI agents and developers can call HelloAsso via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the HelloAsso API use?

HelloAsso uses OAuth 2.0 with client credentials issued from your association's HelloAsso account. Through Jentic, the client_id and client_secret live in the encrypted vault and the access token is minted at execution time.

### Can I take a donation through the HelloAsso API?

Yes. Initialise a checkout intent via POST `/organizations/{organizationSlug}/checkout-intents`, redirect the donor to the returned payment URL, and confirm the order via GET `/organizations/{organizationSlug}/checkout-intents/{checkoutIntentId}.`

### What are the rate limits for the HelloAsso API?

The OpenAPI spec does not publish hard rate limits; HelloAsso applies fair-use limits per OAuth client. For directory crawls, paginate `/directory/organizations` and `/directory/forms` instead of polling them in tight loops.

### How do I create a checkout intent through Jentic?

Run pip install jentic, have the agent search for 'create a helloasso checkout intent', load POST `/organizations/{organizationSlug}/checkout-intents`, and execute it with totalAmount, itemBody, and the payer details.

### Does HelloAsso support event registration as well as donations?

Yes. HelloAsso models events as forms with formType=Event. Quick-create a registration form via the action/quick-create endpoint, then list registrations via GET `/organizations/{slug}/forms/Event/{formSlug}/orders.`

### Can I limit what my agent is allowed to do with the HelloAsso API?

Yes. Because you run Jentic One yourself, your own rules decide which HelloAsso operations and credentials the agent may use. Since HelloAsso puts the organisation slug in the URL path (`/organizations/{organizationSlug}/...`), you can pin the agent to a single organisation so it reads only that organisation's forms and orders. You also choose the exact operations it can call, so write actions like initialising a checkout intent (POST `/organizations/{organizationSlug}/checkout-intents`) or quick-creating a form are excluded unless you add them.