This is a contract.
", "is_one_sided": 0, "language": "hu", "hide_service_provider_details": false, "need_validation": 0, "partners": [ { "position": 2, "email": "partner@example.com", "title": "Partner (Witness 1)" } ] } }, "create_html_multiparty": { "summary": "Create from HTML - Multiparty", "value": { "title": "Multiparty HTML Contract", "sign_now": true, "callback_url": "https://site.com/callback", "redirect_url": "https://site.com/redirect", "html_content": "Parties agree...
", "is_one_sided": 0, "language": "hu", "hide_service_provider_details": false, "need_validation": 0, "allowed_user_type": 2, "signer_count": 4, "partners": [ { "position": 2, "email": "pos2@example.com" }, { "position": 3, "email": "pos3@example.com" }, { "position": 4, "email": "pos4@example.com", "partner_details": { "partner_type": 1, "signatory_name": "Pos4 Name", "phone_number": "+36301234567", "address": "1234 City, Street 1", "mothers_name": "Mother Name", "birthday": "1980-01-01", "place_of_birth": "City" } } ] } }, "create_html_mixed": { "summary": "Create from HTML - Mixed Partners", "value": { "title": "Mixed Partners HTML Contract", "sign_now": true, "callback_url": "https://site.com/callback", "redirect_url": "https://site.com/redirect", "html_content": "Parties agree...
", "is_one_sided": 0, "language": "hu", "hide_service_provider_details": false, "need_validation": 0, "allowed_user_type": 1, "partners": [ { "position": 2, "email": "ceo@example.com", "partner_details": { "partner_type": 2, "company_name": "Example Ltd.", "company_tax_number": "12345678-1-42", "company_registered_office": "1234 City, Street 1", "signatory_name": "John CEO" } }, { "position": 3, "email": "private@example.com", "partner_details": { "partner_type": 1, "signatory_name": "Jane Private", "phone_number": "+36301234567", "address": "5678 Town, Road 2", "mothers_name": "Mother Name", "birthday": "1980-01-01", "place_of_birth": "City" } } ] } }, "create_html_unilateral": { "summary": "Create from HTML - Unilateral Declaration", "value": { "title": "Unilateral HTML Declaration", "own_id": "MY-UNI-HTML-001", "html_content": "I hereby declare...
", "sign_now": true, "client_title": "Declarant", "is_one_sided": 1, "signer_count": 1, "has_expiration_date": false, "callback_url": "https://site.com/callback", "redirect_url": "https://site.com/redirect", "copy_to_email": "copy@example.com", "language": "hu", "hide_service_provider_details": false, "need_validation": 0, "partners": [] } } } } } }, "responses": { "200": { "description": "Contract created successfully.", "content": { "application/json": { "schema": { "required": [ "message", "contract" ], "properties": { "message": { "type": "string" }, "contract": { "$ref": "#/components/schemas/ContractDetail" } }, "type": "object" } } } }, "400": { "description": "Bad Request" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "You are not authorized for this operation (contracts:write)" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/contracts/{id}/download": { "get": { "tags": [ "Contract" ], "summary": "Download contract PDF", "description": "Downloads the generated PDF for a finalized contract. Requires 'contracts:read' ability.", "operationId": "downloadContract", "parameters": [ { "name": "id", "in": "path", "description": "Contract ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful download", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Contract not found" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Unauthorized or contract not finalized OR You are not authorized for this operation (contracts:read)" } }, "type": "object" } } } } }, "security": [ { "sanctum": [ "contracts:read" ] } ] } }, "/api/agent/contracts/shared-link": { "post": { "tags": [ "Contract" ], "summary": "Create a shared link", "description": "Generates a shared link for a contract. Requires 'contracts:write' ability.", "operationId": "createSharedLink", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "contract_id", "email_address", "lifetime" ], "properties": { "contract_id": { "description": "Contract ID", "type": "integer" }, "email_address": { "description": "Recipient Email", "type": "string", "format": "email" }, "lifetime": { "description": "Lifetime in minutes (>= 0)", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Shared link creation result.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "required": [ "success" ], "properties": { "success": { "description": "Whether the shared link was created.", "type": "boolean" } }, "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } }, "403": { "description": "Forbidden" } }, "security": [ { "sanctum": [ "contracts:write" ] } ] } }, "/api/agent/contracts/{id}/shared-links": { "get": { "tags": [ "Contract" ], "summary": "List shared links", "description": "Lists active shared links for a contract. Requires 'contracts:read' ability.", "operationId": "listSharedLinks", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Shared links retrieved.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "type": "array", "items": { "required": [ "id", "email_address", "created_at", "available_at", "delete" ], "properties": { "id": { "type": "integer" }, "email_address": { "type": "string" }, "created_at": { "type": "string", "nullable": true }, "available_at": { "type": "string", "nullable": true }, "delete": { "description": "Shared link ID used for deletion.", "type": "integer" } }, "type": "object" } }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [ "contracts:read" ] } ] } }, "/api/agent/contracts/shared-link/{link_id}": { "delete": { "tags": [ "Contract" ], "summary": "Delete a shared link", "description": "Deletes a specific shared link. Requires 'contracts:write' ability.", "operationId": "deleteSharedLink", "parameters": [ { "name": "link_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contract_id", "in": "query", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Shared link deleted.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "required": [ "success" ], "properties": { "success": { "type": "boolean", "enum": [ true ] } }, "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } }, "404": { "description": "Link not found" } }, "security": [ { "sanctum": [ "contracts:write" ] } ] } }, "/api/agent/contracts/{id}/ai-call": { "post": { "tags": [ "Contract" ], "summary": "Trigger an AI phone call to the partner", "description": "Initiates an AI-powered outbound call to the contract's pending partner.\nConditions:\n- The caller must be the contract owner.\n- The contract must have a pending (unsigned) invitation (status=0).\n- The partner must have a valid phone number (min. 7 digits) – checked in user profile, direct DB columns, and meta_fields JSON.\n- At most one call per contract per calendar day.\n- 4 credits (timestamps) are deducted on success.\n- Requires 'contracts:write' ability.", "operationId": "aiCall", "parameters": [ { "name": "id", "in": "path", "description": "Contract ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "ai_instructions": { "description": "Optional custom instructions for the AI assistant. If provided, this value is saved to the contract and used in the call (overrides previously stored instructions). E.g.: 'The partner already signed verbally, just needs to confirm digitally.'", "type": "string", "example": "A partner verbálisan már beleegyezett, csak formailag kell aláírnia.", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "AI call started", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "required": [ "phone", "credits_remaining" ], "properties": { "phone": { "type": "string" }, "credits_remaining": { "type": "integer" } }, "type": "object" }, "message": { "type": "string" } }, "type": "object" } } } }, "402": { "description": "Insufficient credits", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Insufficient timestamps (minimum 4 required)." } }, "type": "object" } } } }, "403": { "description": "Forbidden / wrong status", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "AI calls can only be triggered on pending contracts." } }, "type": "object" } } } }, "404": { "description": "Contract / invite not found", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "Contract not found or access denied" } }, "type": "object" } } } }, "422": { "description": "No phone / no invite", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "The partner has no phone number on record." } }, "type": "object" } } } }, "429": { "description": "Daily limit reached", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "An AI call was already triggered today for this contract. Try again tomorrow." } }, "type": "object" } } } }, "503": { "description": "AI temporarily disabled", "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "error" }, "message": { "type": "string", "example": "AI phone calls are currently unavailable." } }, "type": "object" } } } } }, "security": [ { "sanctum": [ "contracts:write" ] } ] } }, "/api/agent/contract-status": { "get": { "tags": [ "Contract Status" ], "summary": "List contract statuses", "description": "Lists your custom contract statuses. Requires statuses:read.", "operationId": "contractStatusList", "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgentContractStatusRecord" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (statuses:read)" } }, "type": "object" }, { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "No rights to custom status" } }, "type": "object" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentContractStatusError" } } } }, "500": { "description": "Unable to check access.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentContractStatusError" } } } } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Contract Status" ], "summary": "Create contract status", "description": "Creates a custom contract status. Requires statuses:write.", "operationId": "contractStatusStore", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "color" ], "properties": { "name": { "description": "Required status name, unique within the current account.", "type": "string" }, "color": { "description": "Status color.", "type": "string", "example": "#3498db" }, "email_to": { "description": "Notification email. Omitted values clear it.", "type": "string", "format": "email", "nullable": true }, "email_subject": { "description": "Email subject. Omitted values clear it.", "type": "string", "nullable": true }, "email_body": { "description": "Email body. Omitted values clear it.", "type": "string", "nullable": true }, "is_default": { "description": "Makes this the default status.", "type": "boolean" }, "permissions": { "description": "Permission IDs to assign.", "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AgentContractStatusRecord" } }, "type": "object" } } } }, "400": { "description": "Invalid status details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentContractStatusValidationError" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (statuses:write)" } }, "type": "object" }, { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "No rights to custom status" } }, "type": "object" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentContractStatusError" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/contract-status/{id}": { "put": { "tags": [ "Contract Status" ], "summary": "Update contract status", "description": "Updates a custom contract status. Requires statuses:write.", "operationId": "contractStatusUpdate", "parameters": [ { "name": "id", "in": "path", "description": "Status ID.", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "name", "color" ], "properties": { "name": { "description": "Required status name, unique within the current account excluding this status.", "type": "string" }, "color": { "description": "Status color.", "type": "string", "example": "#3498db" }, "email_to": { "description": "Notification email. Omitted values clear it.", "type": "string", "format": "email", "nullable": true }, "email_subject": { "description": "Email subject. Omitted values clear it.", "type": "string", "nullable": true }, "email_body": { "description": "Email body. Omitted values clear it.", "type": "string", "nullable": true }, "is_default": { "description": "Makes this the default status.", "type": "boolean" }, "permissions": { "description": "Permission IDs to assign. Omitted or empty removes assignments.", "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/AgentContractStatusRecord" } }, "type": "object" } } } }, "400": { "description": "Invalid status details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentContractStatusValidationError" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (statuses:write)" } }, "type": "object" }, { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "No rights to custom status" } }, "type": "object" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" } ] } } } }, "404": { "description": "Status not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentContractStatusNestedError" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentContractStatusError" } } } } }, "security": [ { "sanctum": [] } ] }, "delete": { "tags": [ "Contract Status" ], "summary": "Delete contract status", "description": "Deletes a custom contract status. Requires statuses:write.", "operationId": "contractStatusDestroy", "parameters": [ { "name": "id", "in": "path", "description": "Status ID.", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Deleted successfully" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (statuses:write)" } }, "type": "object" }, { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "No rights to custom status" } }, "type": "object" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" } ] } } } }, "404": { "description": "Status not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentContractStatusNestedError" } } } }, "422": { "description": "Status cannot be deleted because it is used by a manual transition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentContractStatusNestedError" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentContractStatusError" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/coworkers": { "get": { "tags": [ "Coworker" ], "summary": "List coworkers", "description": "Lists coworkers in the current account, excluding the account owner. Requires coworkers:read.", "operationId": "getCoworkers", "responses": { "200": { "description": "Coworker list, or an empty array.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgentCoworkerRecord" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (coworkers:read)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "description": "Localized firewall block message.", "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Coworker" ], "summary": "Add or update a coworker", "description": "Adds a coworker by email or updates their account access settings. Requires coworkers:write.", "operationId": "storeCoworker", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email", "name", "position" ], "properties": { "email": { "type": "string", "format": "email", "example": "coworker@example.com" }, "name": { "type": "string", "example": "John Doe" }, "position": { "type": "string", "example": "Developer" }, "create_templates": { "description": "0 or 1; omitted values reset to 0. When set to 1, the coworker can create contract templates.", "type": "integer", "example": 1, "default": 0 }, "make_contract": { "description": "0 or 1; omitted values reset to 0. When set to 1, the coworker can create contracts.", "type": "integer", "example": 1, "default": 0 }, "only_draft_contract": { "description": "When set to 1, the coworker can only create draft contracts. Omitted values reset to 0.", "type": "integer", "example": 1, "default": 0 }, "download_orders_invoices": { "description": "0 or 1; omitted values reset to 0. When set to 1, the coworker can download invoices.", "type": "integer", "example": 1, "default": 0 }, "excel_export": { "description": "0 or 1; omitted values reset to 0. When set to 1, the coworker can export data.", "type": "integer", "example": 1, "default": 0 }, "integration_access": { "description": "0 or 1; omitted values reset to 0. When set to 1, the coworker can access the XML API documentation.", "type": "integer", "example": 1, "default": 0 }, "contract_branding": { "description": "0 or 1; omitted values reset to 0. When set to 1, the coworker can edit the branding settings.", "type": "integer", "example": 1, "default": 0 }, "create_contracts": { "description": "1 allows access beyond own contracts; 0 restricts access to own contracts. Defaults to 0, including on update.", "type": "integer", "example": 1, "default": 0 }, "sign_contracts": { "description": "0 or 1; omitted values reset to 0. When set to 1, the coworker can act on behalf of the main account and sign documents.", "type": "integer", "example": 1, "default": 0 }, "permission": { "description": "0 or 1; omitted values reset to 0. When set to 1, the coworker is restricted according to their assigned permissions.", "type": "integer", "example": 1, "default": 0 }, "edit_permission": { "description": "0 or 1; omitted values reset to 0. When set to 1, the coworker can edit the permissions assigned to other coworkers.", "type": "integer", "example": 1, "default": 0 }, "manage_internal_statuses": { "description": "0 or 1; omitted values reset to 0. When set to 1, the coworker can manage internal statuses.", "type": "integer", "example": 1, "default": 0 }, "delete_contracts": { "description": "Allows contract deletion for existing users only.", "type": "integer", "example": 1, "default": 0 }, "manage_co_accounts": { "description": "0 or 1; omitted values reset to 0. When set to 1, the coworker can manage other coworkers.", "type": "integer", "example": 1, "default": 0 }, "use_position_instead_of_delegate": { "description": "0 or 1; omitted values reset to 0. When set to 1, the position title replaces the default delegate text on contracts handled by this coworker.", "type": "integer", "example": 1, "default": 0 }, "permissions": { "description": "Comma-separated permission titles. Omitting this field or leaving it empty clears the assignments; unknown titles are ignored. These permissions restrict the coworker when permission is set to 1.", "type": "string", "example": "Sales,Finance", "default": "" } }, "type": "object" } } } }, "responses": { "200": { "description": "Coworker added or updated.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "type": "string", "nullable": true, "enum": [ null ] }, "message": { "type": "string", "example": "Coworker successfully added" } }, "type": "object" } } } }, "400": { "description": "Invalid request or coworkers are not allowed on this account.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AgentCoworkerValidationError" }, { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Max coworker limit reached" } }, "type": "object" } ] } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (coworkers:write)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "description": "Localized firewall block message.", "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Coworker could not be saved.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Error on save" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] }, "delete": { "tags": [ "Coworker" ], "summary": "Remove a coworker", "description": "Removes a coworker from the current account by email. Requires coworkers:write.", "operationId": "deleteCoworker", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email", "example": "coworker@example.com" } }, "type": "object" } } } }, "responses": { "200": { "description": "Coworker removed.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "type": "string", "nullable": true, "enum": [ null ] }, "message": { "type": "string", "example": "Coworker successfully removed" } }, "type": "object" } } } }, "400": { "description": "Validation failed, user not found, or user not in the current account.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AgentCoworkerValidationError" }, { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Coworker not found" } }, "type": "object" }, { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Coworker not found in your group" } }, "type": "object" } ] } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (coworkers:write)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "description": "Localized firewall block message.", "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Coworker could not be removed.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Error on save" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/partners": { "get": { "tags": [ "Partners" ], "summary": "List partners", "description": "Lists your contract partners. Requires partners:read.", "operationId": "partners", "parameters": [ { "name": "term", "in": "query", "description": "Search by name, email or company name.", "required": false, "schema": { "type": "string", "nullable": true } } ], "responses": { "200": { "description": "Partner list, or an empty array when no partners match.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "required": [ "id", "name", "email", "phone", "company_name", "company_residence", "company_tax_number", "address", "mothers_name", "personal_id_number", "birthday", "place_of_birth" ], "properties": { "id": { "type": "integer", "example": 101 }, "name": { "type": "string", "example": "Kovács Béla", "nullable": true }, "email": { "type": "string", "format": "email", "example": "bela.kovacs@example.com" }, "phone": { "type": "string", "example": "+36301234567", "nullable": true }, "company_name": { "type": "string", "example": "Kovács Kft.", "nullable": true }, "company_residence": { "type": "string", "example": "1051 Budapest, Fő utca 1.", "nullable": true }, "company_tax_number": { "type": "string", "example": "12345678-1-41", "nullable": true }, "address": { "type": "string", "example": "1111 Budapest, Mellék utca 2.", "nullable": true }, "mothers_name": { "type": "string", "example": "Nagy Anna", "nullable": true }, "personal_id_number": { "type": "string", "example": "123456AB", "nullable": true }, "birthday": { "type": "string", "format": "date", "example": "1980-01-01", "nullable": true }, "place_of_birth": { "type": "string", "example": "Debrecen", "nullable": true } }, "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Invalid search term.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "required": [ "term" ], "properties": { "term": { "type": "array", "items": { "type": "string" }, "example": [ "The term must be a string." ] } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (partners:read)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "description": "Localized firewall block message.", "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/templates": { "get": { "tags": [ "Templates" ], "summary": "List templates", "description": "Lists available contract templates. Requires templates:read.", "operationId": "templates", "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "required": [ "templates" ], "properties": { "templates": { "type": "array", "items": { "required": [ "id", "name", "language" ], "properties": { "id": { "type": "string", "example": "123" }, "name": { "type": "string", "nullable": true }, "language": { "type": "string", "example": "hu", "nullable": true } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated. Use Accept: application/json for JSON errors.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (templates:read)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Templates" ], "summary": "Create a template", "description": "Creates a contract template. Requires templates:write.", "operationId": "createTemplate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "title" ], "properties": { "title": { "type": "string", "example": "Contract Template" }, "client_title": { "type": "string", "example": "Client", "nullable": true }, "trustee_title": { "type": "string", "example": "Service Provider", "nullable": true }, "template_content": { "type": "string", "example": "HTML content here...", "nullable": true }, "template_intro": { "type": "string", "example": "Introduction text...", "nullable": true }, "lang": { "type": "string", "example": "hu", "nullable": true, "maxLength": 2, "minLength": 2 }, "signer_count": { "type": "integer", "example": 2, "nullable": true, "minimum": 1 }, "single_signature": { "type": "boolean", "example": false, "nullable": true }, "allowed_user": { "type": "integer", "example": 0, "nullable": true }, "partner_3_title": { "type": "string", "example": "Guarantor" }, "partner_4_title": { "type": "string", "example": "Witness" } }, "type": "object" }, "examples": { "1_Unilateral": { "summary": "Unified Declaration (Unilateral - 1 Party)", "value": { "title": "Strict Confidentiality Declaration 2026", "single_signature": true, "signer_count": 1, "client_title": "Declarant", "template_intro": "Undersigned, as Declarant, I hereby declare...", "template_content": "Participants in the project:
...", "lang": "en" } } } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "required": [ "template_id" ], "properties": { "template_id": { "type": "string", "example": "123" } }, "type": "object" }, "message": { "type": "string", "example": "Successfully created!" } }, "type": "object" } } } }, "400": { "description": "Invalid request or operation not allowed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AgentTemplateValidationError" }, { "$ref": "#/components/schemas/AgentTemplateError" } ] } } } }, "401": { "description": "Unauthenticated. Use Accept: application/json for JSON errors.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (templates:write)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Operation failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/templates/{id}": { "get": { "tags": [ "Templates" ], "summary": "Get template details", "description": "Returns the contract details and variables for a template. Requires templates:read.", "operationId": "template", "parameters": [ { "name": "id", "in": "path", "description": "Template ID or html, html-single, html-more, pdf, pdf-single, pdf-more, custom-contract-type.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "required": [ "head_for_contract", "contract_variables" ], "properties": { "head_for_contract": { "description": "Contract details and recipient email fields.", "required": [ "type_of_contract", "subject_of_contract", "accompanying_message", "receiver_email", "own_id" ], "properties": { "type_of_contract": { "type": "string", "example": "123" }, "subject_of_contract": { "type": "string", "example": "Enter Subject Here" }, "accompanying_message": { "type": "string", "example": "" }, "receiver_email": { "type": "string", "example": "email@example.com" }, "own_id": { "type": "string", "example": "" } }, "type": "object", "additionalProperties": { "type": "string" } }, "contract_variables": { "type": "array", "items": { "required": [ "name", "description", "value" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "string", "example": "" } }, "type": "object" } } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated. Use Accept: application/json for JSON errors.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (templates:read)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" } ] } } } }, "404": { "description": "Template or field not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateRawError" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] }, "put": { "tags": [ "Templates" ], "summary": "Update a template", "description": "Updates a contract template. Requires templates:write.", "operationId": "updateTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "title" ], "properties": { "title": { "type": "string", "example": "My Updated Contract Template" }, "client_title": { "type": "string", "example": "Client", "nullable": true }, "trustee_title": { "type": "string", "example": "Service Provider", "nullable": true }, "template_content": { "type": "string", "example": "Updated HTML content...", "nullable": true }, "template_intro": { "type": "string", "example": "Updated Introduction text...", "nullable": true }, "lang": { "type": "string", "example": "hu", "nullable": true, "maxLength": 2, "minLength": 2 }, "signer_count": { "type": "integer", "example": 2, "nullable": true, "minimum": 1 }, "single_signature": { "type": "boolean", "example": false, "nullable": true }, "allowed_user": { "type": "integer", "example": 0, "nullable": true }, "partner_3_title": { "type": "string", "example": "Guarantor" }, "partner_4_title": { "type": "string", "example": "Witness" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Successfully updated!" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Invalid request or operation not allowed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AgentTemplateValidationError" }, { "$ref": "#/components/schemas/AgentTemplateError" }, { "$ref": "#/components/schemas/AgentTemplateRawError" } ] } } } }, "401": { "description": "Unauthenticated. Use Accept: application/json for JSON errors.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (templates:write)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" } ] } } } }, "404": { "description": "Template or field not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateRawError" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Operation failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } } }, "security": [ { "sanctum": [] } ] }, "delete": { "tags": [ "Templates" ], "summary": "Delete a template", "description": "Deletes a template that is not used by any contract. Requires templates:write.", "operationId": "deleteTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [] } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "type": "string", "nullable": true, "enum": [ null ] }, "message": { "type": "string", "example": "Successfully deleted!" } }, "type": "object" } } } }, "400": { "description": "Invalid request or operation not allowed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateRawError" } } } }, "401": { "description": "Unauthenticated. Use Accept: application/json for JSON errors.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (templates:write)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" } ] } } } }, "404": { "description": "Template or field not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateRawError" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Operation failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/templates/{id}/archive": { "post": { "tags": [ "Templates" ], "summary": "Archive or restore a template", "description": "Archives a template or restores it from the archive. Requires templates:write.", "operationId": "archiveTemplate", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "is_archive" ], "properties": { "is_archive": { "description": "True to archive, False to restore", "type": "boolean", "example": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "type": "string", "nullable": true, "enum": [ null ] }, "message": { "type": "string", "example": "Successfully updated!" } }, "type": "object" } } } }, "400": { "description": "Invalid request or operation not allowed.", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/AgentTemplateValidationError" }, { "$ref": "#/components/schemas/AgentTemplateRawError" } ] } } } }, "401": { "description": "Unauthenticated. Use Accept: application/json for JSON errors.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (templates:write)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" } ] } } } }, "404": { "description": "Template or field not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateRawError" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Operation failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/templates/{id}/fields": { "get": { "tags": [ "Templates" ], "summary": "List template fields", "description": "Lists the fields in a template. Requires templates:read.", "operationId": "indexFields", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/AgentTemplateListedField" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated. Use Accept: application/json for JSON errors.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (templates:read)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Templates" ], "summary": "Add a template field", "description": "Adds a field to a template. Requires templates:write.", "operationId": "storeField", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "field_title", "field_type" ], "properties": { "field_title": { "description": "Label of the field", "type": "string" }, "field_type": { "description": "Field type name or numeric code.", "oneOf": [ { "type": "string", "example": "text" }, { "type": "integer", "example": 1 } ] }, "options": { "description": "Required for select and recipient_select. Choices as text lines or an array.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "type": "object" }, "examples": { "text": { "summary": "Single-line text field", "value": { "field_title": "Full Name", "field_type": "text" } }, "textarea": { "summary": "Multi-line text box", "value": { "field_title": "Comments", "field_type": "textarea" } }, "attachment": { "summary": "Attachment (png, jpg, jpeg)", "value": { "field_title": "ID Card Scan", "field_type": "attachment" } }, "recipient_input": { "summary": "Filled by receiving party", "value": { "field_title": "Recipient Name", "field_type": "recipient_input" } }, "recipient_attachment": { "summary": "Attachment filled by receiving party", "value": { "field_title": "Signed Doc", "field_type": "recipient_attachment" } }, "heading": { "summary": "Heading", "value": { "field_title": "Personal Details", "field_type": "heading" } }, "separator": { "summary": "Separator line", "value": { "field_title": "Separator", "field_type": "separator" } }, "checkbox": { "summary": "Checkbox field", "value": { "field_title": "I agree", "field_type": "checkbox" } }, "select": { "summary": "Dropdown list", "value": { "field_title": "Choose Color", "field_type": "select", "options": "Red\\nGreen\\nBlue" } }, "recipient_select": { "summary": "Dropdown list filled by receiving party", "value": { "field_title": "Payment Method", "field_type": "recipient_select", "options": "Card\\nCash" } } } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "required": [ "field" ], "properties": { "field": { "$ref": "#/components/schemas/AgentTemplateSavedField" } }, "type": "object" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated. Use Accept: application/json for JSON errors.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (templates:write)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" } ] } } } }, "422": { "description": "Invalid field details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateFieldValidationError" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Operation failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/templates/{id}/fields/{field_id}": { "put": { "tags": [ "Templates" ], "summary": "Update a template field", "description": "Updates a field in a template. Requires templates:write.", "operationId": "updateField", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "field_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "field_title", "field_type" ], "properties": { "field_title": { "description": "Label of the field", "type": "string" }, "field_type": { "description": "Field type name or numeric code.", "oneOf": [ { "type": "string", "example": "text" }, { "type": "integer", "example": 1 } ] }, "options": { "description": "Required for select and recipient_select. Choices as text lines or an array.", "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } }, "type": "object" }, "examples": { "text": { "summary": "Single-line text field", "value": { "field_title": "Full Name", "field_type": "text" } }, "textarea": { "summary": "Multi-line text box", "value": { "field_title": "Comments", "field_type": "textarea" } }, "attachment": { "summary": "Attachment (png, jpg, jpeg)", "value": { "field_title": "ID Card Scan", "field_type": "attachment" } }, "recipient_input": { "summary": "Filled by receiving party", "value": { "field_title": "Recipient Name", "field_type": "recipient_input" } }, "recipient_attachment": { "summary": "Attachment filled by receiving party", "value": { "field_title": "Signed Doc", "field_type": "recipient_attachment" } }, "heading": { "summary": "Heading", "value": { "field_title": "Personal Details", "field_type": "heading" } }, "separator": { "summary": "Separator line", "value": { "field_title": "Separator", "field_type": "separator" } }, "checkbox": { "summary": "Checkbox field", "value": { "field_title": "I agree", "field_type": "checkbox" } }, "select": { "summary": "Dropdown list", "value": { "field_title": "Choose Color", "field_type": "select", "options": "Red\\nGreen\\nBlue" } }, "recipient_select": { "summary": "Dropdown list filled by receiving party", "value": { "field_title": "Payment Method", "field_type": "recipient_select", "options": "Card\\nCash" } } } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "required": [ "field" ], "properties": { "field": { "$ref": "#/components/schemas/AgentTemplateSavedField" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Invalid request or operation not allowed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } }, "401": { "description": "Unauthenticated. Use Accept: application/json for JSON errors.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (templates:write)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" } ] } } } }, "404": { "description": "Template or field not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } }, "422": { "description": "Invalid field details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateFieldValidationError" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Operation failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } } }, "security": [ { "sanctum": [] } ] }, "delete": { "tags": [ "Templates" ], "summary": "Delete a template field", "description": "Deletes a field from a template. Requires templates:write.", "operationId": "destroyField", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "field_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "type": "string", "nullable": true, "enum": [ null ] }, "message": { "type": "string", "example": "Price field successfully deleted!" } }, "type": "object" } } } }, "400": { "description": "Invalid request or operation not allowed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } }, "401": { "description": "Unauthenticated. Use Accept: application/json for JSON errors.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (templates:write)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" } ] } } } }, "404": { "description": "Template or field not found.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } }, "500": { "description": "Operation failed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/templates/{id}/reorder-fields": { "post": { "tags": [ "Templates" ], "summary": "Reorder template fields", "description": "Changes the order of fields in a template. Requires templates:write.", "operationId": "reorderFields", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "id" ], "properties": { "id": { "description": "Array of field IDs in order", "type": "array", "items": { "type": "integer" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "type": "string", "nullable": true, "enum": [ null ] }, "message": { "type": "string" } }, "type": "object" } } } }, "400": { "description": "Invalid request or operation not allowed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgentTemplateError" } } } }, "401": { "description": "Unauthenticated. Use Accept: application/json for JSON errors.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access denied.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (templates:write)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/3rd-party/registration": { "post": { "tags": [ "ThirdParty" ], "summary": "Register a partner", "description": "Creates a partner account and returns its login link.", "operationId": "thirdPartyRegister", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "partner_data" ], "properties": { "registration_header": { "properties": { "coupon_code": { "type": "string", "nullable": true }, "clone_account": { "description": "Copy templates and branding from an existing account.", "type": "string", "nullable": true, "enum": [ "yes", "no" ] }, "cloned_account_user_id": { "description": "Source account ID. Required when clone_account is yes.", "example": 123, "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "cloned_account_secret_key": { "description": "Source account secret key. Required when clone_account is yes.", "type": "string" } }, "type": "object" }, "partner_data": { "required": [ "partner_type", "email", "signatory_name" ], "properties": { "partner_type": { "description": "1: Individual; 2: Company.", "oneOf": [ { "type": "integer", "enum": [ 1, 2 ] }, { "type": "string", "enum": [ "1", "2" ] } ] }, "email": { "description": "Email address for the new account.", "type": "string", "format": "email" }, "signatory_name": { "type": "string" }, "phone_number": { "description": "Required for individuals.", "type": "string" }, "address": { "description": "Required for individuals.", "type": "string" }, "mothers_name": { "description": "Required for individuals.", "type": "string" }, "birthday": { "description": "Required for individuals.", "type": "string" }, "place_of_birth": { "description": "Required for individuals.", "type": "string" }, "company_name": { "description": "Required for companies.", "type": "string" }, "company_tax_number": { "description": "Required for companies.", "type": "string" }, "company_registered_office": { "description": "Required for companies.", "type": "string" }, "language": { "type": "string", "nullable": true, "default": "hu", "maxLength": 2 } }, "type": "object", "oneOf": [ { "required": [ "phone_number", "address", "mothers_name", "birthday", "place_of_birth" ], "properties": { "partner_type": { "enum": [ 1, "1" ] } }, "type": "object" }, { "required": [ "company_name", "company_tax_number", "company_registered_office" ], "properties": { "partner_type": { "enum": [ 2, "2" ] } }, "type": "object" } ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Partner registered.", "content": { "application/json": { "schema": { "required": [ "user_id", "otp_link", "subscription_expiry_date", "timestamps" ], "properties": { "user_id": { "type": "integer", "example": 123 }, "otp_link": { "type": "string", "format": "uri", "example": "https://example.com/otp/token/123" }, "subscription_expiry_date": { "description": "Subscription expiry date.", "type": "string", "example": null, "nullable": true }, "timestamps": { "description": "Available timestamp credits.", "type": "string", "example": "0" } }, "type": "object" } } } }, "400": { "description": "Invalid registration details, coupon, or account cloning credentials.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "description": "Validation message, the-user-already-exists, incomplete-registration-fields, non-existent-coupon, or incorrect-clode-account-userid-or-secretkey.", "type": "string", "example": "the-user-already-exists" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Requires active membership, third-party access, and the 3rd-party:registration ability. Access may also be blocked by IP restrictions.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Nincs API jogosultsága! (Missing 3rd-party:registration)", "enum": [ "Nincs aktív tagság! - Nem tud beküldeni API-t, mert nem aktív az előfizetése.", "Nem engedélyezett művelet! (Missing _3rt_api)", "Nincs API jogosultsága! (Missing 3rd-party:registration)" ] } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "description": "Localized access denial message.", "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "description": "Localized rate limit message.", "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/3rd-party/otp": { "post": { "tags": [ "ThirdParty" ], "summary": "Create a login link", "description": "Creates a login link for a user.", "operationId": "thirdPartyOtp", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "otp_account_user_id" ], "properties": { "otp_account_user_id": { "description": "User to generate a login link for.", "example": 123, "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "otp_link_key": { "description": "Optional verification key.", "type": "string", "nullable": true }, "contract_identifier": { "description": "Optional contract to open after login.", "type": "string", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Login link created.", "content": { "application/json": { "schema": { "required": [ "user_id", "otp_link", "subscription_expiry_date", "timestamps" ], "properties": { "user_id": { "type": "integer", "example": 123 }, "otp_link": { "type": "string", "format": "uri", "example": "https://example.com/otp/token/123" }, "subscription_expiry_date": { "description": "Subscription expiry date.", "type": "string", "example": null, "nullable": true }, "timestamps": { "description": "Available timestamp credits.", "type": "integer", "example": 0 } }, "type": "object" } } } }, "400": { "description": "Missing or unknown user ID, or invalid verification key.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "incorrect-otp-account-userid" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Requires active membership, third-party access, and the 3rd-party:otp ability. Access may also be blocked by IP restrictions.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Nincs API jogosultsága! (Missing 3rd-party:otp)", "enum": [ "Nincs aktív tagság! - Nem tud beküldeni API-t, mert nem aktív az előfizetése.", "Nem engedélyezett művelet!", "Nincs API jogosultsága! (Missing 3rd-party:otp)" ] } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "description": "Localized access denial message.", "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "description": "Localized rate limit message.", "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/user-info": { "get": { "tags": [ "Users" ], "summary": "Get user information", "description": "Returns your profile, membership, credits, and branding settings.", "operationId": "userInfo", "responses": { "200": { "description": "User information returned.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/UserInfo" } }, "type": "object" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Requires user:read. Access may also be blocked by IP restrictions.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (user:read)" } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "description": "Localized access denial message.", "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "description": "Localized rate limit message.", "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/user/branding": { "post": { "tags": [ "Users" ], "summary": "Update account branding", "description": "Updates your account’s contract and email branding.", "operationId": "updateBranding", "requestBody": { "required": false, "content": { "multipart/form-data": { "schema": { "properties": { "contract_header_logo": { "description": "Header logo: PNG, BMP, or JPEG, up to 200 KB.", "type": "string", "format": "binary", "nullable": true }, "contract_email_header_image": { "description": "Email header image: PNG, BMP, or JPEG, up to 200 KB.", "type": "string", "format": "binary", "nullable": true }, "contract_background_image": { "description": "Contract background image: PNG, BMP, or JPEG, up to 300 KB.", "type": "string", "format": "binary", "nullable": true }, "contract_header_logo_enabled": { "type": "boolean" }, "contract_style_enabled": { "type": "boolean" }, "contract_email_heading_enabled": { "type": "boolean" }, "contract_email_edit_enabled": { "type": "boolean" }, "contract_header_color": { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ffffff", "nullable": true }, "contract_email_background_color": { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ffffff", "nullable": true }, "contract_background_color": { "type": "string", "pattern": "^#(?:[0-9a-fA-F]{3}){1,2}$", "example": "#ffffff", "nullable": true }, "contract_background_position": { "type": "integer", "nullable": true, "enum": [ 0, 1, 2, 3, 4, null ] }, "email_text": { "type": "string", "nullable": true, "maxLength": 5000 }, "contract_header_logo_url": { "description": "Header logo URL. An uploaded logo takes priority.", "type": "string", "format": "uri", "nullable": true, "maxLength": 1000 } }, "type": "object" } } } }, "responses": { "200": { "description": "Branding updated.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "type": "string", "nullable": true, "enum": [ null ] }, "message": { "type": "string", "example": "Branding updated successfully" } }, "type": "object" } } } }, "400": { "description": "Invalid branding settings or image upload.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "The email text must not be greater than 5000 characters." } }, "type": "object" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Requires user:write and permission to edit branding. Access may also be blocked by IP restrictions.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You are not authorized for this operation (user:write)" } }, "type": "object" }, { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "You do not have permission to modify branding settings." } }, "type": "object" }, { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "description": "Localized access denial message.", "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "description": "Localized rate limit message.", "type": "string" } }, "type": "object" } } } }, "500": { "description": "Could not save branding settings.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Error on save" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "List webhook subscriptions", "description": "Lists your active webhook subscriptions.", "operationId": "listWebhooks", "responses": { "200": { "description": "Active webhook subscriptions, or an empty list.", "content": { "application/json": { "schema": { "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "required": [ "id", "url", "events", "created_at" ], "properties": { "id": { "type": "integer", "example": 42 }, "url": { "type": "string", "format": "uri", "example": "https://example.com/webhook" }, "events": { "description": "Subscribed events. An asterisk means all events; an empty array means none.", "type": "array", "items": { "type": "string", "enum": [ "contract_signed", "contract_viewed", "contract_created", "email_delivered", "email_opened", "email_not_delivered", "invitation_accepted", "invitation_declined", "approval_approved", "approval_declined", "approval_revoked", "*" ] }, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2026-09-14T10:00:00.000000Z", "nullable": true } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access blocked by IP restrictions.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "description": "Localized access denial message.", "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "description": "Localized rate limit message.", "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] }, "post": { "tags": [ "Webhooks" ], "summary": "Register or update a webhook", "description": "Registers a webhook or updates its subscribed events.", "operationId": "registerWebhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "required": [ "url" ], "properties": { "url": { "description": "Webhook URL to receive events.", "type": "string", "format": "uri", "maxLength": 500 }, "events": { "description": "Omit or send null for all events. Send an empty array for no events.", "type": "array", "items": { "type": "string", "enum": [ "contract_signed", "contract_viewed", "contract_created", "email_delivered", "email_opened", "email_not_delivered", "invitation_accepted", "invitation_declined", "approval_approved", "approval_declined", "approval_revoked" ] }, "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Webhook registered or updated.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "data", "message" ], "properties": { "data": { "required": [ "id", "url", "events" ], "properties": { "id": { "type": "integer", "example": 42 }, "url": { "type": "string", "format": "uri", "example": "https://example.com/webhook" }, "events": { "description": "Subscribed events. An asterisk means all events; an empty array means none.", "type": "array", "items": { "type": "string", "enum": [ "contract_signed", "contract_viewed", "contract_created", "email_delivered", "email_opened", "email_not_delivered", "invitation_accepted", "invitation_declined", "approval_approved", "approval_declined", "approval_revoked", "*" ] } } }, "type": "object" }, "message": { "type": "string", "enum": [ "Webhook registered successfully" ] } }, "type": "object" }, { "required": [ "data", "message" ], "properties": { "data": { "required": [ "id", "url", "events", "user_id", "is_active", "failure_count", "last_triggered_at", "created_at", "updated_at" ], "properties": { "id": { "type": "integer", "example": 42 }, "url": { "type": "string", "format": "uri", "example": "https://example.com/webhook" }, "events": { "description": "Subscribed events. An asterisk means all events; an empty array means none.", "type": "array", "items": { "type": "string", "enum": [ "contract_signed", "contract_viewed", "contract_created", "email_delivered", "email_opened", "email_not_delivered", "invitation_accepted", "invitation_declined", "approval_approved", "approval_declined", "approval_revoked", "*" ] } }, "user_id": { "type": "integer", "example": 123 }, "is_active": { "type": "boolean", "enum": [ true ] }, "failure_count": { "type": "integer", "example": 0 }, "last_triggered_at": { "type": "string", "example": "2026-09-14 10:00:00", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2026-09-14T10:00:00.000000Z", "nullable": true }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-09-14T10:00:00.000000Z", "nullable": true } }, "type": "object" }, "message": { "type": "string", "enum": [ "Webhook updated successfully" ] } }, "type": "object" } ] } } } }, "400": { "description": "Invalid webhook details or the limit of 10 active subscriptions reached.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "description": "Validation errors keyed by field, such as url or events.0.", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object" }, { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Maximum 10 webhook subscriptions allowed per user." } }, "type": "object" } ] } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access blocked by IP restrictions.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "description": "Localized access denial message.", "type": "string" } }, "type": "object" } ] } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "description": "Localized rate limit message.", "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } }, "/api/agent/webhooks/{id}": { "delete": { "tags": [ "Webhooks" ], "summary": "Deactivate a webhook", "description": "Stops event notifications for a webhook subscription.", "operationId": "deleteWebhook", "parameters": [ { "name": "id", "in": "path", "description": "Webhook subscription ID.", "required": true, "schema": { "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "Webhook deactivated.", "content": { "application/json": { "schema": { "required": [ "data", "message" ], "properties": { "data": { "type": "string", "nullable": true, "enum": [ null ] }, "message": { "type": "string", "enum": [ "Webhook deleted successfully" ] } }, "type": "object" } } } }, "401": { "description": "Unauthenticated.", "content": { "application/json": { "schema": { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Unauthenticated." } }, "type": "object" } } } }, "403": { "description": "Access blocked by IP restrictions.", "content": { "application/json": { "schema": { "anyOf": [ { "required": [ "message" ], "properties": { "message": { "type": "string", "example": "Access denied from this IP address." } }, "type": "object" }, { "required": [ "error" ], "properties": { "error": { "description": "Localized access denial message.", "type": "string" } }, "type": "object" } ] } } } }, "404": { "description": "Webhook not found in your account.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string", "example": "Webhook not found" } }, "type": "object" } } } }, "429": { "description": "Too many requests.", "content": { "application/json": { "schema": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "description": "Localized rate limit message.", "type": "string" } }, "type": "object" } } } } }, "security": [ { "sanctum": [] } ] } } }, "components": { "schemas": { "AgentContractStatusRecord": { "description": "Custom contract status details.", "required": [ "id", "user_id", "name", "color", "email_to", "email_subject", "email_body", "created_at", "updated_at" ], "properties": { "id": { "type": "integer", "example": 12 }, "user_id": { "type": "integer", "nullable": true }, "name": { "type": "string", "example": "Under review", "nullable": true }, "color": { "type": "string", "example": "#3498db", "nullable": true }, "email_to": { "description": "Notification recipient email or partner position.", "type": "string", "nullable": true }, "email_subject": { "type": "string", "nullable": true }, "email_body": { "type": "string", "nullable": true }, "is_default": { "type": "boolean", "nullable": true }, "order": { "description": "Display order.", "type": "integer" }, "block_contract_owner_signature": { "type": "integer", "enum": [ 0, 1 ] }, "block_sending": { "type": "integer", "enum": [ 0, 1 ] }, "is_kanban_column": { "type": "integer", "enum": [ 0, 1 ] }, "restrict_manual_transitions": { "type": "boolean" }, "allowed_manual_transition_status_ids": { "type": "array", "items": { "type": "integer" }, "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "AgentContractStatusError": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" }, "AgentContractStatusNestedError": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "required": [ "message" ], "properties": { "message": { "type": "string" } }, "type": "object" } }, "type": "object" }, "AgentContractStatusValidationError": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "description": "Validation messages for each field.", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object" }, "AgentCoworkerRecord": { "required": [ "id", "email", "name", "position", "create_templates", "make_contract", "only_draft_contract", "download_orders_invoices", "excel_export", "integration_access", "contract_branding", "create_contracts", "sign_contracts", "permission", "edit_permission", "manage_internal_statuses", "delete_contracts", "manage_co_accounts", "use_position_instead_of_delegate", "permissions" ], "properties": { "id": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string", "nullable": true }, "position": { "type": "string", "nullable": true }, "create_templates": { "type": "integer", "nullable": true }, "make_contract": { "type": "integer", "nullable": true }, "only_draft_contract": { "type": "boolean", "nullable": true }, "download_orders_invoices": { "type": "integer", "nullable": true }, "excel_export": { "type": "integer", "nullable": true }, "integration_access": { "type": "integer", "nullable": true }, "contract_branding": { "type": "integer", "nullable": true }, "create_contracts": { "description": "1 allows access beyond own contracts; 0 restricts access to own contracts.", "type": "integer", "enum": [ 0, 1 ] }, "sign_contracts": { "type": "integer", "nullable": true }, "permission": { "type": "integer", "nullable": true }, "edit_permission": { "type": "integer", "nullable": true }, "manage_internal_statuses": { "type": "integer", "nullable": true }, "delete_contracts": { "type": "integer", "nullable": true }, "manage_co_accounts": { "type": "integer", "nullable": true }, "use_position_instead_of_delegate": { "type": "integer", "nullable": true }, "permissions": { "description": "Assigned permission titles.", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "AgentCoworkerValidationError": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "object", "example": { "email": [ "The email field is required." ] }, "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object" }, "ContractDetail": { "description": "Contract details.", "required": [ "identifier", "contract_title", "template_id", "template_name", "own_id", "contract_status", "inside_status", "language", "contract_signed", "status", "is_archived", "download_link", "number_of_participants", "contract_content_raw", "contract_content", "reference_number", "created_at", "last_modification", "declines", "internal_approvals", "parameters", "partners", "email_log", "event_log", "attachments", "share_with_external", "comments", "invites", "contract_public_url" ], "properties": { "identifier": { "type": "integer" }, "contract_title": { "type": "string", "nullable": true }, "template_id": { "type": "string" }, "template_name": { "type": "string", "nullable": true }, "own_id": { "type": "string", "nullable": true }, "contract_status": { "description": "Contract status code.", "type": "string", "enum": [ "draft", "contracts_awaiting_signature", "contracts_awaiting_for_confirmation", "signed_contracts", "archived_contract", "declined" ] }, "inside_status": { "description": "Internal status label, or an empty string.", "type": "string" }, "language": { "type": "string", "nullable": true }, "contract_signed": { "description": "Signing date and time, or an empty string.", "type": "string" }, "status": { "description": "Human-readable contract status.", "type": "string" }, "is_archived": { "type": "boolean" }, "download_link": { "description": "Download link for a finalized contract; otherwise null. May be empty if unavailable.", "type": "string", "nullable": true }, "number_of_participants": { "type": "integer" }, "contract_content_raw": { "type": "string", "nullable": true }, "contract_content": { "type": "string", "nullable": true }, "reference_number": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "last_modification": { "type": "string" }, "declines": { "type": "array", "items": { "$ref": "#/components/schemas/ContractDecline" } }, "internal_approvals": { "type": "array", "items": { "$ref": "#/components/schemas/ContractInternalApproval" } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ContractParameter" } }, "partners": { "type": "array", "items": { "$ref": "#/components/schemas/ContractPartner" } }, "email_log": { "type": "array", "items": { "$ref": "#/components/schemas/ContractEmailLog" } }, "event_log": { "type": "array", "items": { "$ref": "#/components/schemas/ContractEventLog" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/ContractAttachment" } }, "share_with_external": { "type": "array", "items": { "$ref": "#/components/schemas/ContractShare" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/ContractComment" } }, "invites": { "description": "Invitation links when public invitations are enabled; otherwise an empty array.", "type": "array", "items": { "$ref": "#/components/schemas/ContractInvite" } }, "contract_public_url": { "description": "Whether public invitations are enabled.", "type": "boolean" } }, "type": "object" }, "ContractParameter": { "required": [ "name", "data" ], "properties": { "name": { "type": "string", "nullable": true }, "data": { "type": "string", "nullable": true } }, "type": "object" }, "ContractPartner": { "required": [ "name", "client_title", "personal_id_number", "address", "phone", "company_name", "company_residence", "mothers_name", "company_tax_number", "email", "birthday", "place_of_birth", "signing_representative" ], "properties": { "name": { "type": "string", "nullable": true }, "client_title": { "type": "string", "nullable": true }, "personal_id_number": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "company_name": { "type": "string", "nullable": true }, "company_residence": { "type": "string", "nullable": true }, "mothers_name": { "type": "string", "nullable": true }, "company_tax_number": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "birthday": { "type": "string", "nullable": true }, "place_of_birth": { "type": "string", "nullable": true }, "signing_representative": { "description": "Representative who signed, or an empty array.", "anyOf": [ { "required": [ "email", "name", "user_id" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "integer" } }, "type": "object" }, { "type": "array", "items": { "type": "object" }, "maxItems": 0 } ] } }, "type": "object" }, "ContractEmailLog": { "required": [ "time", "who", "subject", "status", "opened", "clicked" ], "properties": { "time": { "type": "string" }, "who": { "type": "string", "nullable": true }, "subject": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "opened": { "description": "Event date and time, or null.", "type": "string", "nullable": true }, "clicked": { "description": "Event date and time, or null.", "type": "string", "nullable": true } }, "type": "object" }, "ContractEventLog": { "required": [ "time", "type", "event", "ip", "hash" ], "properties": { "time": { "type": "string" }, "type": { "type": "string", "nullable": true }, "event": { "type": "string", "nullable": true }, "ip": { "type": "string", "nullable": true }, "hash": { "type": "string", "nullable": true } }, "type": "object" }, "ContractAttachment": { "anyOf": [ { "required": [ "type", "attachment_id", "title", "invoice_type", "invoice_fulfillment_date", "invoice_due_date", "invoice_total", "invoice_currency", "access" ], "properties": { "type": { "type": "string", "enum": [ "invoice" ] }, "attachment_id": { "type": "integer" }, "title": { "type": "string" }, "invoice_type": { "type": "string" }, "invoice_fulfillment_date": { "type": "string" }, "invoice_due_date": { "type": "string" }, "invoice_total": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "invoice_currency": { "type": "string" }, "access": { "type": "string", "enum": [ "public" ] } }, "type": "object" }, { "required": [ "type", "attachment_id", "title", "attachment_contract_id", "contract_type", "created_at", "access" ], "properties": { "type": { "type": "string", "enum": [ "contract" ] }, "attachment_id": { "type": "integer" }, "title": { "type": "string", "nullable": true }, "attachment_contract_id": { "type": "integer" }, "contract_type": { "type": "string", "nullable": true }, "created_at": { "type": "string" }, "access": { "type": "string", "enum": [ "public", "private" ] } }, "type": "object" }, { "required": [ "type", "attachment_id", "title", "hyperlink_type", "description", "link", "visibility" ], "properties": { "type": { "type": "string", "enum": [ "hyperlink" ] }, "attachment_id": { "type": "integer" }, "title": { "type": "string", "nullable": true }, "hyperlink_type": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "link": { "type": "string", "nullable": true }, "visibility": { "type": "string", "enum": [ "public", "private" ] } }, "type": "object" }, { "required": [ "type", "attachment_id", "title", "status", "status_label", "canonical_id", "jurisdiction", "access" ], "properties": { "type": { "type": "string", "enum": [ "law" ] }, "attachment_id": { "type": "integer" }, "title": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "status_label": { "type": "string" }, "canonical_id": { "type": "string" }, "jurisdiction": { "type": "string" }, "access": { "type": "string", "enum": [ "public" ] } }, "type": "object" } ] }, "ContractShare": { "required": [ "email", "expiration" ], "properties": { "email": { "type": "string" }, "expiration": { "type": "string", "nullable": true } }, "type": "object" }, "ContractInvite": { "required": [ "email", "link" ], "properties": { "email": { "type": "string", "nullable": true }, "link": { "type": "string", "format": "uri" } }, "type": "object" }, "ContractListItem": { "required": [ "identifier", "contract_title", "template_id", "template_name", "own_id", "contract_status", "inside_status", "language", "contract_signed", "status", "is_archived", "download_link", "number_of_participants", "contract_created", "laws" ], "properties": { "identifier": { "type": "integer" }, "contract_title": { "type": "string", "nullable": true }, "template_id": { "type": "string" }, "template_name": { "type": "string", "nullable": true }, "own_id": { "type": "string", "nullable": true }, "contract_status": { "description": "Contract status code.", "type": "string", "enum": [ "draft", "contracts_awaiting_signature", "contracts_awaiting_for_confirmation", "signed_contracts", "archived_contract", "declined" ] }, "inside_status": { "description": "Internal status label, or an empty string.", "type": "string" }, "language": { "type": "string", "nullable": true }, "contract_signed": { "description": "Signing date and time, or an empty string.", "type": "string" }, "status": { "description": "Human-readable contract status.", "type": "string" }, "is_archived": { "type": "boolean" }, "download_link": { "description": "Download link for a finalized contract; otherwise null. May be empty if unavailable.", "type": "string", "nullable": true }, "number_of_participants": { "type": "integer" }, "contract_created": { "type": "string" }, "laws": { "type": "array", "items": { "$ref": "#/components/schemas/ContractLaw" } } }, "type": "object" }, "ContractDecline": { "required": [ "email", "declining_representative", "reason", "date" ], "properties": { "email": { "type": "string", "nullable": true }, "declining_representative": { "description": "Representative who declined, or an empty array.", "anyOf": [ { "required": [ "email", "name", "user_id" ], "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "integer", "nullable": true } }, "type": "object" }, { "type": "array", "items": { "type": "object" }, "maxItems": 0 } ] }, "reason": { "type": "string" }, "date": { "type": "string" } }, "type": "object" }, "ContractInternalApproval": { "required": [ "id", "name", "status", "is_approved", "is_declined", "approved_by", "approved_at", "declined_by", "declined_at", "decline_reason", "note" ], "properties": { "id": { "type": "integer" }, "name": { "type": "string", "nullable": true }, "status": { "type": "string", "enum": [ "pending", "approved", "declined" ] }, "is_approved": { "type": "boolean" }, "is_declined": { "type": "boolean" }, "approved_by": { "type": "string", "nullable": true }, "approved_at": { "type": "string", "nullable": true }, "declined_by": { "type": "string", "nullable": true }, "declined_at": { "type": "string", "nullable": true }, "decline_reason": { "type": "string", "nullable": true }, "note": { "type": "string", "nullable": true } }, "type": "object" }, "TemplateDetail": { "title": "Template Detail", "required": [ "head_for_contract", "contract_variables" ], "properties": { "head_for_contract": { "description": "Contract details and recipient email fields.", "required": [ "type_of_contract", "subject_of_contract", "accompanying_message", "receiver_email", "own_id" ], "properties": { "type_of_contract": { "type": "string" }, "subject_of_contract": { "type": "string" }, "accompanying_message": { "type": "string" }, "receiver_email": { "type": "string" }, "own_id": { "type": "string" } }, "type": "object", "additionalProperties": { "type": "string" } }, "contract_variables": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateVariable" } } }, "type": "object" }, "TemplateVariable": { "title": "Template Variable", "required": [ "name", "description", "value" ], "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "value": { "type": "string" } }, "type": "object" }, "ContractLaw": { "required": [ "id", "law_name", "status", "status_label", "canonical_id", "jurisdiction" ], "properties": { "id": { "type": "integer" }, "law_name": { "type": "string", "nullable": true }, "status": { "type": "string", "nullable": true }, "status_label": { "type": "string" }, "canonical_id": { "type": "string" }, "jurisdiction": { "type": "string" } }, "type": "object" }, "ContractComment": { "required": [ "id", "author", "content", "is_internal", "created_at" ], "properties": { "id": { "type": "integer" }, "author": { "type": "string", "nullable": true }, "content": { "type": "string", "nullable": true }, "is_internal": { "type": "boolean" }, "created_at": { "type": "string" } }, "type": "object" }, "ContractValidationError": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "description": "Validation errors keyed by field.", "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object" }, "ContractPage": { "required": [ "current_page", "data", "first_page_url", "from", "last_page", "last_page_url", "links", "next_page_url", "path", "per_page", "prev_page_url", "to", "total" ], "properties": { "current_page": { "type": "integer" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ContractListItem" } }, "first_page_url": { "type": "string" }, "from": { "type": "integer", "nullable": true }, "last_page": { "type": "integer" }, "last_page_url": { "type": "string" }, "links": { "type": "array", "items": { "required": [ "url", "label", "active" ], "properties": { "url": { "type": "string", "nullable": true }, "label": { "type": "string" }, "page": { "type": "integer", "nullable": true }, "active": { "type": "boolean" } }, "type": "object" } }, "next_page_url": { "type": "string", "nullable": true }, "path": { "type": "string" }, "per_page": { "type": "integer", "enum": [ 20 ] }, "prev_page_url": { "type": "string", "nullable": true }, "to": { "type": "integer", "nullable": true }, "total": { "type": "integer" } }, "type": "object" }, "AgentTemplateError": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" } }, "type": "object" }, "AgentTemplateRawError": { "required": [ "error" ], "properties": { "error": { "type": "string" } }, "type": "object" }, "AgentTemplateValidationError": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object" }, "AgentTemplateFieldValidationError": { "required": [ "status", "message" ], "properties": { "status": { "type": "string", "enum": [ "error" ] }, "message": { "type": "string" }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } }, "type": "object" }, "AgentTemplateListedField": { "required": [ "id", "title", "name", "field_type", "contract_type_id", "reorder", "options", "created_at", "updated_at", "field_type_name" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "name": { "type": "string" }, "field_type": { "description": "Field type code.", "type": "string", "example": "1" }, "contract_type_id": { "type": "integer" }, "reorder": { "type": "integer", "nullable": true }, "options": { "description": "Available choices as a JSON string.", "type": "string", "example": "[\"Red\",\"Blue\"]", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "field_type_name": { "type": "string", "example": "text" } }, "type": "object" }, "AgentTemplateSavedField": { "required": [ "id", "title", "name", "field_type", "contract_type_id", "reorder", "created_at", "updated_at" ], "properties": { "id": { "type": "integer" }, "title": { "type": "string" }, "name": { "type": "string" }, "field_type": { "description": "Field type name.", "type": "string", "example": "text" }, "contract_type_id": { "oneOf": [ { "type": "integer" }, { "type": "string" } ] }, "reorder": { "type": "integer", "nullable": true }, "options": { "description": "Available choices as a JSON string.", "type": "string", "example": "[\"Red\",\"Blue\"]", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "BrandingSettings": { "title": "Branding Settings", "required": [ "contract_header_logo_enabled", "contract_style_enabled", "contract_email_heading_enabled", "contract_email_edit_enabled", "email_text", "for_preview" ], "properties": { "contract_header_logo_enabled": { "type": "boolean" }, "contract_style_enabled": { "type": "boolean" }, "contract_email_heading_enabled": { "type": "boolean" }, "contract_email_edit_enabled": { "type": "boolean" }, "email_text": { "type": "string", "nullable": true }, "for_preview": { "type": "boolean", "enum": [ false ] }, "contract_header_logo": { "description": "Included when contract_header_logo_enabled is enabled.", "type": "string", "nullable": true }, "contract_header_color": { "description": "Included when contract_header_logo_enabled is enabled.", "type": "string", "nullable": true }, "contract_background_image": { "description": "Included when contract_style_enabled is enabled.", "type": "string", "nullable": true }, "contract_background_position": { "description": "Included when contract_style_enabled is enabled.", "type": "integer", "nullable": true }, "contract_background_color": { "description": "Included when contract_style_enabled is enabled.", "type": "string", "nullable": true }, "contract_email_background_color": { "description": "Included when contract_email_heading_enabled is enabled.", "type": "string", "nullable": true }, "contract_email_header_image": { "description": "Included when contract_email_heading_enabled is enabled.", "type": "string", "nullable": true } }, "type": "object" }, "UserInfo": { "title": "User Information", "required": [ "id", "name", "email", "membership", "credit", "membership_ends_at", "branding" ], "properties": { "id": { "type": "integer", "example": 42 }, "name": { "type": "string", "example": "Kovács János", "nullable": true }, "email": { "type": "string", "format": "email", "example": "janos.kovacs@example.com" }, "membership": { "type": "string", "example": "Premium Package" }, "credit": { "type": "integer", "example": 150 }, "membership_ends_at": { "type": "string", "example": "2026-12-31 23:59:59", "nullable": true }, "branding": { "$ref": "#/components/schemas/BrandingSettings" } }, "type": "object" } }, "securitySchemes": { "sanctum": { "type": "http", "scheme": "bearer" } } }, "tags": [ { "name": "Ai", "description": "Ai" }, { "name": "Contract", "description": "Contract" }, { "name": "Contract Status", "description": "Contract Status" }, { "name": "Coworker", "description": "Coworker" }, { "name": "Partners", "description": "Partners" }, { "name": "Templates", "description": "Templates" }, { "name": "ThirdParty", "description": "ThirdParty" }, { "name": "Users", "description": "Users" }, { "name": "Webhooks", "description": "Webhooks" } ] }