inwendo ERP API logo
API Changelog
Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification

Topics

  • Introduction
  • Authentication

Endpoints

  • Login / E-Mail Login
    • Do log in with email and password
    • Do reset password for email
    • Remove own login - Requires own password
  • Login / Logout
    • Do log out
  • User / User
    • This method will get a single User Object with the given id
    • This method will update a User Object
    • This method will get all User Objects
    • This method will get your User Object
  • User / UserAccessGroup
    • Return all UserAccessGroup
    • Add new UserAccessGroup
    • Return a single UserAccessGroup
    • Update a single UserAccessGroup
  • Session / Session
    • This method will get the active Session Object
    • Update Customer Profile on User
    • 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
    • Verify 2FA code for this session
  • Social Login / Google Login
    • Get redirect for google login
    • Do log in with google code
  • Access / AccessTag
    • Returns a list of all AccessTag
    • Add new AccessTag
    • Return single AccessTag
    • Update single AccessTag
  • Login / JWT ApiAccess
    • Creates a new MqttToken as a super admin
    • Creates a new JWT Login Token
    • Return single ApiAccessToken
    • Delete single ApiAccessToken
    • Returns a list of own ApiAccessToken
    • Test if the api access token is valid
  • User / User2Factor
    • This method will create a new User2Factor Object for given type
    • This method will verify a User2Factor Object
    • This method will delete a User2Factor Object, requires a valid 2fa code
    • This method will get all available User2Factor Objects
  • 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
    • Returns a list of all SelfSignUpLogInviteCode
    • Add a new SelfSignUpLogInviteCode
    • Return single SelfSignUpLogInviteCode
    • Update single SelfSignUpLogInviteCode
  • Customer / SelfServiceMembership
    • Returns a public list of all SelfServiceMembershipStep
    • Returns a list of all SelfServiceMembershipStep
    • Add a new SelfServiceMembershipStep
    • Return single SelfServiceMembershipStep
    • Update single SelfServiceMembershipStep
    • Returns a list of all SelfServiceMembershipCategory
    • Add a new SelfServiceMembershipCategory
    • Return single SelfServiceMembershipCategory
    • Update single SelfServiceMembershipCategory
    • Returns a list of all SelfServiceMembershipItem
    • Add a new SelfServiceMembershipItem
    • Return single SelfServiceMembershipItem
    • Update single SelfServiceMembershipItem
  • Public / Session
    • Get or start a new public session
    • Update / create fields of public session
    • Update / create fields of public session
    • Update / create fields of public session
  • Chat / Chatroom
    • Returns a list of all Chatrooms
    • Add a new Chatroom
    • Return single Chatroom
    • Update single Chatroom
    • Delete a single Chatroom
  • Chat / ChatroomMessage
    • Returns a list of all ChatroomMessages
    • Add a new ChatroomMessage
    • Return single ChatroomMessage
    • Update single ChatroomMessage
    • Delete a single ChatroomMessage
  • Chat / ChatroomMessageReaction
    • Returns a list of all ChatroomMessageReactions
    • Add a new ChatroomMessageReaction
    • Return single ChatroomMessageReaction
    • Update single ChatroomMessageReaction
    • Delete a single ChatroomMessageReaction
  • Chat / ChatroomParticipant
    • Returns a list of all ChatroomParticipants
    • Add a new ChatroomParticipant
    • Return single ChatroomParticipant
    • Update single ChatroomParticipant
    • Delete a single ChatroomParticipant
  • CRM / SubscriptionItem
    • Returns a list of SubscriptionItem
    • Create a single SubscriptionItem
    • Returns a single SubscriptionItem with the given id
    • Update a single SubscriptionItem
  • CRM / Unified Categories
    • Returns a list of unified categories
    • Add a new unified category
    • Returns a list of public unified categories
    • Return a single public unified category with the given id
    • Return a single unified category with the given id
    • Update a single unified category with the given id
    • Return a single unified category extension with the given unified category id
    • Update a single unified category extension with the given unified category id
  • CRM / PersonLogBookEntry
    • Returns a list of all PersonLogBookEntry
    • Add a new PersonLogBookEntry
    • Get a single PersonLogBookEntry with the given id or token
    • Update a PersonLogBookEntry
    • Delete a single PersonLogBookEntry with the given id or token
  • CRM / Accounts | Companies
    • Returns a list of accounts / companies
    • Creates a single account / CRMCompany
    • Returns a single account / CRMCompany
    • Updates a single account / CRMCompany with the given identifier
    • Updates a single account / CRMCompany with the given identifier
  • CRM / CRMPerson
    • Returns a list of people
    • Add a new person
    • Return a single person with the given id
    • Updates a single person with the given identifier
    • Updates a single person with the given identifier
    • Returns a list of people with matching linking identifier
    • Updates a single person with the given identifier and matching linking identifier
    • Updates a single person with the given identifier and matching linking identifier
    • Updates a single person with the given identifier and matching linking identifier
    • Updates multiple persons with the given identifiers and matching linking identifiers
    • Updates multiple persons with the given identifiers and matching linking identifiers
    • Updates multiple persons with the given identifiers and matching linking identifiers
    • Return a single person with the given id and matching linking identifier
    • Return a login link for the person with the given id and matching linking identifier
  • 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
    • Returns a list of all PaymentTransaction
    • Add a new PaymentTransaction
    • Get a single PaymentTransaction
    • Update a PaymentTransaction
  • Billing / ImportedPaymentTransaction
    • Returns a list of all ImportedPaymentTransaction
    • Add a new ImportedPaymentTransaction
    • Get a single ImportedPaymentTransaction
    • Update a ImportedPaymentTransaction
  • Billing / ImportedPaymentTransactionGroup
    • Returns a list of all ImportedPaymentTransactionGroup
    • Add a new ImportedPaymentTransactionGroup
    • Get a single ImportedPaymentTransactionGroup
    • Update a ImportedPaymentTransactionGroup
  • Billing / Shipping
    • Returns a dummy offer with calculated shipping price
  • TimeTracking / ProcessedEmploymentContractMonth
    • Get a single ProcessedEmploymentContractMonth
    • Update a single ProcessedEmploymentContractMonth
    • Update a single ProcessedEmploymentContractMonth
    • Get all ProcessedEmploymentContractMonth
  • TimeTracking / WorkTimeEntry
    • Get all WorkTimeEntry
    • Create a single WorkTimeEntry
    • Get a single WorkTimeEntry
    • Update a single WorkTimeEntry
    • Update a single WorkTimeEntry
    • Get the current own WorkTimeEntry
    • Get WorkTimeEntries grouped by month for user or person
    • Get own WorkTimeEntries grouped by month
    • Get WorkTimeEntries grouped by date for user or person
    • Get own WorkTimeEntries grouped by date
  • TimeTracking / NonWorkTimeRequest
    • Get all NonWorkTimeRequest
    • Create a single NonWorkTimeRequest
    • Get a single NonWorkTimeRequest
    • Update a single NonWorkTimeRequest
    • Test a single NonWorkTimeRequest
  • TimeTracking / NonWorkTimeRequestComment
    • Get all NonWorkTimeRequestComment
    • Get all NonWorkTimeRequestComment for a single NonWorkTimeRequest
    • Get a single NonWorkTimeRequestComment
    • Update a single NonWorkTimeRequestComment
    • Create a single NonWorkTimeRequestComment
  • ServerManagement / ShortLink
    • Returns a list of ShortLink
    • Create a single ShortLink
    • Returns a single ShortLink with the given id
    • Update a single ShortLink
    • Deletes a single ShortLink
  • Event / EventSignUpScanner
    • Get a list of the next event signups of a person
    • Get a list of the next event signups of a person
  • Event / BaseLocation
    • Return all BaseLocation
    • Add a new BaseLocation
    • Return a single BaseLocation
    • Update a BaseLocation
  • Event / BaseBookable
    • Returns a list of BaseBookable objects
    • Add a new BaseBookable
    • Returns a single BaseBookable
    • Update a BaseBookable
    • Returns a list of BaseBookable objects with given self-service access scope
  • Event / Event
    • Returns a list of events
    • Add a new BaseEvent
    • Returns a single BaseEvent with the given id or token
    • Update a BaseEvent
  • Event / Event Schedule
    • Returns a list of BaseEventBookingSchedule
    • Add a new BaseEventBookingSchedule
    • Returns a single BaseEventBookingSchedule with the given id
    • Update a BaseEventBookingSchedule
  • Event / BaseEventInvitation
    • Returns a list of BaseEventInvitation objects
    • Add a new BaseEventInvitation
    • Returns a single BaseEventInvitation with the given id
    • Update a BaseEventInvitation
    • Deletes a single BaseEventInvitation
    • Update a BaseEventInvitation as customer
  • Event / Booking
    • Returns a list of BaseBooking
    • Creates a single BaseBooking
    • Returns a single BaseBooking
    • Updates a single BaseBooking
    • Deletes a single BaseBooking
    • Updates a single BaseBooking
    • Get all BaseBooking for a customer
    • Get all BaseBooking for a customer that is the participant
    • Get all BaseBooking for a customer that is the performing person
    • Get waitlist positions for BaseBooking for a customer
    • Get a single BaseBooking for a customer
    • Creates a single BaseBooking for a BaseBookable as a customer
    • Creates a single BaseBooking for a BaseBookable as a guest
    • Returns a list of public deleted BaseBooking
    • Get all BaseBooking for a BaseBookable where performingPerson can be self-assigned
    • Returns a single BaseBooking where performingPerson can be self-assigned
  • Event / EventSignUp
    • Add a new BaseEventSignUp for event or booking as a guest
    • Test adding a new BaseEventSignUp as customer / public
    • Test adding a new BaseEventSignUp as trainer
    • Add a new BaseEventSignUp for event or booking as a trainer. Only possible if event billing not required.
    • Add a new MassUserNotification for the event signups in referenceIds
  • Event / Public
    • Get event + future bookings + test adding a new BaseEventSignUp as customer / public
  • SipgateAPI / Call
    • Returns a list of SIPCall
    • Start a SIPCall
    • Returns a single SIPCall with the given id
    • Updates a single SIPCall
  • Social Login / Microsoft Login
    • Get redirect for microsoft login
    • Do log in with microsoft code
    • Remove microsoft user connection
  • Social Login / iw Remote ERP
    • Get redirect for inwendo remote erp login
    • Do log in with inwendo remote erp code
    • Remove inwendo remote erp user connection
  • Social Login / Instagram Login
    • Get redirect for instagram login
    • Do log in with instagram code
    • Remove instagram user connection
  • Social Login / Facebook Login
    • Get redirect for facebook login
    • Do log in with facebook code
    • Remove facebook user connection
  • 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
    • Get a single OauthServerClient
    • Updates a single OauthServerClient
    • Updates a single OauthServerClient
    • Creates a single OauthServerClient
  • oAuth / Server Client Permission
    • Get a single OauthServerClientPermission
    • Updates a single OauthServerClientPermission
    • Creates a single OauthServerClientPermission
    • Updates a single OauthServerClientPermission
  • Media / Media Files
    • Add a new MediaFileInfo
    • Update a MediaFileInfo
    • Returns a list of media files for a single media group
  • Media / Media Groups
    • Returns a list of media groups
    • Add a new MediaGroup
    • Returns a single media group with the given id or token
    • Update a MediaGroup
  • Media / News Article
    • Returns a list of news article
    • Creates a single news article
    • Returns a single news article with the given id or token
    • Updates a single news article
    • Deletes a single MediaNewsArticle
  • 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
    • Returns a list of webhooks
    • Add a new webhook
    • Return a single webhook with the given id
    • Update a single webhook with the given id
  • DataWarehouse / Search
    • Returns a list of search results (max. 20 per entity)
  • Settings / AdditionalUiField
    • Returns a list of all AdditionalUiField
    • Add a new AdditionalUiField
    • Return single AdditionalUiField
    • Update single AdditionalUiField
  • Settings / AdditionalUiFilter
    • Returns a list of all AdditionalUiFilter
    • Add a new AdditionalUiFilter
    • Return single AdditionalUiFilter
    • Update single AdditionalUiFilter
