Vereinsantrag
HandbuchDeveloperVereinsantrag.online
HandbuchDeveloperVereinsantrag.online
  1. 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
    • 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
        • Retrieves the membership form for the club.
        • Modifies the membership form for the club.
        • Retrieves the cancellation form for the club.
        • Modifies the cancellation form for the club.
      • 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.
        • Modifies an existing custom field.
      • DataPrivacy
        • Retrieves the data privacy settings for the club.
        • Updates the data privacy settings for the club.
    • Submits
      • Cancellations
        • Get cancellation by id
        • Delete cancellation
        • Create new cancellation
        • Get cancellation PDF
        • Get cancellation CSV
        • Confirm cancellation
      • Changes
        • Create a new change request
        • Get change request by ID
        • Delete change request
        • Get change request PDF
        • Get change request CSV
        • Confirm change request
      • Memberships
        • Creates a new membership application
        • Retrieves a membership application
        • Deletes a membership application
        • Exports a membership application as PDF
        • Exports a membership application as CSV
        • Confirms a membership application
      • Submits
        • Retrieves all submissions.
        • Accepts a submission.
        • Denies a submission.
    • 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.
  1. Developer

Get your token

The Vereinsantrag API is available to customers with a Gold Edition subscription or higher. If your account has access, you can authenticate and start integrating with our platform in just a few steps.
Access Requirements
API access is only available with the Gold Edition or higher.
Please go to your subscription page and upgrade your plan.

๐Ÿงพ Authentication#

We use Bearer Token Authentication. To start, you need to log in using your account credentials and obtain an access token.

1
๐Ÿ”‘ Step 1: Login to get a token
Send a POST request to the login endpoint:
If the credentials are correct, the response will look like this:
2
๐Ÿ” Step 2: Use the token in every request
You must include the token in the Authorization header as a Bearer token in all subsequent API requests:

โœ… Tips#

Always keep your token secure and never expose it publicly.
Tokens expire after a certain period (see expiresIn). Make sure to re-authenticate when needed.
If you receive a 401 Unauthorized, check that your token is valid and has not expired.
Need help accessing the API or upgrading your plan?
๐Ÿ“ฌ info@vereinsantrag.de
Previous
Welcome to the developer portal
Next
Rate-Limiting
Built with