Vereinsantrag
Handbuch
DeveloperVereinsantrag.online
Handbuch
DeveloperVereinsantrag.online
  1. Dashboard
  • 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)
      • Managing 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
          • Get notification settings (who receives emails on new submissions)
          • Save notification settings
        • Webhooks
          • List webhooks
          • Create webhook
          • Update webhook
          • Delete webhook
          • Rotate secret
          • Test webhook
          • Delivery history
      • 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.
            GET
          • Gets the count of new changes.
            GET
          • Gets the count of new cancellations.
            GET
          • Gets the membership chart data.
            GET
          • Gets all dashboard KPI values in a single call.
            GET
          • Gets the submission trend (memberships, changes, cancellations and net development) per week or month.
            GET
          • Gets the age distribution of new members (including family members) in the period.
            GET
          • Gets the gender distribution of new members (including family members) in the period.
            GET
          • Gets the most popular departments by new memberships in the period.
            GET
          • Gets the distribution of membership types in the period.
            GET
          • Gets the payment method distribution of new memberships in the period.
            GET
          • Gets the application funnel (received, e-mail confirmed, accepted, rejected) for the period.
            GET
          • Gets the average processing time per month for the period.
            GET
          • Gets the most common zip codes of new members in the period.
            GET
          • Gets the webhook delivery trend (succeeded vs. failed) per month for the period.
            GET
  • Schemas
    • BackgroundImageSettings
    • CancellationMode
    • AccessTokenResponse
    • BackgroundSettings
    • CancellationPatchDto
    • CreateUserRequest
    • CancellationSubmit
    • ChangeClubInfo
    • ForgotPasswordRequest
    • CancellationSubmitPatchRequest
    • HttpValidationProblemDetails
    • ChangeCustomFieldSchema
    • InfoRequest
    • CancellationSubmitResponse
    • ChangeMembershipSchema
    • ChangePatchDto
    • InfoResponse
    • ClubInfo
    • ClubLogo
    • ChangeSubmitPatchRequest
    • LoginRequest
    • ChangesSubmit
    • RefreshRequest
    • ConsentMediaType
    • CustomDesignSettings
    • RegisterRequest
    • CustomFieldCategory
    • CustomFieldPatchDto
    • ResendConfirmationEmailRequest
    • ResetPasswordRequest
    • CustomFieldSchema
    • FamiliySubmit
    • TwoFactorRequest
    • FamilyMemberPatchDto
    • CustomFieldType
    • TwoFactorResponse
    • Gender
    • DataPrivacySchema
    • UpdateUserRequest
    • MembershipPatchDto
    • DepartmentSchema
    • MembershipPatchRequest
    • UserResponse
    • DepartmentSettingsSchema
    • EMailTemplateType
    • UserRole
    • MembershipSubmit
    • MembershipSubmitResponse
    • File
    • FormCancellation
    • PaymentMethod
    • ProblemDetails
    • FormDesign
    • FormMembership
    • StartExportJobRequest
    • GetEmailTemplateResponse
    • SubmitAcceptRequest
    • MembershipDepartmentPriceSchema
    • SubmitDenyRequest
    • MembershipPriceInterval
    • SubmitHistoryResponse
    • MembershipSchema
    • SubmitHistoryType
    • SubmitResponse
    • NotificationSettingsReadDto
    • SubmitState
    • NotificationSettingsWriteDto
    • NotificationUserSelectionDto
    • PatchCustomFieldSchema
    • PlaceholderCategory
    • PlaceholderDataType
    • PlaceholderDefinition
    • SetEmailTemplateRequest
    • SmtpSettingsReadDto
    • SmtpSettingsWriteDto
    • SmtpTestResultDto
    • ValidationProblemDetails
    • WebhookDeliveryDto
    • WebhookDeliveryStatus
    • WebhookEventType
    • WebhookReadDto
    • WebhookSecretDto
    • WebhookTestResultDto
    • WebhookWriteDto
  1. Dashboard

Gets all dashboard KPI values in a single call.

GET
https://api.vereinsantrag.de/v1/dashboard/summary
Returns all dashboard KPI values for the specified club and period in a single result.

Request

Query Params

Responses

🟢200
application/json
OK
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.vereinsantrag.de/v1/dashboard/summary?from=undefined&to=undefined&unit=undefined&membershipId=undefined&departmentId=undefined'
Response Response Example
Previous
Gets the membership chart data.
Next
Gets the submission trend (memberships, changes, cancellations and net development) per week or month.
Built with