Powered by Bump.sh

Returns a single ShortLink with the given id

GET /api/servermanagement/shortlink/{id}
Session token Jwt token internal Login config

Path parameters

  • id string Required

Query parameters

  • iw-build-id string

    build id of the client

  • iw-package-id string

    package id of the client

Responses

  • 200 application/json

    Returns a single ShortLink with the given id

    Hide response attributes Show response attributes object
    • full_url string
    • id integer
    • short_text string
    • long_text string
    • description string
    • content_type string
    • utm_id string
    • utm_source string
    • utm_medium string
    • utm_campaign string
    • utm_term string
    • utm_content string
    • tracking_provider string
    • archived boolean
    • clicks_today integer
    • clicks_week integer
    • clicks_year integer
    • search_string string
    • created string(date-time)
    • updated string(date-time)
GET /api/servermanagement/shortlink/{id}
curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/servermanagement/shortlink/{id}' \
 --header "x-session-token: $API_KEY"
Response examples (200)
{
  "full_url": "string",
  "id": 42,
  "short_text": "string",
  "long_text": "string",
  "description": "string",
  "content_type": "string",
  "utm_id": "string",
  "utm_source": "string",
  "utm_medium": "string",
  "utm_campaign": "string",
  "utm_term": "string",
  "utm_content": "string",
  "tracking_provider": "string",
  "archived": true,
  "clicks_today": 42,
  "clicks_week": 42,
  "clicks_year": 42,
  "search_string": "string",
  "created": "2025-05-04T09:42:00Z",
  "updated": "2025-05-04T09:42:00Z"
}