{ "openapi": "3.0.1", "info": { "title": "HelloAsso · Association Emails by Cause", "description": "Paste a HelloAsso search or pick a cause. Turn Collect emails on for public mailboxes from the HelloAsso profile and the association website (contact / mentions légales). Directory-only is cheaper. No login.", "version": "1.10", "x-build-id": "nM0w2PEkBcLEngHzy" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/corent1robert~helloasso-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-corent1robert-helloasso-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/corent1robert~helloasso-scraper/runs": { "post": { "operationId": "runs-sync-corent1robert-helloasso-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/corent1robert~helloasso-scraper/run-sync": { "post": { "operationId": "run-sync-corent1robert-helloasso-scraper", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "cause": { "title": "Cause", "enum": [ "sport", "culture", "sante", "environnement", "education", "solidarite", "musique", "enfance", "handicap", "animal", "patrimoine", "insertion", "" ], "type": "string", "description": "HelloAsso category (same as category_tags on the site). **Education** + **All France** = education associations nationwide. **Any cause** = no category filter.", "default": "sport" }, "activityType": { "title": "What they organise", "enum": [ "", "cours", "evenement", "don", "adhesion", "cagnotte", "boutique" ], "type": "string", "description": "HelloAsso activity filter. **Courses / classes** is the same as helloasso.com/e/recherche/associations?activity_type=cours. **All activities** = no activity filter.", "default": "" }, "city": { "title": "City", "enum": [ "", "paris", "lyon", "marseille", "toulouse", "nice", "nantes", "montpellier", "strasbourg", "bordeaux", "lille", "rennes", "reims", "saint-etienne", "toulon", "le-havre", "grenoble", "dijon", "angers", "nimes", "villeurbanne", "clermont-ferrand", "aix-en-provence", "brest", "le-mans", "tours", "amiens", "limoges", "metz", "perpignan", "besancon", "orleans", "rouen", "caen", "nancy", "avignon", "poitiers", "pau", "la-rochelle", "annecy", "cannes" ], "type": "string", "description": "**All France** = every city in the results (no city filter). Pick a city only if you want that city or département.", "default": "" }, "maxItems": { "title": "Max associations", "minimum": 0, "maximum": 50000, "type": "integer", "description": "Stop after this many unique associations. **0 = all matching results** (keeps paging until HelloAsso has no more cards, or the 6-hour run limit). **Free plan: 20 / run.**", "default": 24 }, "collectContacts": { "title": "Collect emails (HelloAsso profile + association website)", "type": "boolean", "description": "When on, open each public HelloAsso profile and keep mailto / phone / website already visible on the page (we do not click a “see email” button). Then, if **Also scan the association website** is on, fetch the homepage, contact and mentions légales. Sets `emailSource` to `helloasso-profile` or `association-website`. A mailbox from either source is billed as **with email**. About 1 in 5 associations publish one.", "default": false }, "enrichFromWebsite": { "title": "Also scan the association website (email, phone, SIREN/SIRET)", "type": "boolean", "description": "Used only when Collect emails is on. After the HelloAsso profile, fetch the public website (homepage, contact, mentions légales) for **email**, **phone**, **SIREN** and **SIRET**. Sets `emailSource` to `association-website` when the mailbox comes from the site. A mailbox found this way is billed as **with email**.", "default": true }, "searchUrl": { "title": "HelloAsso search URL", "type": "string", "description": "Example: https://www.helloasso.com/e/recherche/associations?activity_type=cours&category_tags=education" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }