Vereinsantrag
Handbuch
DeveloperVereinsantrag.online
Handbuch
DeveloperVereinsantrag.online
  1. Developer
  • Wilkommen zu Vereinsantrag 🎉
  • Registrierung und Vereinsdaten
  • Mitgliedschaften und Abteilungen
  • Formulare konfigurieren und veröffentlichen
  • Formular Design
  • Weitere Felder hinzufĂŒgen
  • Datenschutz
  • Einstellungen
  • Arbeiten mit Online-AntrĂ€gen
    • Export
    • AntrĂ€ge korrigieren
    • Antrags-Historie
  • Developer
    • Welcome to the developer portal
    • Get your token
    • Rate-Limiting
    • API-Reference
      • Authentication
        • AuthenticationService
          • /auth/login
          • /auth/refresh
          • /auth/manage/info
          • /auth/manage/info
        • Users
          • Get all users for the current club (Admin only)
          • Create a new user in the current club without password - user receives email invitation (Admin only)
          • Get user by ID within the current club
          • Update user details within the current club
          • Delete a user from the current club (Admin only)
          • Resend password setup email to a user (Admin only)
          • Get available roles (Admin only)
      • Information about your club
        • Club
          • Gets the information of the club.
          • Changes the information of the club.
          • Gets the logo of the club.
          • Changes the logo of the club.
        • Department
          • Retrieves all departments for the current club.
          • Creates a new department.
          • Retrieves a specific department by its ID.
          • Deletes a specific department by its ID.
          • Modifies an existing department.
          • Retrieves the settings for the departments.
          • Updates the settings for the departments.
        • Forms
          • Get Membership Form
          • Modify Membership Form
          • Get Cancellation Form
          • Modify Cancellation Form
          • Get Form Design
          • Updates form Design
        • Membership
          • Retrieves all memberships for the current club.
          • Creates a new membership.
          • Retrieves a specific membership by its ID.
          • Deletes a specific membership by its ID.
          • Modifies an existing membership.
        • CustomField
          • Retrieves all custom fields for the current club.
          • Creates a new custom field.
          • Retrieves a specific custom field by its internal name.
          • Deletes a specific custom field by its internal name.
          • Partially modifies an existing custom field.
        • DataPrivacy
          • Retrieves the data privacy settings for the club.
          • Updates the data privacy settings for the club.
        • Settings
          • Get email template
          • Set email template
          • Reset email template
          • Get system email template
          • Get SMTP settings
          • Set SMTP settings
          • Test SMTP connection
          • Get available placeholders for email template
      • Submits
        • Cancellations
          • Get cancellation by id
          • Delete cancellation
          • Update cancellation submission
          • Create new cancellation
          • Get cancellation PDF
          • Get cancellation CSV
          • Export cancellation as text
          • Confirm cancellation
          • Resends the confirmation email for a cancellation application
          • Retrieves the history for a specific cancellation submission.
        • Changes
          • Create a new change request
          • Get change request by ID
          • Delete change request
          • Update change submission
          • Get change request PDF
          • Get change request CSV
          • Export change request as text
          • Confirm change request
          • Resends the confirmation email for a change membership application
          • Retrieves the history for a specific change submission.
        • Memberships
          • Creates a new membership application
          • Retrieves a membership application
          • Deletes a membership application
          • Update membership application
          • Exports a membership application as PDF
          • Exports a membership application as CSV
          • Exports a membership application as text
          • Exports a membership application as verein.cloudÂź CSV
          • Confirms a membership application
          • Resends the confirmation email for a membership application
          • Retrieves the history for a specific membership submission.
        • Submits
          • Retrieves all submissions.
          • Accepts a submission.
          • Denies a submission.
          • Starts a PDF export job
          • Downloads exported files as ZIP
          • Returns export job progress
          • Starts a CSV export job
          • Starts a verein.cloudÂź export job
      • Reporting
        • Dashboard
          • Gets the count of new memberships.
          • Gets the count of new changes.
          • Gets the count of new cancellations.
          • Gets the membership chart data.
  • Schemas
    • ChangeClubInfo
    • KpiCountResult
    • CancellationMode
    • BackgroundImageSettings
    • ChangeMembershipSchema
    • MembershipCountChartResult
    • CancellationPatchDto
    • BackgroundSettings
    • ChangeCustomFieldSchema
    • ClubInfo
    • CancellationSubmit
    • ClubLogo
    • CancellationSubmitPatchRequest
    • DepartmentSchema
    • CancellationSubmitResponse
    • ConsentMediaType
    • ChangePatchDto
    • CustomFieldCategory
    • DepartmentSettingsSchema
    • ChangeSubmitPatchRequest
    • CustomFieldSchema
    • File
    • ProblemDetails
    • ChangesSubmit
    • CustomFieldType
    • FormCancellation
    • FormMembership
    • CustomDesignSettings
    • DataPrivacySchema
    • CustomFieldPatchDto
    • MembershipSchema
    • ValidationProblemDetails
    • FamiliySubmit
    • FamilyMemberPatchDto
    • EMailTemplateType
    • Gender
    • MembershipPatchDto
    • MembershipPatchRequest
    • MembershipSubmit
    • GetEmailTemplateResponse
    • MembershipSubmitResponse
    • PaymentMethod
    • FormDesign
    • SetEmailTemplateRequest
    • StartExportJobRequest
    • SubmitAcceptRequest
    • SmtpSettingsReadDto
    • MembershipPriceInterval
    • SubmitDenyRequest
    • SmtpSettingsWriteDto
    • SmtpTestResultDto
    • SubmitHistoryResponse
    • SubmitHistoryType
    • PlaceholderCategory
    • PatchCustomFieldSchema
    • PlaceholderDataType
    • SubmitResponse
    • PlaceholderDefinition
    • SubmitState
Handbuch
DeveloperVereinsantrag.online
Handbuch
DeveloperVereinsantrag.online
  1. Developer

Rate-Limiting

To ensure fair usage and protect the performance of the Vereinsantrag platform, we enforce rate limiting for all incoming API requests.

⏱ Rate Limit Policy#

Each client is subject to the following limits:
20 concurrent requests (max number of requests handled simultaneously)
2,000 requests per 10-minute window
These rules apply globally and are automatically enforced by the system.

Limit TypeValue
Concurrent Requests20
Fixed Window Limit2,000 requests per 10 minutes

đŸš«
If your client exceeds any of these limits, the API will respond with:
HTTP 429 Too Many Requests
A Retry-After header (in seconds) indicating how long to wait before retrying.

🔁 Handling Rate Limit Responses#

When your client exceeds the allowed limits, you'll receive a 429 Too Many Requests response. In this case:
Respect the Retry-After header to determine when to try again.
Avoid retrying immediately without a delay — this may lead to further rejections.
If possible, implement exponential backoff or queuing in your client application.

Example 429 Response#

HTTP/1.1 429 Too Many Requests
Retry-After: 120
Content-Type: text/plain
Too many requests. Please try again later.

📌 Notes#

Limits apply per authenticated user (if available), or fall back to the request host if unauthenticated.
These limits are global, affecting all routes in the API.
No queuing is implemented — excess requests are immediately rejected.
If your use case requires higher limits, feel free to contact us at info@vereinsantrag.de.
Previous
Get your token
Next
/auth/login
Built with