--- updatedAt: 2026-02-04T17:17:16.000Z agentTools: projectIndex: https://dev.helloasso.com/llms.txt --- # List event resource # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Plus Billetterie API", "version": "1.0.0", "description": "Authentication: send your API key in the Authorization header using the format `X-API-KEY YOUR_API_KEY`.\n\nEach API key is tied to a single organization. A key cannot manage multiple organizations.\n\nAPI keys can be generated from the organization dashboard (Developer tab)." }, "tags": [ { "name": "event resource", "description": "API endpoints for managing event resources", "x-tag-schema": { "$ref": "#/components/schemas/event" }, "x-tag-schema-example": { "name": "x", "type": "other", "timezone": "Europe/Paris", "_id": "64b7f8b6f23a4a4f3d0a9b12", "_createdAt": "2024-01-01T00:00:00.000Z" } } ], "security": [ { "ApiKeyAuth": [] } ], "paths": { "/v1/organizers/{organizerId}/events": { "get": { "tags": [ "event resource" ], "summary": "List event resource", "parameters": [ { "name": "organizerId", "in": "path", "required": true, "description": "Resource identifier.", "schema": { "type": "string", "format": "objectId" }, "example": "64b7f8b6f23a4a4f3d0a9b12" }, { "name": "filters", "in": "query", "required": false, "description": "JSON array of filter objects. Example: [{\"status\":\"active\"}]", "schema": { "type": "string" }, "example": "[{\"status\":\"active\"}]" }, { "name": "filtersLogical", "in": "query", "required": false, "description": "Logical operator applied to filters.", "schema": { "type": "string", "enum": [ "$and", "$or", "$nor" ] }, "example": "$and" }, { "name": "limit", "in": "query", "required": false, "description": "Maximum number of items to return.", "schema": { "type": "integer", "minimum": 0 }, "example": 25 }, { "name": "skip", "in": "query", "required": false, "description": "Number of items to skip.", "schema": { "type": "integer", "minimum": 0 }, "example": 0 }, { "name": "startId", "in": "query", "required": false, "description": "Start listing after this object id.", "schema": { "type": "string", "format": "objectId" }, "example": "64b7f8b6f23a4a4f3d0a9b12" }, { "name": "sort", "in": "query", "required": false, "description": "Sort spec as JSON string. Example: {\"_createdAt\":\"desc\"}.", "schema": { "type": "string" }, "example": "{\"_createdAt\":\"desc\"}" } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/event" } }, "metadata": { "type": "object" }, "_type": { "type": "string", "example": "event" } } } } } } } } } }, "components": { "schemas": { "event": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "example": "x" }, "placeId": { "nullable": true }, "place": { "nullable": true }, "formId": { "nullable": true }, "categories": { "nullable": true, "type": "array", "items": { "type": "string", "enum": [ "eventLocations", "resales", "ticketOffice", "description", "faq", "partners", "contact", "planning", "testimonials", "music" ], "example": "eventLocations" } }, "contentIds": { "nullable": true, "type": "array", "items": {} }, "defaultTicketContentId": { "nullable": true }, "ticketContentRules": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "providers": { "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "discount" ], "example": "discount" }, "ids": { "minItems": 1, "type": "array", "items": {} } }, "required": [ "type", "ids" ], "additionalProperties": false, "title": "discount" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "shop" ], "example": "shop" }, "ids": { "minItems": 1, "type": "array", "items": {} } }, "required": [ "type", "ids" ], "additionalProperties": false, "title": "shop" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "product" ], "example": "product" }, "ids": { "minItems": 1, "type": "array", "items": {} } }, "required": [ "type", "ids" ], "additionalProperties": false, "title": "product" } ] } }, "ticketContentId": { "nullable": true } }, "required": [ "providers" ], "additionalProperties": false } }, "optionalForm": { "nullable": true, "type": "boolean", "example": true }, "feesMode": { "nullable": true, "type": "string", "enum": [ "author", "client" ], "example": "author" }, "medias": { "nullable": true }, "type": { "default": "other", "type": "string", "enum": [ "nightclub", "concert", "festival", "conference", "tradeshow", "exhibition", "forum", "workshop", "meeting", "other" ] }, "shortDescription": { "nullable": true, "type": "string", "example": "string" }, "description": { "nullable": true, "type": "string", "example": "string" }, "tagList": { "nullable": true, "type": "array", "items": { "type": "string", "example": "string" } }, "isPrivate": { "nullable": true, "type": "boolean", "example": true }, "needConfirmation": { "nullable": true, "type": "boolean", "example": true }, "maxCount": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 9007199254740991, "example": 0 }, "faq": { "nullable": true, "type": "object", "additionalProperties": { "nullable": true, "type": "string", "minLength": 1, "example": "x" } }, "contact": { "nullable": true, "type": "object", "additionalProperties": { "nullable": true, "type": "string", "example": "string" }, "required": [ "phone", "email", "website", "youtube", "snapchat", "linkedin", "instagram", "facebook", "x" ] }, "legalId": { "nullable": true }, "dateRule": { "nullable": true, "type": "string", "enum": [ "day", "hour", "minute" ], "example": "day" }, "invoiceReferencePrefix": { "nullable": true, "type": "string", "maxLength": 10, "example": "string" }, "taxType": { "nullable": true, "type": "string", "enum": [ "notApplicable", "reverseCharge", "intraCommunity", "standard" ], "example": "notApplicable" }, "installments": { "nullable": true, "type": "array", "items": { "type": "integer", "minimum": 2, "maximum": 12, "example": 2 } }, "defaultLocale": { "nullable": true, "type": "string", "enum": [ "fr", "en", "es" ], "example": "fr" }, "orderExpirationDelay": { "nullable": true, "type": "string", "example": "string" }, "salesDetails": { "nullable": true, "type": "object", "properties": { "orderConfirmationText": { "nullable": true, "type": "string", "example": "string" }, "refundPolicy": { "nullable": true, "type": "string", "example": "string" }, "terms": { "nullable": true, "type": "string", "example": "string" } }, "additionalProperties": false }, "localeDetails": { "nullable": true, "type": "object", "additionalProperties": { "nullable": true, "type": "object", "properties": { "name": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "description": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "shortDescription": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "faq": { "nullable": true, "type": "object", "additionalProperties": { "nullable": true, "type": "string", "example": "string" } }, "salesDetails": { "nullable": true, "type": "object", "properties": { "orderConfirmationText": { "nullable": true, "type": "string", "example": "string" }, "refundPolicy": { "nullable": true, "type": "string", "example": "string" }, "terms": { "nullable": true, "type": "string", "example": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "required": [ "fr", "en", "es" ] }, "timezone": { "default": "Europe/Paris", "type": "string", "enum": [ "Africa/Abidjan", "Africa/Accra", "Africa/Addis_Ababa", "Africa/Algiers", "Africa/Asmera", "Africa/Bamako", "Africa/Bangui", "Africa/Banjul", "Africa/Bissau", "Africa/Blantyre", "Africa/Brazzaville", "Africa/Bujumbura", "Africa/Cairo", "Africa/Casablanca", "Africa/Ceuta", "Africa/Conakry", "Africa/Dakar", "Africa/Dar_es_Salaam", "Africa/Djibouti", "Africa/Douala", "Africa/El_Aaiun", "Africa/Freetown", "Africa/Gaborone", "Africa/Harare", "Africa/Johannesburg", "Africa/Juba", "Africa/Kampala", "Africa/Khartoum", "Africa/Kigali", "Africa/Kinshasa", "Africa/Lagos", "Africa/Libreville", "Africa/Lome", "Africa/Luanda", "Africa/Lubumbashi", "Africa/Lusaka", "Africa/Malabo", "Africa/Maputo", "Africa/Maseru", "Africa/Mbabane", "Africa/Mogadishu", "Africa/Monrovia", "Africa/Nairobi", "Africa/Ndjamena", "Africa/Niamey", "Africa/Nouakchott", "Africa/Ouagadougou", "Africa/Porto-Novo", "Africa/Sao_Tome", "Africa/Tripoli", "Africa/Tunis", "Africa/Windhoek", "America/Adak", "America/Anchorage", "America/Anguilla", "America/Antigua", "America/Araguaina", "America/Argentina/La_Rioja", "America/Argentina/Rio_Gallegos", "America/Argentina/Salta", "America/Argentina/San_Juan", "America/Argentina/San_Luis", "America/Argentina/Tucuman", "America/Argentina/Ushuaia", "America/Aruba", "America/Asuncion", "America/Bahia", "America/Bahia_Banderas", "America/Barbados", "America/Belem", "America/Belize", "America/Blanc-Sablon", "America/Boa_Vista", "America/Bogota", "America/Boise", "America/Buenos_Aires", "America/Cambridge_Bay", "America/Campo_Grande", "America/Cancun", "America/Caracas", "America/Catamarca", "America/Cayenne", "America/Cayman", "America/Chicago", "America/Chihuahua", "America/Ciudad_Juarez", "America/Coral_Harbour", "America/Cordoba", "America/Costa_Rica", "America/Coyhaique", "America/Creston", "America/Cuiaba", "America/Curacao", "America/Danmarkshavn", "America/Dawson", "America/Dawson_Creek", "America/Denver", "America/Detroit", "America/Dominica", "America/Edmonton", "America/Eirunepe", "America/El_Salvador", "America/Fort_Nelson", "America/Fortaleza", "America/Glace_Bay", "America/Godthab", "America/Goose_Bay", "America/Grand_Turk", "America/Grenada", "America/Guadeloupe", "America/Guatemala", "America/Guayaquil", "America/Guyana", "America/Halifax", "America/Havana", "America/Hermosillo", "America/Indiana/Knox", "America/Indiana/Marengo", "America/Indiana/Petersburg", "America/Indiana/Tell_City", "America/Indiana/Vevay", "America/Indiana/Vincennes", "America/Indiana/Winamac", "America/Indianapolis", "America/Inuvik", "America/Iqaluit", "America/Jamaica", "America/Jujuy", "America/Juneau", "America/Kentucky/Monticello", "America/Kralendijk", "America/La_Paz", "America/Lima", "America/Los_Angeles", "America/Louisville", "America/Lower_Princes", "America/Maceio", "America/Managua", "America/Manaus", "America/Marigot", "America/Martinique", "America/Matamoros", "America/Mazatlan", "America/Mendoza", "America/Menominee", "America/Merida", "America/Metlakatla", "America/Mexico_City", "America/Miquelon", "America/Moncton", "America/Monterrey", "America/Montevideo", "America/Montserrat", "America/Nassau", "America/New_York", "America/Nome", "America/Noronha", "America/North_Dakota/Beulah", "America/North_Dakota/Center", "America/North_Dakota/New_Salem", "America/Ojinaga", "America/Panama", "America/Paramaribo", "America/Phoenix", "America/Port-au-Prince", "America/Port_of_Spain", "America/Porto_Velho", "America/Puerto_Rico", "America/Punta_Arenas", "America/Rankin_Inlet", "America/Recife", "America/Regina", "America/Resolute", "America/Rio_Branco", "America/Santarem", "America/Santiago", "America/Santo_Domingo", "America/Sao_Paulo", "America/Scoresbysund", "America/Sitka", "America/St_Barthelemy", "America/St_Johns", "America/St_Kitts", "America/St_Lucia", "America/St_Thomas", "America/St_Vincent", "America/Swift_Current", "America/Tegucigalpa", "America/Thule", "America/Tijuana", "America/Toronto", "America/Tortola", "America/Vancouver", "America/Whitehorse", "America/Winnipeg", "America/Yakutat", "Antarctica/Casey", "Antarctica/Davis", "Antarctica/DumontDUrville", "Antarctica/Macquarie", "Antarctica/Mawson", "Antarctica/McMurdo", "Antarctica/Palmer", "Antarctica/Rothera", "Antarctica/Syowa", "Antarctica/Troll", "Antarctica/Vostok", "Arctic/Longyearbyen", "Asia/Aden", "Asia/Almaty", "Asia/Amman", "Asia/Anadyr", "Asia/Aqtau", "Asia/Aqtobe", "Asia/Ashgabat", "Asia/Atyrau", "Asia/Baghdad", "Asia/Bahrain", "Asia/Baku", "Asia/Bangkok", "Asia/Barnaul", "Asia/Beirut", "Asia/Bishkek", "Asia/Brunei", "Asia/Calcutta", "Asia/Chita", "Asia/Colombo", "Asia/Damascus", "Asia/Dhaka", "Asia/Dili", "Asia/Dubai", "Asia/Dushanbe", "Asia/Famagusta", "Asia/Gaza", "Asia/Hebron", "Asia/Hong_Kong", "Asia/Hovd", "Asia/Irkutsk", "Asia/Jakarta", "Asia/Jayapura", "Asia/Jerusalem", "Asia/Kabul", "Asia/Kamchatka", "Asia/Karachi", "Asia/Katmandu", "Asia/Khandyga", "Asia/Krasnoyarsk", "Asia/Kuala_Lumpur", "Asia/Kuching", "Asia/Kuwait", "Asia/Macau", "Asia/Magadan", "Asia/Makassar", "Asia/Manila", "Asia/Muscat", "Asia/Nicosia", "Asia/Novokuznetsk", "Asia/Novosibirsk", "Asia/Omsk", "Asia/Oral", "Asia/Phnom_Penh", "Asia/Pontianak", "Asia/Pyongyang", "Asia/Qatar", "Asia/Qostanay", "Asia/Qyzylorda", "Asia/Rangoon", "Asia/Riyadh", "Asia/Saigon", "Asia/Sakhalin", "Asia/Samarkand", "Asia/Seoul", "Asia/Shanghai", "Asia/Singapore", "Asia/Srednekolymsk", "Asia/Taipei", "Asia/Tashkent", "Asia/Tbilisi", "Asia/Tehran", "Asia/Thimphu", "Asia/Tokyo", "Asia/Tomsk", "Asia/Ulaanbaatar", "Asia/Urumqi", "Asia/Ust-Nera", "Asia/Vientiane", "Asia/Vladivostok", "Asia/Yakutsk", "Asia/Yekaterinburg", "Asia/Yerevan", "Atlantic/Azores", "Atlantic/Bermuda", "Atlantic/Canary", "Atlantic/Cape_Verde", "Atlantic/Faeroe", "Atlantic/Madeira", "Atlantic/Reykjavik", "Atlantic/South_Georgia", "Atlantic/St_Helena", "Atlantic/Stanley", "Australia/Adelaide", "Australia/Brisbane", "Australia/Broken_Hill", "Australia/Darwin", "Australia/Eucla", "Australia/Hobart", "Australia/Lindeman", "Australia/Lord_Howe", "Australia/Melbourne", "Australia/Perth", "Australia/Sydney", "Europe/Amsterdam", "Europe/Andorra", "Europe/Astrakhan", "Europe/Athens", "Europe/Belgrade", "Europe/Berlin", "Europe/Bratislava", "Europe/Brussels", "Europe/Bucharest", "Europe/Budapest", "Europe/Busingen", "Europe/Chisinau", "Europe/Copenhagen", "Europe/Dublin", "Europe/Gibraltar", "Europe/Guernsey", "Europe/Helsinki", "Europe/Isle_of_Man", "Europe/Istanbul", "Europe/Jersey", "Europe/Kaliningrad", "Europe/Kiev", "Europe/Kirov", "Europe/Lisbon", "Europe/Ljubljana", "Europe/London", "Europe/Luxembourg", "Europe/Madrid", "Europe/Malta", "Europe/Mariehamn", "Europe/Minsk", "Europe/Monaco", "Europe/Moscow", "Europe/Oslo", "Europe/Paris", "Europe/Podgorica", "Europe/Prague", "Europe/Riga", "Europe/Rome", "Europe/Samara", "Europe/San_Marino", "Europe/Sarajevo", "Europe/Saratov", "Europe/Simferopol", "Europe/Skopje", "Europe/Sofia", "Europe/Stockholm", "Europe/Tallinn", "Europe/Tirane", "Europe/Ulyanovsk", "Europe/Vaduz", "Europe/Vatican", "Europe/Vienna", "Europe/Vilnius", "Europe/Volgograd", "Europe/Warsaw", "Europe/Zagreb", "Europe/Zurich", "Indian/Antananarivo", "Indian/Chagos", "Indian/Christmas", "Indian/Cocos", "Indian/Comoro", "Indian/Kerguelen", "Indian/Mahe", "Indian/Maldives", "Indian/Mauritius", "Indian/Mayotte", "Indian/Reunion", "Pacific/Apia", "Pacific/Auckland", "Pacific/Bougainville", "Pacific/Chatham", "Pacific/Easter", "Pacific/Efate", "Pacific/Enderbury", "Pacific/Fakaofo", "Pacific/Fiji", "Pacific/Funafuti", "Pacific/Galapagos", "Pacific/Gambier", "Pacific/Guadalcanal", "Pacific/Guam", "Pacific/Honolulu", "Pacific/Kiritimati", "Pacific/Kosrae", "Pacific/Kwajalein", "Pacific/Majuro", "Pacific/Marquesas", "Pacific/Midway", "Pacific/Nauru", "Pacific/Niue", "Pacific/Norfolk", "Pacific/Noumea", "Pacific/Pago_Pago", "Pacific/Palau", "Pacific/Pitcairn", "Pacific/Ponape", "Pacific/Port_Moresby", "Pacific/Rarotonga", "Pacific/Saipan", "Pacific/Tahiti", "Pacific/Tarawa", "Pacific/Tongatapu", "Pacific/Truk", "Pacific/Wake", "Pacific/Wallis" ] }, "theme": { "nullable": true, "type": "object", "properties": { "dark": { "nullable": true, "type": "boolean", "example": true }, "primaryColor": { "nullable": true, "type": "string", "pattern": "^#(?:[A-Fa-f0-9]{3,4}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$", "example": "#A1B2C3" }, "secondaryColor": { "nullable": true, "type": "string", "pattern": "^#(?:[A-Fa-f0-9]{3,4}|[A-Fa-f0-9]{6}|[A-Fa-f0-9]{8})$", "example": "#A1B2C3" }, "backgroundMedia": { "nullable": true } }, "additionalProperties": false }, "music": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "example": "x" }, "description": { "nullable": true, "type": "string", "example": "string" }, "media": { "nullable": true }, "audioMedia": { "nullable": true } }, "required": [ "title" ], "additionalProperties": false } }, "testimonials": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "example": "x" }, "role": { "nullable": true, "type": "string", "example": "string" }, "content": { "type": "string", "minLength": 1, "example": "x" }, "media": { "nullable": true } }, "required": [ "name", "content" ], "additionalProperties": false } }, "partners": { "nullable": true, "type": "array", "items": { "type": "object", "properties": { "organizerId": {}, "role": { "nullable": true, "type": "string", "example": "string" }, "description": { "nullable": true, "type": "string", "example": "string" } }, "required": [ "organizerId" ], "additionalProperties": false } }, "referenceHandler": { "nullable": true, "type": "object", "properties": { "regex": { "type": "string", "minLength": 1, "example": "x" }, "hint": { "type": "string", "minLength": 1, "example": "x" } }, "required": [ "regex", "hint" ], "additionalProperties": false }, "slug": { "nullable": true, "type": "string", "example": "string" }, "status": { "nullable": true, "type": "string", "enum": [ "draft", "canceled", "published", "disabled" ], "example": "draft" }, "_id": { "type": "string", "format": "objectId", "example": "64b7f8b6f23a4a4f3d0a9b12" }, "_createdAt": { "type": "string", "format": "date-time", "example": "2024-01-01T00:00:00.000Z" }, "_updatedAt": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-01T00:00:00.000Z" }, "_reference": { "type": "string", "nullable": true, "example": "string" } }, "required": [ "name", "type", "timezone", "_id", "_createdAt" ], "additionalProperties": false } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY", "description": "Use the format `X-API-KEY YOUR_API_KEY`. Each key is tied to a single organization." } } }, "servers": [ { "url": "https://api.plusbilletterie.helloasso.com" } ], "x-readme": {} } ```