--- updatedAt: 2026-02-04T17:17:16.000Z agentTools: projectIndex: https://dev.helloasso.com/llms.txt --- # Get form 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": "form resource", "description": "API endpoints for managing form resources", "x-tag-schema": { "$ref": "#/components/schemas/form" }, "x-tag-schema-example": { "name": "x", "fields": [ { "name": "x", "type": "choice", "options": [ "string" ] } ], "_id": "64b7f8b6f23a4a4f3d0a9b12", "_createdAt": "2024-01-01T00:00:00.000Z" } } ], "security": [ { "ApiKeyAuth": [] } ], "paths": { "/v1/organizers/{organizerId}/events/{eventId}/forms/{formId}": { "get": { "tags": [ "form resource" ], "summary": "Get form resource", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/form" } } } } }, "parameters": [ { "name": "organizerId", "in": "path", "required": true, "description": "Resource identifier.", "schema": { "type": "string", "format": "objectId" }, "example": "64b7f8b6f23a4a4f3d0a9b12" }, { "name": "eventId", "in": "path", "required": true, "description": "Resource identifier.", "schema": { "type": "string", "format": "objectId" }, "example": "64b7f8b6f23a4a4f3d0a9b12" }, { "name": "formId", "in": "path", "required": true, "description": "Resource identifier.", "schema": { "type": "string", "format": "objectId" }, "example": "64b7f8b6f23a4a4f3d0a9b12" } ] } } }, "components": { "schemas": { "form": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "example": "x" }, "displayName": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "fields": { "minItems": 1, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "status": { "nullable": true, "type": "string", "enum": [ "enabled", "disabled" ], "example": "enabled" }, "visibility": { "nullable": true, "type": "string", "enum": [ "hidden", "visible", "emphasized" ], "example": "hidden" }, "externalFormId": { "nullable": true }, "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "choice" ], "example": "choice" }, "options": { "type": "array", "items": { "type": "string", "example": "string" } }, "otherInput": { "nullable": true, "type": "boolean", "example": true }, "rule": { "nullable": true, "type": "string", "enum": [ "min", "max", "equals" ], "example": "min" }, "ruleValue": { "nullable": true, "type": "number", "example": 0 } }, "required": [ "name", "key", "type", "options" ], "additionalProperties": false, "title": "choice" }, { "type": "object", "properties": { "status": { "nullable": true, "type": "string", "enum": [ "enabled", "disabled" ], "example": "enabled" }, "visibility": { "nullable": true, "type": "string", "enum": [ "hidden", "visible", "emphasized" ], "example": "hidden" }, "externalFormId": { "nullable": true }, "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "text" ], "example": "text" }, "rule": { "nullable": true, "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "email" ], "example": "email" }, "value": { "nullable": true, "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$", "example": "user@example.com" } }, "required": [ "type" ], "additionalProperties": false, "title": "email" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "phone" ], "example": "phone" } }, "required": [ "type" ], "additionalProperties": false, "title": "phone" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ], "example": "url" }, "value": { "nullable": true, "type": "string", "format": "uri", "example": "https://example.com" } }, "required": [ "type" ], "additionalProperties": false, "title": "url" }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "regex" ], "example": "regex" }, "value": { "nullable": true, "type": "string", "example": "string" } }, "required": [ "type" ], "additionalProperties": false, "title": "regex" } ] } }, "required": [ "name", "key", "type" ], "additionalProperties": false, "title": "text" }, { "type": "object", "properties": { "status": { "nullable": true, "type": "string", "enum": [ "enabled", "disabled" ], "example": "enabled" }, "visibility": { "nullable": true, "type": "string", "enum": [ "hidden", "visible", "emphasized" ], "example": "hidden" }, "externalFormId": { "nullable": true }, "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "address" ], "example": "address" } }, "required": [ "name", "key", "type" ], "additionalProperties": false, "title": "address" }, { "type": "object", "properties": { "status": { "nullable": true, "type": "string", "enum": [ "enabled", "disabled" ], "example": "enabled" }, "visibility": { "nullable": true, "type": "string", "enum": [ "hidden", "visible", "emphasized" ], "example": "hidden" }, "externalFormId": { "nullable": true }, "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "number" ], "example": "number" }, "decimalPlaces": { "nullable": true, "type": "number", "example": 0 }, "range": { "nullable": true, "type": "object", "additionalProperties": { "type": "object", "properties": { "rule": { "type": "string", "enum": [ "include", "exclude" ], "example": "include" }, "value": { "type": "number", "example": 0 } }, "required": [ "rule", "value" ], "additionalProperties": false }, "required": [ "min", "max" ] } }, "required": [ "name", "key", "type" ], "additionalProperties": false, "title": "number" }, { "type": "object", "properties": { "status": { "nullable": true, "type": "string", "enum": [ "enabled", "disabled" ], "example": "enabled" }, "visibility": { "nullable": true, "type": "string", "enum": [ "hidden", "visible", "emphasized" ], "example": "hidden" }, "externalFormId": { "nullable": true }, "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "file" ], "example": "file" }, "format": { "nullable": true, "type": "string", "enum": [ "image", "video", "audio", "document" ], "example": "image" }, "rule": { "nullable": true, "type": "string", "enum": [ "min", "max", "equals" ], "example": "min" }, "ruleValue": { "nullable": true, "type": "number", "example": 0 } }, "required": [ "name", "key", "type" ], "additionalProperties": false, "title": "file" }, { "type": "object", "properties": { "status": { "nullable": true, "type": "string", "enum": [ "enabled", "disabled" ], "example": "enabled" }, "visibility": { "nullable": true, "type": "string", "enum": [ "hidden", "visible", "emphasized" ], "example": "hidden" }, "externalFormId": { "nullable": true }, "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "date" ], "example": "date" }, "dateUnit": { "default": "day", "type": "string", "enum": [ "minute", "hour", "day", "month", "year" ] }, "range": { "type": "object", "additionalProperties": { "type": "object", "properties": { "rule": { "type": "string", "enum": [ "include", "exclude" ], "example": "include" }, "value": {} }, "required": [ "rule", "value" ], "additionalProperties": false }, "required": [ "min", "max" ] } }, "required": [ "name", "key", "type", "dateUnit", "range" ], "additionalProperties": false, "title": "date" } ] } }, "localeDetails": { "nullable": true, "type": "object", "additionalProperties": { "nullable": true, "type": "object", "properties": { "name": { "nullable": true, "type": "string", "minLength": 1, "example": "x" }, "fields": { "nullable": true, "type": "array", "items": { "oneOf": [ { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "choice" ], "example": "choice" }, "options": { "type": "array", "items": { "nullable": true, "type": "string", "example": "string" } } }, "required": [ "name", "key", "type", "options" ], "additionalProperties": false, "title": "choice" }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "text" ], "example": "text" } }, "required": [ "name", "key", "type" ], "additionalProperties": false, "title": "text" }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "address" ], "example": "address" } }, "required": [ "name", "key", "type" ], "additionalProperties": false, "title": "address" }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "number" ], "example": "number" } }, "required": [ "name", "key", "type" ], "additionalProperties": false, "title": "number" }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "file" ], "example": "file" } }, "required": [ "name", "key", "type" ], "additionalProperties": false, "title": "file" }, { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "example": "x" }, "key": {}, "optional": { "nullable": true, "type": "boolean", "example": true }, "hint": { "nullable": true, "type": "string", "example": "string" }, "type": { "type": "string", "enum": [ "date" ], "example": "date" } }, "required": [ "name", "key", "type" ], "additionalProperties": false, "title": "date" } ] } } }, "additionalProperties": false }, "required": [ "fr", "en", "es" ] }, "defaultLocale": { "nullable": true, "type": "string", "enum": [ "fr", "en", "es" ], "example": "fr" }, "_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", "fields", "_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": {} } ```