### Get Organization Details Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Retrieves public information about an organization using its slug. Requires an Authorization header with a valid token. ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" ``` -------------------------------- ### Get Payments for an Organization Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Lists payments for an organization, supporting filtering by state and date range. Can export data as JSON or CSV. Ensure the Authorization header is correctly set with your token. ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." # Get last 30 days of authorized payments as JSON curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo/payments?states=Authorized&from=2024-02-01T00:00:00Z&to=2024-03-01T00:00:00Z&pageSize=50&sortOrder=Desc" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" ``` ```bash # Export as CSV curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo/payments?states=Authorized" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: text/csv" \ -o payments_export.csv ``` -------------------------------- ### Get a Single Order Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Fetches detailed information for a specific order using its ID. The `withFormData` parameter can be used to include form-specific data. Requires a valid API token. ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." ORDER_ID=445566 curl -X GET "https://api.helloasso.com/v5/orders/${ORDER_ID}?withFormData=true" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" ``` -------------------------------- ### Orders — Get Orders for a Form Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Returns a paginated list of orders placed on a specific form, with optional date filtering and sorting. ```APIDOC ## Orders — Get Orders for a Form ### Description Returns a paginated list of orders placed on a specific form, with optional date filtering and sorting. ### Method GET ### Endpoint https://api.helloasso.com/v5/organizations/{organization_slug}/forms/{form_type}/{form_slug}/orders ### Parameters #### Query Parameters - **pageIndex** (integer) - Optional - The index of the page to retrieve (default: 1). - **pageSize** (integer) - Optional - The number of items per page (default: 20). - **sortOrder** (string) - Optional - The order to sort the results ('Asc' or 'Desc'). ### Request Example ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo/forms/Event/charity-run-2024/orders?pageIndex=1&pageSize=20&sortOrder=Desc" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" ``` ### Response #### Success Response (200) - **data** (array) - A list of orders. - **id** (integer) - The unique identifier for the order. - **date** (string) - The date and time the order was placed. - **formSlug** (string) - The slug of the form associated with the order. - **formType** (string) - The type of the form. - **organizationSlug** (string) - The slug of the organization. - **payer** (object) - Information about the order payer. - **firstName** (string) - **lastName** (string) - **email** (string) - **amount** (object) - The total amount of the order. - **total** (integer) - Total amount in cents. - **vat** (integer) - VAT amount in cents. - **discount** (integer) - Discount amount in cents. - **pagination** (object) - Pagination details. - **pageSize** (integer) - **totalCount** (integer) - **pageIndex** (integer) - **totalPages** (integer) ### Response Example ```json { "data": [ { "id": 445566, "date": "2024-09-10T14:32:00Z", "formSlug": "charity-run-2024", "formType": "Event", "organizationSlug": "my-ngo", "payer": { "firstName": "Jean", "lastName": "Martin", "email": "jean.martin@example.com" }, "amount": { "total": 4500, "vat": 0, "discount": 0 } } ], "pagination": { "pageSize": 20, "totalCount": 87, "pageIndex": 1, "totalPages": 5 } } ``` ``` -------------------------------- ### Get Orders for a Form Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Retrieves a paginated list of orders associated with a specific form. Supports filtering by date and sorting. Ensure your API token is valid. ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo/forms/Event/charity-run-2024/orders?pageIndex=1&pageSize=20&sortOrder=Desc" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" ``` -------------------------------- ### Organizations — Get Organization Details Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Retrieves public information about an organization using its unique slug. ```APIDOC ## Organizations — Get Organization Details Retrieves public information about an organization by its slug. ### Method GET ### Endpoint /organizations/{organization_slug} ### Path Parameters - **organization_slug** (string) - Required - The unique slug of the organization. ### Request Example ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" ``` ### Response #### Success Response (200) - **name** (string) - The name of the organization. - **organizationSlug** (string) - The unique slug of the organization. - **description** (string) - A description of the organization. - **city** (string) - The city where the organization is located. - **zipCode** (string) - The zip code of the organization's location. - **type** (string) - The type of organization (e.g., "Association1901"). - **fiscalReceiptEligibility** (boolean) - Indicates if the organization is eligible for fiscal receipts. - **fiscalReceiptIssuanceEnabled** (boolean) - Indicates if the issuance of fiscal receipts is enabled for the organization. - **url** (string) - The URL of the organization's page on HelloAsso. - **logo** (string) - The URL of the organization's logo. ### Response Example ```json { "name": "My NGO", "organizationSlug": "my-ngo", "description": "A non-profit dedicated to community support", "city": "Paris", "zipCode": "75001", "type": "Association1901", "fiscalReceiptEligibility": true, "fiscalReceiptIssuanceEnabled": true, "url": "https://www.helloasso.com/associations/my-ngo", "logo": "https://cdn.helloasso.com/images/my-ngo-logo.jpg" } ``` ``` -------------------------------- ### Orders — Get a Single Order Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Retrieves full details of one order by ID, including all items, payments, and optional form data. ```APIDOC ## Orders — Get a Single Order ### Description Retrieves full details of one order by ID, including all items, payments, and optional form data. ### Method GET ### Endpoint https://api.helloasso.com/v5/orders/{order_id} ### Parameters #### Query Parameters - **withFormData** (boolean) - Optional - Whether to include form data in the response. ### Request Example ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." ORDER_ID=445566 curl -X GET "https://api.helloasso.com/v5/orders/${ORDER_ID}?withFormData=true" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" ``` ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the order. - **date** (string) - The date and time the order was placed. - **payer** (object) - Information about the order payer. - **firstName** (string) - **lastName** (string) - **email** (string) - **country** (string) - **items** (array) - A list of items in the order. - **id** (integer) - **type** (string) - **amount** (integer) - Amount in cents. - **state** (string) - **name** (string) - **payments** (array) - A list of payments for the order. - **id** (integer) - **amount** (integer) - Amount in cents. - **state** (string) - **date** (string) - **paymentMeans** (string) - **amount** (object) - The total amount of the order. - **total** (integer) - Total amount in cents. - **vat** (integer) - VAT amount in cents. - **discount** (integer) - Discount amount in cents. ### Response Example ```json { "id": 445566, "date": "2024-09-10T14:32:00Z", "payer": { "firstName": "Jean", "lastName": "Martin", "email": "jean.martin@example.com", "country": "FRA" }, "items": [ { "id": 778899, "type": "Registration", "amount": 2000, "state": "Processed", "name": "Adult" }, { "id": 778900, "type": "Registration", "amount": 500, "state": "Processed", "name": "Child (under 12)" } ], "payments": [ { "id": 334455, "amount": 2500, "state": "Authorized", "date": "2024-09-10T14:32:10Z", "paymentMeans": "Card" } ], "amount": { "total": 2500, "vat": 0, "discount": 0 } } ``` ``` -------------------------------- ### Forms — Get Public Form Details Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Retrieves full public details for a specific form including tiers, pricing, place, and sale dates. ```APIDOC ## Forms — Get Public Form Details ### Description Retrieves full public details for a specific form including tiers, pricing, place, and sale dates. ### Method GET ### Endpoint https://api.helloasso.com/v5/organizations/{organization_slug}/forms/{form_type}/{form_slug}/public ### Request Example ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo/forms/Event/summer-festival-2024/public" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" ``` ### Response #### Success Response (200) - **title** (string) - The title of the form. - **formType** (string) - The type of the form (e.g., 'Event'). - **state** (string) - The current state of the form (e.g., 'Public'). - **place** (object) - Details about the location of the form. - **name** (string) - **city** (string) - **zipCode** (string) - **country** (string) - **tiers** (array) - A list of pricing tiers for the form. - **id** (integer) - **label** (string) - **price** (integer) - Price in cents. - **tierType** (string) - **maxPerUser** (integer) - **saleStartDate** (string) - The date when sales start. - **saleEndDate** (string) - The date when sales end. ### Response Example ```json { "title": "Summer Festival 2024", "formType": "Event", "state": "Public", "place": { "name": "Parc de la Villette", "city": "Paris", "zipCode": "75019", "country": "FRA" }, "tiers": [ { "id": 1, "label": "Standard", "price": 1500, "tierType": "Registration", "maxPerUser": 4 }, { "id": 2, "label": "VIP", "price": 5000, "tierType": "Registration", "maxPerUser": 1 } ], "saleStartDate": "2024-05-01T00:00:00Z", "saleEndDate": "2024-06-30T23:59:59Z" } ``` ``` -------------------------------- ### Orders — Cancel an Order Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Cancels all future scheduled payments for an installment order. Does not issue a refund — use the payment refund endpoint for that. ```APIDOC ## Orders — Cancel an Order ### Description Cancels all future scheduled payments for an installment order. Does not issue a refund — use the payment refund endpoint for that. ### Method POST ### Endpoint https://api.helloasso.com/v5/orders/{order_id}/cancel ### Request Example ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." ORDER_ID=445566 curl -X POST "https://api.helloasso.com/v5/orders/${ORDER_ID}/cancel" \ -H "Authorization: Bearer $TOKEN" ``` ### Response #### Success Response (200) Empty body on success. ``` -------------------------------- ### Payments — Get Payments for an Organization Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Lists all payments received by an organization. Supports filtering by state, date range, and exporting in JSON, CSV, or XLSX formats. ```APIDOC ## Payments — Get Payments for an Organization Lists all payments received by an organization, with filtering by state, date range, and export support (JSON, CSV, XLSX). ### Method GET ### Endpoint /organizations/{organization_slug}/payments ### Query Parameters - **states** (string) - Optional - Filter payments by their state (e.g., "Authorized"). - **from** (string) - Optional - Filter payments from a specific date and time (ISO 8601 format). - **to** (string) - Optional - Filter payments up to a specific date and time (ISO 8601 format). - **pageSize** (integer) - Optional - The number of results to return per page. - **sortOrder** (string) - Optional - The order to sort the results ('Asc' or 'Desc'). ### Request Example ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." # Get last 30 days of authorized payments as JSON curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo/payments?states=Authorized&from=2024-02-01T00:00:00Z&to=2024-03-01T00:00:00Z&pageSize=50&sortOrder=Desc" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" # Export as CSV curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo/payments?states=Authorized" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: text/csv" \ -o payments_export.csv ``` ### Response #### Success Response (200) - **data** (array) - An array of payment objects. - **id** (integer) - The unique identifier for the payment. - **amount** (integer) - The payment amount in cents. - **date** (string) - The date and time the payment was made (ISO 8601 format). - **state** (string) - The current state of the payment. - **paymentMeans** (string) - The method used for the payment. - **payer** (object) - Information about the payer. - **firstName** (string) - The payer's first name. - **lastName** (string) - The payer's last name. - **order** (object) - Information about the associated order. - **id** (integer) - The unique identifier for the order. - **formSlug** (string) - The slug of the form associated with the order. - **pagination** (object) - Pagination details for the results. - **pageSize** (integer) - The number of items per page. - **totalCount** (integer) - The total number of items available. - **pageIndex** (integer) - The current page index. - **totalPages** (integer) - The total number of pages. ### Response Example ```json { "data": [ { "id": 334455, "amount": 2500, "date": "2024-09-10T14:32:10Z", "state": "Authorized", "paymentMeans": "Card", "payer": { "firstName": "Jean", "lastName": "Martin" }, "order": { "id": 445566, "formSlug": "charity-run-2024" } } ], "pagination": { "pageSize": 50, "totalCount": 1, "pageIndex": 1, "totalPages": 1 } } ``` ``` -------------------------------- ### Cancel an Order Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Cancels all pending payments for an installment order. This action does not process refunds; use the payment refund endpoint for refunds. Requires the order ID and a valid API token. ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." ORDER_ID=445566 curl -X POST "https://api.helloasso.com/v5/orders/${ORDER_ID}/cancel" \ -H "Authorization: Bearer $TOKEN" ``` -------------------------------- ### Initialize HelloAsso Checkout Intent Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Create a new checkout intent for processing payments, memberships, or donations. The response provides a redirect URL for the user to complete the transaction. Ensure all required fields like totalAmount, itemName, and returnUrl are provided. ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." curl -X POST "https://api.helloasso.com/v5/organizations/my-ngo/checkout-intents" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "totalAmount": 5000, "initialAmount": 5000, "itemName": "Annual membership 2024", "backUrl": "https://mysite.org/back", "errorUrl": "https://mysite.org/error", "returnUrl": "https://mysite.org/success", "containsDonation": false, "payer": { "firstName": "Marie", "lastName": "Dupont", "email": "marie.dupont@example.com", "country": "FRA" }, "metadata": { "userId": "usr_123", "campaign": "renewal-2024" }, "paymentOptions": { "enableSepa": true } }' # Expected response: # { # "id": 987654, # "redirectUrl": "https://www.helloasso.com/checkout/987654" # } ``` -------------------------------- ### Checkout - Initialize a Checkout Intent Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Creates a new checkout intent for a partner application. The response contains a `redirectUrl` to which the contributor must be redirected to complete payment. ```APIDOC ## Checkout - Initialize a Checkout Intent ### Description Creates a new checkout intent for processing payments. The response provides a `redirectUrl` for the user to complete the transaction. Supports various payment options and metadata. ### Method POST ### Endpoint https://api.helloasso.com/v5/organizations/{organization_slug}/checkout-intents ### Parameters #### Path Parameters - **organization_slug** (string) - Required - The unique identifier for the organization. #### Request Body - **totalAmount** (integer) - Required - The total amount for the checkout in cents. - **initialAmount** (integer) - Required - The initial amount to be paid in cents. - **itemName** (string) - Required - The name of the item or service being paid for. - **backUrl** (string) - Required - The URL to redirect the user to if they cancel. - **errorUrl** (string) - Required - The URL to redirect the user to in case of an error. - **returnUrl** (string) - Required - The URL to redirect the user to upon successful completion. - **containsDonation** (boolean) - Required - Indicates if the checkout includes a donation. - **payer** (object) - Required - Information about the payer. - **firstName** (string) - Required - Payer's first name. - **lastName** (string) - Required - Payer's last name. - **email** (string) - Required - Payer's email address. - **country** (string) - Required - Payer's country code (e.g., 'FRA'). - **metadata** (object) - Optional - Additional key-value pairs for tracking. - **paymentOptions** (object) - Optional - Configuration for payment options. - **enableSepa** (boolean) - Optional - Whether to enable SEPA direct debit. ### Request Example ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." curl -X POST "https://api.helloasso.com/v5/organizations/my-ngo/checkout-intents" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d { "totalAmount": 5000, "initialAmount": 5000, "itemName": "Annual membership 2024", "backUrl": "https://mysite.org/back", "errorUrl": "https://mysite.org/error", "returnUrl": "https://mysite.org/success", "containsDonation": false, "payer": { "firstName": "Marie", "lastName": "Dupont", "email": "marie.dupont@example.com", "country": "FRA" }, "metadata": { "userId": "usr_123", "campaign": "renewal-2024" }, "paymentOptions": { "enableSepa": true } } ``` ### Response #### Success Response (200) - **id** (integer) - The unique identifier for the checkout intent. - **redirectUrl** (string) - The URL where the contributor must be redirected to complete the payment. ``` -------------------------------- ### Quick Create a Form Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Creates a simplified event form with essential details. The response includes the form's slug and public URL. Requires a JSON payload with form information. ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." curl -X POST "https://api.helloasso.com/v5/organizations/my-ngo/forms/Event/action/quick-create" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "title": "Charity Run 2024", "description": "Annual 10km charity run benefiting local shelters", "startDate": "2024-09-15T08:00:00Z", "endDate": "2024-09-15T13:00:00Z", "maxEntries": 200, "generateTickets": true, "tierList": [ { "label": "Adult", "price": 2000 }, { "label": "Child (under 12)", "price": 500 } ], "place": { "name": "City Park", "city": "Lyon", "zipCode": "69001", "country": "FRA" } }' ``` -------------------------------- ### Upload OpenAPI Spec to ReadMe Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Reads the OpenAPI specification from 'helloasso.json' and uploads it to the ReadMe developer portal using the ReadMe REST API. Requires `README_API_KEY` and `API_ID` environment variables for configuration. This script is intended to be run after SDK generation. ```javascript // index.js — run with: node index.js // Requires .env with: README_API_KEY= API_ID= import 'dotenv/config'; import axios from 'axios'; import fs from 'fs'; async function uploadToReadMe(jsonString) { const formData = new FormData(); formData.append('spec', jsonString); const config = { headers: { 'accept': 'application/json', 'x-readme-version': 'v5', 'Authorization': `Basic ${Buffer.from(`${process.env.README_API_KEY}:`).toString('base64')}` } }; try { const response = await axios.put( `https://dash.readme.com/api/v1/api-specification/${process.env.API_ID}`, formData, config ); console.log('Swagger successfully uploaded:', response.data); // Output: Swagger successfully uploaded: { id: '...', title: 'HelloAsso API', ... } } catch (error) { console.error('Failed to upload Swagger file:', error.response?.data || error.message); process.exit(1); } } function pushToReadme() { const jsonString = fs.readFileSync('helloasso.json', 'utf8'); uploadToReadMe(jsonString); } pushToReadme(); ``` ```bash # Environment setup cp .env.example .env # Edit .env: # README_API_KEY=rdme_xxxxxxxxxxxxxxxxxxxx # API_ID=65f3a1b2c3d4e5f6a7b8c9d0 npm install node index.js # Output: Swagger successfully uploaded: { id: '65f3a1b2c3d4e5f6a7b8c9d0', ... } ``` -------------------------------- ### GitHub Actions Workflow for Updates Source: https://context7.com/helloasso/helloasso-open-api/llms.txt This GitHub Actions workflow automates the generation of SDKs for PHP, Node.js, and Python, increments the patch version, pushes to respective SDK repositories, and updates the ReadMe developer portal. It can be triggered manually or automatically on pushes to the 'main' branch. ```yaml # Trigger manually via GitHub UI or CLI: gh workflow run "Update ReadMe & SDK" --ref main # Or trigger automatically by pushing a spec change: git add helloasso.json git commit -m "Update API spec: add new checkout endpoint" git push origin main # The workflow will: # 1. Generate PHP SDK → push to HelloAsso/helloasso-php (tagged v1.0.X) # 2. Generate Node SDK → push to HelloAsso/helloasso-node (tagged v1.0.X) # 3. Generate Python SDK→ push to HelloAsso/helloasso-python (tagged v1.0.X) # 4. Upload helloasso.json → ReadMe (https://dev.helloasso.com/reference/... ``` ```bash # Required GitHub repository secrets: # GH_TOKEN — Personal access token with write access to SDK repos # README_API_KEY — ReadMe API key (from dash.readme.com) # API_ID — ReadMe API specification ID # Generate SDK locally (example for Python): npm install @openapitools/openapi-generator-cli -g openapi-generator-cli generate \ -i helloasso.json \ -g python \ -o ./helloasso-python-local \ --additional-properties=packageName=helloasso_python ``` -------------------------------- ### Forms — Quick Create a Form Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Creates a simplified event form for an organization with minimal required fields. Returns the new form's slug and public URL. ```APIDOC ## Forms — Quick Create a Form ### Description Creates a simplified event form for an organization with minimal required fields. Returns the new form's slug and public URL. ### Method POST ### Endpoint https://api.helloasso.com/v5/organizations/{organization_slug}/forms/{form_type}/action/quick-create ### Parameters #### Request Body - **title** (string) - Required - The title of the form. - **description** (string) - Optional - A description for the form. - **startDate** (string) - Required - The start date and time of the event. - **endDate** (string) - Required - The end date and time of the event. - **maxEntries** (integer) - Optional - The maximum number of entries allowed for the form. - **generateTickets** (boolean) - Optional - Whether to generate tickets for the form. - **tierList** (array) - Optional - A list of pricing tiers. - **label** (string) - Required - The label for the tier. - **price** (integer) - Required - The price in cents. - **place** (object) - Optional - Details about the location. - **name** (string) - **city** (string) - **zipCode** (string) - **country** (string) ### Request Example ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." curl -X POST "https://api.helloasso.com/v5/organizations/my-ngo/forms/Event/action/quick-create" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "title": "Charity Run 2024", "description": "Annual 10km charity run benefiting local shelters", "startDate": "2024-09-15T08:00:00Z", "endDate": "2024-09-15T13:00:00Z", "maxEntries": 200, "generateTickets": true, "tierList": [ { "label": "Adult", "price": 2000 }, { "label": "Child (under 12)", "price": 500 } ], "place": { "name": "City Park", "city": "Lyon", "zipCode": "69001", "country": "FRA" } }' ``` ### Response #### Success Response (200) - **formSlug** (string) - The slug of the newly created form. - **organizationSlug** (string) - The slug of the organization. - **publicUrl** (string) - The public URL of the created form. ### Response Example ```json { "formSlug": "charity-run-2024", "organizationSlug": "my-ngo", "publicUrl": "https://www.helloasso.com/associations/my-ngo/evenements/charity-run-2024" } ``` ``` -------------------------------- ### Retrieve Public Form Details Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Fetches comprehensive public details for a specific form, including pricing, dates, and tiers. Ensure your API token is correctly set. ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo/forms/Event/summer-festival-2024/public" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" ``` -------------------------------- ### Retrieve HelloAsso Checkout Intent Details Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Fetch the details of an existing checkout intent using its ID. The associated order information is included only if the payment has been successfully authorized. The `withFailedRefundOperation` parameter can be set to `true` or `false`. ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." CHECKOUT_INTENT_ID=987654 curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo/checkout-intents/${CHECKOUT_INTENT_ID}?withFailedRefundOperation=false" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" # Expected response: # { # "id": 987654, # "redirectUrl": "https://www.helloasso.com/checkout/987654", # "order": { # "id": 112233, # "date": "2024-03-15T10:22:00Z", # "formSlug": "annual-membership-2024", # "formType": "Membership", # "organizationSlug": "my-ngo", # "amount": { "total": 5000, "vat": 0, "discount": 0 } # } # } ``` -------------------------------- ### HelloAsso GPG Public Key Source: https://github.com/helloasso/helloasso-open-api/blob/main/SECURITY.md This is the GPG public key for helloasso. Use this to encrypt communications when reporting security vulnerabilities. ```text -----BEGIN PGP PUBLIC KEY BLOCK----- mQGNBGYhJAYBDACyZZ5crqt6qgSo/v5WSX+Fkcdw7ziOTM3haUYbbU5s6mD8QL46 L3F1e2QMaEie5avQ4jnmuYO+REsuVMAMD718SfJXkYMoVp5+hmEIqkV4w9APTyIa pfEieM2WW9Q96/IXGHJILiCrXF+shB5cPQksfdw7v+6jAJmYTu62iwADW5zIAU+ YoG2mG9eMamnCrz1Rm0+8BwtUA6upZr+uQ0bDnmigF7fKwlQZJzI4QvB3/TO5HVx nqan6vwCQDGAeaQI/ufB/d1NzcFJwfHmcjc90xqpPkA3rjvfGZkFzaMx6jYp7eq3 Xb+T6AuLpmo3TGHax+XGcs0kK1KyD4AeyPzcTIET6dOKxYkWpjnitVKUJeGYuZ63 +MxuymN3l1ByEg8W2uA9pxDbBmAvNjqwQ+90xRlVnEMTT2kx2snIPhNWBHhgmjj1 fAjAP9vq+rZJnsdGXd7tvVCe+A/HOlCYwz2og1HsHXA8qi8XRqc619YJOb2PSGkJ ZHzJXRXth/x6tLEAEQEAAbQiSGVsbG9Bc3NvIDxzZWN1cml0ZUBoZWxsb2Fzc28u b3JnPokB0QQTAQgAOxYhBERR9SzCAN3J4MAnajL9Qx7182V6BQJmISQGAhsDBQsJ CAcCAiICBhUKCQgLAgWAgMBAh4HAheAAAoJEDL9Qx7182V6lfQL+wSrqMEbzHsk Q4cuDZLg+yNUiwQwEqDUqg8FnQ7zrpZU45q0wE2a4101h0zMa/80OF4seGc2Z6iy HJF4NjZI+EBVGtm5+m9vlug0jp9giw9yB+C/qXZ/oLANpMnus62LFWcm5NWEAO5V UX4B43NX5CK49xalni1z6oG8K+EKdAD/xx5BsmZBaxzBULF5rsnSGMbm0fdjprzY 31bDhWa9nOSGl8xnZzc58mz7QRXP+8bIR2PZ3xSqQ3fibluATpcPHd8t0VgoKIcx m5UmCIBf2lIQgHAsB/dMkPS9Mn7n4ZJNzDXTtqg1a9n5CBdtVTQxpVaYZGM9Tpea W3uhvjLIhQcHu4oMkkg+1btmLFT2/XjFdD3jopBeoYEP4rYI6Fh1gC1REZXpLWGN y5x50u65wRPqN9vd2Nhg6MhkhW496jFBvwVLx+bhTGcQPnI75Un1xhMoUYw4fcO/ pWfJ+rlPETM1YYT/YMse5ByWfRftfBOyjsy83HQ1dlIiolNHPQMiILkBjQRmISQG AQwA7+1JipWu2SJ8u4v8cGNWNMhrfb0KjbhyPQRqCauoY6B/e7g5GKHb8GudbTFT gTNbapbo63xWPMehxqhW4VQ2+r27/4dvE4X+Twf2sA0l01PsSNXkFrOFKN5GnQT OLKHYv33jSXwCmlgpxb7oTIDbHynqCR0/qG+7htrWQ6jE4dpR0BZYJbja0AD62JY 5qdvTqn1yw+9+tRLOiUt8YDth+mxqoI13O8D2VQfTdwXc6i4PLRoB8pUUoFopBF 1CcPxDqsuwEtuUQ52jg/TD0QAm8LV8NOD871w53692FBizg/XlQZ3ufHGQWzhSkr UOu2CGOkM5EmSSjFpFI0O7AngaexuNtGoO3yuQvaKqX1qIB1kZb/wqE95n2oNVRr vR/iftIa0svW/ziNzYllsUpmXfJyJgt5u9mvzxCjMPY+a5aHJOGxDA7oJ/SPiSD fRgRAs0IWVGX7X4nU45rIUVkeY7+aCtGHjWvqgA/mVRsG1lvi0KuVKuv8elp uZnFABEBAAGJAbYEGAEIACAWIQREUfUswgDdyeDAJ2oy/UMe9fNlegUCZiEkBgIb DAAKCRAy/UMe9fNlegldC/9fPk7HekdrB903Q0o+clEVjSjggfIzUGvt717EOF9S jxcD68b7k3oUevVpZbkMm/7etTiHvRuKPbA51e1mnXQzxlZlwuF4+EKOLAG8yzJS Egcc+fE7Se9Apw18rN88rZE4Se3zn2MwqNDEPTgvWs3DuanAI4FBFcX76DDtvjMy HbHN6u1WIhp+Vn21ynK7vXVzKIp9OCvaQv4hi9UbLDp57yP5iDRXkAB9bGOtiDoz imSxe9G+e+FLWIdDZ10oOovuijE2p4U3xMPMFUdtGcgPy+VhkaaoyC5LQQrTpD6i rvx8UGwPsRHNxraPNaFKLCnwIzDZDvGd1Wo4a6qW9a2KU46gdmqPOm0OTMbmbnxF 5ExAHk/kT9CTcOa+uwD8bQbGRmZuBGLJ3gYKEsSfQb7bUILrQ7Q//OM3behCftQa jU4h0/RM9erwD45CZ/o4YsJLtQadpfaRslN11qZNqFBnzTY8+d/B5jUW/HW5At/m 3PvtGRH7UKNRdiKZI23uGJE= =180I -----END PGP PUBLIC KEY BLOCK----- ``` -------------------------------- ### Manage Partner Notification URLs Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Sets or removes webhook URLs for receiving event notifications from HelloAsso. Supports main URLs and organization-specific, type-filtered URLs. Ensure Content-Type is application/json. ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." # Set main notification URL curl -X PUT "https://api.helloasso.com/v5/partners/me/api-notifications" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "url": "https://my-partner-app.com/webhooks/helloasso" }' ``` ```bash # Set a per-organization, payment-only notification URL curl -X PUT "https://api.helloasso.com/v5/partners/me/api-notifications/organizations/my-ngo" \ -H "Authorization: Bearer $TOKEN" \ -H "Content-Type: application/json" \ -d '{ "url": "https://my-partner-app.com/webhooks/payments", "notificationType": "Payment" }' ``` ```bash # Delete the main notification URL curl -X DELETE "https://api.helloasso.com/v5/partners/me/api-notifications" \ -H "Authorization: Bearer $TOKEN" ``` -------------------------------- ### List Organization Forms on HelloAsso Source: https://context7.com/helloasso/helloasso-open-api/llms.txt Retrieve a paginated list of forms associated with an organization. You can filter the results by form state (e.g., 'Public') and form type (e.g., 'Event'). Pagination parameters `pageIndex` and `pageSize` control the results. ```bash TOKEN="eyJhbGciOiJSUzI1NiIs..." curl -X GET "https://api.helloasso.com/v5/organizations/my-ngo/forms?states=Public&formTypes=Event&pageIndex=1&pageSize=10" \ -H "Authorization: Bearer $TOKEN" \ -H "Accept: application/json" # Expected response: # { # "data": [ # { # "title": "Summer Festival 2024", # "formSlug": "summer-festival-2024", # "formType": "Event", # "state": "Public", # "startDate": "2024-07-01T09:00:00Z", # "endDate": "2024-07-03T18:00:00Z", # "url": "https://www.helloasso.com/associations/my-ngo/evenements/summer-festival-2024" # } # ], # "pagination": { "pageSize": 10, "totalCount": 1, "pageIndex": 1, "totalPages": 1 } # } ```