Topics

Introduction
Authentication

Endpoints

Login / E-Mail Login
Login / Logout
- Do log out POST
User / User
User / UserAccessGroup
Session / Session
Social Login / Google Login
- Get redirect for google login GET
- Do log in with google code POST
Access / AccessTag
Login / JWT ApiAccess
User / User2Factor
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
Customer / SelfServiceMembership
Public / Session
Chat / CustomerChatroom
- Returns a list of all Chatrooms GET
- Return single Chatroom GET
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 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
Billing / ImportedPaymentTransaction
Billing / ImportedPaymentTransactionGroup
Billing / Shipping
- Returns a dummy offer with calculated shipping price GET
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 GET
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 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
oAuth / Server Client Permission
Media / Media Files
Media / Media Groups
Media / News Article
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
DataWarehouse / Search
- Returns a list of search results (max. 20 per entity) GET
Settings / AdditionalUiField
Settings / AdditionalUiFilter

Powered by Bump.sh

API changelog

Download source

JSON OpenAPI specification
YAML OpenAPI specification

Toggle dark mode

SipgateAPI / Call