Topics

Introduction
Authentication

Endpoints

Login / E-Mail Login
Login / Logout
- Do log out
User / User
User / UserAccessGroup
Session / Session
Social Login / Google Login
- Get redirect for google login
- Do log in with google code
Access / AccessTag
Login / JWT ApiAccess
User / User2Factor
Login / Self Sign Up
- Starts a new self sign up process. Returns a token and required fields.
- Finish self sign up process. Requires token from Self Sign Up - Start.
Customer / BaseDataSelfService
- Returns a self signup token + possible membership items
- Returns the full profile of the current user with billing account, tickets, bookings
Customer / Self Sign Up Code
Customer / SelfServiceMembership
Public / Session
Chat / CustomerChatroom
- Returns a list of all Chatrooms
- Return single Chatroom
Chat / CustomerChatroomMessage
Chat / Chatroom
Chat / ChatroomMessage
Chat / ChatroomMessageReaction
Chat / ChatroomParticipant
CRM / SubscriptionItem
CRM / Unified Categories
CRM / PersonLogBookEntry
CRM / Accounts | Companies
CRM / CRMPerson
Billing / PaymentType
- Returns a list of all PaymentType
Billing / Invoice
- Creates a single Invoice
Billing / Tax
- Returns a list of all Tax
Billing / AccountingType
- Returns a list of all AccountingType
Billing / Offer
- Creates a single Offer
Billing / PredefinedBillingItem
- Creates a single PredefinedBillingItem
Billing / BillingItemType
- Returns a list of all BillingItemType
Billing / OfferAccountingType
- Returns a list of all OfferAccountingType
Billing / PaymentTransaction
Billing / ImportedPaymentTransaction
Billing / ImportedPaymentTransactionGroup
Billing / Shipping
- Returns a dummy offer with calculated shipping price
TimeTracking / ProcessedEmploymentContractMonth
TimeTracking / TrainerTimeEntry
TimeTracking / WorkTimeEntry
TimeTracking / NonWorkTimeRequest
TimeTracking / NonWorkTimeRequestComment
ServerManagement / ShortLink
Event / EventSignUpScanner
Event / BaseLocation
Event / BaseBookable
Event / Event
Event / Event Schedule
Event / BaseEventInvitation
Event / Booking
Event / BookingGroup
Event / EventSignUp
Event / Public
- Get event + future bookings + test adding a new BaseEventSignUp as customer / public
SipgateAPI / Call
Social Login / Microsoft Login
Social Login / iw Remote ERP
Social Login / Instagram Login
Social Login / Facebook Login
Social Login / Redirects
- Test oauth code received
OpenData / GeoCoding
- This method returns a Collection of matching GeoCoding results for the searched address.
OpenData / IBAN
- Returns BIC + name of the bank associated with the given IBAN. For invalid IBANs, NULL is returned.
oAuth / Server Client
oAuth / Server Client Permission
Media / Media Files
Media / Media Groups
Media / News Article
Media / MediaQuestionnaire
- Deletes a single MediaQuestionnaire
Media / MediaQuestionnaire Answer
- Add a new MediaQuestionnaireAnswer for questionnaire as a guest
- Test adding a new MediaQuestionnaireAnswer as customer / public
Media / MediaCardButton
- Deletes a single MediaCardButton
Notification / MassNotification
- Add a new MassUserNotification
- Get a list of SimpleReference
DataWarehouse / Webhooks
DataWarehouse / Search
- Returns a list of search results (max. 20 per entity)
Settings / AdditionalUiField
Settings / AdditionalUiFilter

Powered by Bump.sh

API Changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

SipgateAPI / Call