ESC
Example searches: “log_book_trainer”, “invoice”, “200”, “cancel_date”, “id”
Search…
Ctrl+K
⌘K
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
Topics
Introduction
Authentication
Endpoints
Login / E-Mail Login
Do log in with email and password
POST
Do reset password for email
POST
Remove own login - Requires own password
POST
Login / Logout
Do log out
POST
User / User
This method will get a single User Object with the given id
GET
This method will update a User Object
PUT
This method will get all User Objects
GET
This method will get your User Object
GET
User / UserAccessGroup
Return all UserAccessGroup
GET
Add new UserAccessGroup
POST
Return a single UserAccessGroup
GET
Update a single UserAccessGroup
PUT
Session / Session
This method will get the active Session Object
GET
Update Customer Profile on User
POST
This method will get the sso link with a token - set query parameter durableJwt=1 to get a long-lasting token without the option to login as the user
GET
Verify 2FA code for this session
GET
Social Login / Google Login
Get redirect for google login
GET
Do log in with google code
POST
Access / AccessTag
Returns a list of all AccessTag
GET
Add new AccessTag
POST
Return single AccessTag
GET
Update single AccessTag
PUT
Login / JWT ApiAccess
Creates a new MqttToken as a super admin
GET
Creates a new JWT Login Token
GET
Return single ApiAccessToken
GET
Delete single ApiAccessToken
DELETE
Returns a list of own ApiAccessToken
GET
Test if the api access token is valid
GET
User / User2Factor
This method will create a new User2Factor Object for given type
GET
This method will verify a User2Factor Object
GET
This method will delete a User2Factor Object, requires a valid 2fa code
DELETE
This method will get all available User2Factor Objects
GET
Login / Self Sign Up
Starts a new self sign up process. Returns a token and required fields.
GET
Finish self sign up process. Requires token from Self Sign Up - Start.
POST
Customer / BaseDataSelfService
Returns a self signup token + possible membership items
GET
Returns the full profile of the current user with billing account, tickets, bookings
GET
Customer / Self Sign Up Code
Returns a list of all SelfSignUpLogInviteCode
GET
Add a new SelfSignUpLogInviteCode
POST
Return single SelfSignUpLogInviteCode
GET
Update single SelfSignUpLogInviteCode
PUT
Customer / SelfServiceMembership
Returns a public list of all SelfServiceMembershipStep
GET
Returns a list of all SelfServiceMembershipStep
GET
Add a new SelfServiceMembershipStep
POST
Return single SelfServiceMembershipStep
GET
Update single SelfServiceMembershipStep
PUT
Returns a list of all SelfServiceMembershipCategory
GET
Add a new SelfServiceMembershipCategory
POST
Return single SelfServiceMembershipCategory
GET
Update single SelfServiceMembershipCategory
PUT
Returns a list of all SelfServiceMembershipItem
GET
Add a new SelfServiceMembershipItem
POST
Return single SelfServiceMembershipItem
GET
Update single SelfServiceMembershipItem
PUT
Public / Session
Get or start a new public session
GET
Update / create fields of public session
PUT
Update / create fields of public session
POST
Update / create fields of public session
PATCH
Chat / CustomerChatroom
Returns a list of all Chatrooms
GET
Return single Chatroom
GET
Chat / CustomerChatroomMessage
Returns a list of all ChatroomMessages
GET
Return single ChatroomMessage
GET
Update single ChatroomMessage
PUT
Add a new ChatroomMessage
POST
Chat / Chatroom
Returns a list of all Chatrooms
GET
Add a new Chatroom
POST
Return single Chatroom
GET
Update single Chatroom
PUT
Delete a single Chatroom
DELETE
Chat / ChatroomMessage
Returns a list of all ChatroomMessages
GET
Add a new ChatroomMessage
POST
Return single ChatroomMessage
GET
Update single ChatroomMessage
PUT
Delete a single ChatroomMessage
DELETE
Chat / ChatroomMessageReaction
Returns a list of all ChatroomMessageReactions
GET
Add a new ChatroomMessageReaction
POST
Return single ChatroomMessageReaction
GET
Update single ChatroomMessageReaction
PUT
Delete a single ChatroomMessageReaction
DELETE
Chat / ChatroomParticipant
Returns a list of all ChatroomParticipants
GET
Add a new ChatroomParticipant
POST
Return single ChatroomParticipant
GET
Update single ChatroomParticipant
PUT
Delete a single ChatroomParticipant
DELETE
CRM / SubscriptionItem
Returns a list of SubscriptionItem
GET
Create a single SubscriptionItem
POST
Returns a single SubscriptionItem with the given id
GET
Update a single SubscriptionItem
PUT
CRM / Unified Categories
Returns a list of unified categories
GET
Add a new unified category
POST
Returns a list of public unified categories
GET
Return a single public unified category with the given id
GET
Return a single unified category with the given id
GET
Update a single unified category with the given id
PUT
Return a single unified category extension with the given unified category id
GET
Update a single unified category extension with the given unified category id
PUT
CRM / PersonLogBookEntry
Returns a list of all PersonLogBookEntry
GET
Add a new PersonLogBookEntry
POST
Get a single PersonLogBookEntry with the given id or token
GET
Update a PersonLogBookEntry
PUT
Delete a single PersonLogBookEntry with the given id or token
DELETE
CRM / Accounts | Companies
Returns a list of accounts / companies
GET
Creates a single account / CRMCompany
POST
Returns a single account / CRMCompany
GET
Updates a single account / CRMCompany with the given identifier
PUT
Updates a single account / CRMCompany with the given identifier
PATCH
CRM / CRMPerson
Returns a list of people
GET
Add a new person
POST
Return a single person with the given id
GET
Updates a single person with the given identifier
PUT
Updates a single person with the given identifier
PATCH
Returns a list of people with matching linking identifier
GET
Updates a single person with the given identifier and matching linking identifier
PUT
Updates a single person with the given identifier and matching linking identifier
POST
Updates a single person with the given identifier and matching linking identifier
PATCH
Updates multiple persons with the given identifiers and matching linking identifiers
PUT
Updates multiple persons with the given identifiers and matching linking identifiers
POST
Updates multiple persons with the given identifiers and matching linking identifiers
PATCH
Return a single person with the given id and matching linking identifier
GET
Return a login link for the person with the given id and matching linking identifier
GET
Billing / PaymentType
Returns a list of all PaymentType
GET
Billing / Invoice
Creates a single Invoice
POST
Billing / Tax
Returns a list of all Tax
GET
Billing / AccountingType
Returns a list of all AccountingType
GET
Billing / Offer
Creates a single Offer
POST
Billing / PredefinedBillingItem
Creates a single PredefinedBillingItem
POST
Billing / BillingItemType
Returns a list of all BillingItemType
GET
Billing / OfferAccountingType
Returns a list of all OfferAccountingType
GET
Billing / PaymentTransaction
Returns a list of all PaymentTransaction
GET
Add a new PaymentTransaction
POST
Get a single PaymentTransaction
GET
Update a PaymentTransaction
PUT
Billing / ImportedPaymentTransaction
Returns a list of all ImportedPaymentTransaction
GET
Add a new ImportedPaymentTransaction
POST
Get a single ImportedPaymentTransaction
GET
Update a ImportedPaymentTransaction
PUT
Billing / ImportedPaymentTransactionGroup
Returns a list of all ImportedPaymentTransactionGroup
GET
Add a new ImportedPaymentTransactionGroup
POST
Get a single ImportedPaymentTransactionGroup
GET
Update a ImportedPaymentTransactionGroup
PUT
Billing / Shipping
Returns a dummy offer with calculated shipping price
GET
TimeTracking / ProcessedEmploymentContractMonth
Get a single ProcessedEmploymentContractMonth
GET
Update a single ProcessedEmploymentContractMonth
PUT
Update a single ProcessedEmploymentContractMonth
PATCH
Get all ProcessedEmploymentContractMonth
GET
TimeTracking / TrainerTimeEntry
Get all TrainerTimeEntry
GET
Create a single TrainerTimeEntry
POST
Get a single TrainerTimeEntry with the given id
GET
Update a single TrainerTimeEntry
PUT
Delete a single TrainerTimeEntry
DELETE
Update a single TrainerTimeEntry
PATCH
TimeTracking / WorkTimeEntry
Get all WorkTimeEntry
GET
Create a single WorkTimeEntry
POST
Get a single WorkTimeEntry
GET
Update a single WorkTimeEntry
PUT
Delete a single WorkTimeEntry
DELETE
Update a single WorkTimeEntry
PATCH
Get the current own WorkTimeEntry
GET
Get WorkTimeEntries grouped by month for user or person
GET
Get own WorkTimeEntries grouped by month
GET
Get WorkTimeEntries grouped by date for user or person
GET
Get own WorkTimeEntries grouped by date
GET
TimeTracking / NonWorkTimeRequest
Get all NonWorkTimeRequest
GET
Create a single NonWorkTimeRequest
POST
Get a single NonWorkTimeRequest
GET
Update a single NonWorkTimeRequest
PUT
Test a single NonWorkTimeRequest
POST
TimeTracking / NonWorkTimeRequestComment
Get all NonWorkTimeRequestComment
GET
Get all NonWorkTimeRequestComment for a single NonWorkTimeRequest
GET
Get a single NonWorkTimeRequestComment
GET
Update a single NonWorkTimeRequestComment
PUT
Create a single NonWorkTimeRequestComment
POST
ServerManagement / ShortLink
Returns a list of ShortLink
GET
Create a single ShortLink
POST
Returns a single ShortLink with the given id
GET
Update a single ShortLink
PUT
Deletes a single ShortLink
DELETE
Event / EventSignUpScanner
Get a list of the next event signups of a person
GET
Get a list of the next event signups of a person
GET
Trigger actions for an event signup for a person
POST
Trigger actions for an event signup for a person
POST
Event / BaseLocation
Return all BaseLocation
GET
Add a new BaseLocation
POST
Return a single BaseLocation
GET
Update a BaseLocation
PUT
Event / BaseBookable
Returns a list of BaseBookable objects
GET
Add a new BaseBookable
POST
Returns a single BaseBookable
GET
Update a BaseBookable
PUT
Returns a list of BaseBookable objects with given self-service access scope
GET
Event / Event
Returns a list of events
GET
Add a new BaseEvent
POST
Returns a single BaseEvent with the given id or token
GET
Update a BaseEvent
PUT
Event / Event Schedule
Returns a list of BaseEventBookingSchedule
GET
Add a new BaseEventBookingSchedule
POST
Returns a single BaseEventBookingSchedule with the given id
GET
Update a BaseEventBookingSchedule
PUT
Event / BaseEventInvitation
Returns a list of BaseEventInvitation objects
GET
Add a new BaseEventInvitation
POST
Returns a single BaseEventInvitation with the given id
GET
Update a BaseEventInvitation
PUT
Deletes a single BaseEventInvitation
DELETE
Update a BaseEventInvitation as customer
PUT
Event / Booking
Returns a list of BaseBooking
GET
Creates a single BaseBooking
POST
Returns a single BaseBooking
GET
Updates a single BaseBooking
PUT
Deletes a single BaseBooking
DELETE
Updates a single BaseBooking
PATCH
Get all BaseBooking for a customer
GET
Get all BaseBooking for a customer that is the participant
GET
Get all BaseBooking for a customer that is the performing person
GET
Get waitlist positions for BaseBooking for a customer
GET
Get a single BaseBooking for a customer
GET
Creates a single BaseBooking for a BaseBookable as a customer
POST
Creates a single BaseBooking for a BaseBookable as a guest
POST
Returns a list of public deleted BaseBooking
GET
Get all BaseBooking for a BaseBookable where performingPerson can be self-assigned
GET
Returns a single BaseBooking where performingPerson can be self-assigned
GET
Event / BookingGroup
Returns a list of BaseBookingGroup
GET
Creates a single BaseBookingGroup
POST
Returns a single BaseBookingGroup
GET
Updates a single BaseBookingGroup
PUT
Deletes a single BaseBookingGroup
DELETE
Updates a single BaseBookingGroup
PATCH
Event / EventSignUp
Add a new BaseEventSignUp for event or booking as a guest
POST
Test adding a new BaseEventSignUp as customer / public
POST
Test adding a new BaseEventSignUp as trainer
POST
Add a new BaseEventSignUp for event or booking as a trainer. Only possible if event billing not required.
POST
Add a new MassUserNotification for the event signups in referenceIds
POST
Event / Public
Get event + future bookings + test adding a new BaseEventSignUp as customer / public
GET
SipgateAPI / Call
Returns a list of SIPCall
GET
Start a SIPCall
POST
Returns a single SIPCall with the given id
GET
Updates a single SIPCall
PUT
Social Login / Microsoft Login
Get redirect for microsoft login
GET
Do log in with microsoft code
POST
Remove microsoft user connection
DELETE
Social Login / iw Remote ERP
Get redirect for inwendo remote erp login
GET
Do log in with inwendo remote erp code
POST
Remove inwendo remote erp user connection
DELETE
Social Login / Instagram Login
Get redirect for instagram login
GET
Do log in with instagram code
POST
Remove instagram user connection
DELETE
Social Login / Facebook Login
Get redirect for facebook login
GET
Do log in with facebook code
POST
Remove facebook user connection
DELETE
Social Login / Redirects
Test oauth code received
POST
OpenData / GeoCoding
This method returns a Collection of matching GeoCoding results for the searched address.
GET
OpenData / IBAN
Returns BIC + name of the bank associated with the given IBAN. For invalid IBANs, NULL is returned.
GET
oAuth / Server Client
Get a single OauthServerClient
GET
Updates a single OauthServerClient
PUT
Updates a single OauthServerClient
PATCH
Creates a single OauthServerClient
POST
oAuth / Server Client Permission
Get a single OauthServerClientPermission
GET
Updates a single OauthServerClientPermission
PUT
Creates a single OauthServerClientPermission
POST
Updates a single OauthServerClientPermission
PATCH
Media / Media Files
Add a new MediaFileInfo
POST
Update a MediaFileInfo
PUT
Returns a list of media files for a single media group
GET
Media / Media Groups
Returns a list of media groups
GET
Add a new MediaGroup
POST
Returns a single media group with the given id or token
GET
Update a MediaGroup
PUT
Media / News Article
Returns a list of news article
GET
Creates a single news article
POST
Returns a single news article with the given id or token
GET
Updates a single news article
PUT
Deletes a single MediaNewsArticle
DELETE
Media / MediaQuestionnaire
Deletes a single MediaQuestionnaire
DELETE
Media / MediaQuestionnaire Answer
Add a new MediaQuestionnaireAnswer for questionnaire as a guest
POST
Test adding a new MediaQuestionnaireAnswer as customer / public
POST
Media / MediaCardButton
Deletes a single MediaCardButton
DELETE
Notification / MassNotification
Add a new MassUserNotification
POST
Get a list of SimpleReference
GET
DataWarehouse / Webhooks
Returns a list of webhooks
GET
Add a new webhook
POST
Return a single webhook with the given id
GET
Update a single webhook with the given id
PUT
DataWarehouse / Search
Returns a list of search results (max. 20 per entity)
GET
Settings / AdditionalUiField
Returns a list of all AdditionalUiField
GET
Add a new AdditionalUiField
POST
Return single AdditionalUiField
GET
Update single AdditionalUiField
PUT
Settings / AdditionalUiFilter
Returns a list of all AdditionalUiFilter
GET
Add a new AdditionalUiFilter
POST
Return single AdditionalUiFilter
GET
Update single AdditionalUiFilter
PUT
Search…
Ctrl+K
⌘K
API changelog
Download source
JSON OpenAPI specification
YAML OpenAPI specification
Toggle dark mode
Dismiss highlight
Show more
Media / News Article
Media / News Article
