Zum Inhalt springen
Developer

CRMPerson

CRM22 EndpunkteCRM / CRMPerson

Liefert eine Liste der Personen.

GET/api/crm/crmpeople

Query-Parameter

archivedbooleanStandardwert: false
hasLoginUserboolean
subscribedNewsletterboolean
subscribedMagazineboolean
logBookStaffboolean
logBookStaff1boolean
logBookStaff2boolean
logBookMemberboolean
logBookTrainerboolean
logBookTrainer1boolean
logBookTrainer2boolean
logBookHeadOfDepartmentboolean
logBookSupervisoryBoardboolean
logBookBoardOfDirectorsboolean
logBookHonoraryMemberboolean
logBookClubCardOneboolean
logBookHealthRecoveredboolean
logBookHealthVaccinatedboolean
logBookHealthVaccinatedAdditionstring
logBookGoodConductboolean
logBookFirstAidboolean
logBookMeaslesVaccinationboolean
birthdaystring
formOfSalutationstring
specialSalutationstring
languagestring
positionstring
titlestring
genderstring
numberStringstring
manualNumberstring
numberstring
firstNamestring
lastNamestring
importOriginIdstring
startTimestring
endTimestring
createdstring
bitmaskLogBookContentTypestringBitmask-Wert der verschiedenen Inhaltstypen des Personen-Logbuchs | Benötigtes Zugriffsrecht: SCOPE
categorystring
confirmedNoAllergiesstring
knownAllergiesstring
allowPhotosstring
allowLeavingAlonestring
authorizedPickupstring
needsSupportstring
supportDescriptionstring
financialSupportstring
financialSupportNumberstring
municipalSupportstring
municipalSupportNumberstring
gradeLevelstring
schoolClassstring
linkingIdentifierstring
addressStreetstring
addressHouseNumberstring
addressStreetLevelstring
addressCostring
addressCitystring
addressZipstring
addressAdminLevel1string
addressCountrystring
addressFullCountrystring
addressGeoLatstring
addressGeoLngstring
addressExternalProviderIdstringFeld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE | Erforderliches Zugriffsrecht: SCOPE
aiChurnRiskScorestringKündigungsrisiko 0-100 aus der KI-Bewertung (MemberChurnRiskHelper); nur für das Team. | Benötigt Zugriffs-Tag: SCOPE
searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

200Liefert eine Liste der Personen.array<CRMPerson>

Felder anzeigen (23)
  • idinteger

    Primärschlüssel der Person. Interne ID.

  • first_namestring

    Vorname der Person.

  • last_namestring

    Nachname der Person.

  • numberinteger

    Mitglieds- oder Kundennummer der Person.

  • number_stringstring

    Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

  • genderstring

    Geschlecht der Person.

  • titlestring

    Akademischer oder sonstiger Titel der Person.

  • languagestring

    Bevorzugte Sprache der Person.

  • birthdaystring (date-time)

    Geburtstag der Person.

  • known_allergiesstring

    Bekannte Allergien der Person.

  • confirmed_no_allergiesboolean

    Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

  • allow_photosboolean

    Fotos der Person dürfen aufgenommen und veröffentlicht werden.

  • allow_leaving_aloneboolean

    Die Person darf die Veranstaltung allein verlassen.

  • authorized_pickupstring

    Personen, die die Person abholen dürfen.

  • needs_supportboolean

    Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.

  • support_descriptionstring

    Beschreibung der Unterstützung, die die Person benötigt.

  • grade_levelinteger

    Schuljahrgang der Person.

  • school_classstring

    Schulklasse der Person.

  • start_timestring (date-time)

    Beginn der Mitgliedschaft oder Aktivität.

  • end_timestring (date-time)

    Ende der Mitgliedschaft oder Aktivität.

  • nicknamestring

    Spitzname der Person.

  • preferred_color_hexstring

    Bevorzugte Farbe der Person als Hexwert.

  • avatar_tokenstring

    Token des Avatarbildes.

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
[
  {
    "id": 42,
    "first_name": "Lena",
    "last_name": "Hartmann",
    "title": "Beispiel",
    "language": "de",
    "support_description": "Text",
    "number": 1,
    "number_string": "string",
    "gender": "string",
    "birthday": "2026-10-15T09:30:00+02:00"
  }
]

Neue Person anlegen

POST/api/crm/crmpeople

Request-Body application/json

  • crmpersonCRMPerson3
    Felder anzeigen (21)
    • categoryCRMPersonCategory2

      Personenkategorie.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

    • notestring

      Diese Eigenschaft wird verwendet, um eine Notiz zu einer Entität zu speichern

    • fixed_price_addon_onenumber (float)

      Preis der ersten Festpreis-Zusatzleistung.

    • fixed_price_addon_twonumber (float)

      Preis der zweiten Festpreis-Zusatzleistung.

    • use_in_aiboolean

      Diese Eigenschaft markiert eine Entität für die Synchronisierung mit einem RAG.

    • only_personal_aiboolean

      Diese Eigenschaft wird verwendet, um nur die Daten für die persönliche KI einzuschließen.

    • created_fromstring

      Dieses Feld dient zur Speicherung der Herkunft der Entität, etwa „import“, „ticket“ oder „manual“. Wird vor allem für Statistik- und Nachverfolgungszwecke verwendet.

Antworten

200Neue Person anlegenCRMPerson10

Felder anzeigen (81)
  • idinteger

    Primärschlüssel der Person. Interne ID.

  • first_namestring

    Vorname der Person.

  • last_namestring

    Nachname der Person.

  • numberinteger

    Mitglieds- oder Kundennummer der Person.

  • manual_numberinteger

    Manuell gesetzte Nummer statt der automatischen Nummer.

  • number_stringstring

    Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

  • genderstring

    Geschlecht der Person.

  • titlestring

    Akademischer oder sonstiger Titel der Person.

  • positionstring

    Position oder Rolle der Person.

  • languagestring

    Bevorzugte Sprache der Person.

  • special_salutationstring

    Besonderer Anredetext für Briefe.

  • form_of_salutationstring

    Form der Anrede, zum Beispiel förmlich oder informell.

  • birthdaystring (date-time)

    Geburtstag der Person.

  • known_allergiesstring

    Bekannte Allergien der Person.

  • confirmed_no_allergiesboolean

    Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

  • allow_photosboolean

    Fotos der Person dürfen aufgenommen und veröffentlicht werden.

  • allow_leaving_aloneboolean

    Die Person darf die Veranstaltung allein verlassen.

  • authorized_pickupstring

    Personen, die die Person abholen dürfen.

  • needs_supportboolean

    Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.

  • support_descriptionstring

    Beschreibung der Unterstützung, die die Person benötigt.

  • financial_supportboolean

    Die Person erhält finanzielle Unterstützung.

  • financial_support_numberstring

    Nummer der finanziellen Förderung.

  • municipal_supportboolean

    Die Person erhält kommunale Unterstützung.

  • municipal_support_numberstring

    Nummer der kommunalen Förderung.

  • grade_levelinteger

    Schuljahrgang der Person.

  • school_classstring

    Schulklasse der Person.

  • start_timestring (date-time)

    Beginn der Mitgliedschaft oder Aktivität.

  • start_time_reasonstring

    Grund für den Beginn.

  • end_timestring (date-time)

    Ende der Mitgliedschaft oder Aktivität.

  • end_time_reasonstring

    Grund für das Ende.

  • confirmed_gtc_timestring (date-time)

    Zeitpunkt, zu dem die AGB bestätigt wurden.

  • chatbot_opt_inboolean

    Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.

  • chatbot_opt_in_atstring (date-time)

    Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.

  • chatbot_opt_in_text_versionstring

    Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

  • app_usage_statistics_opt_outboolean

    Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.

  • crm_person_contact_dataarray<CRMPersonContactData>

    Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Kontaktdaten-Eintrags. Interne ID.

    • namestring

      Name des Kontaktdateneintrags.

    • valuestring

      Wert des Kontaktdateneintrags, z. B. eine Telefonnummer oder E-Mail-Adresse.

    • generated_valuestring

      Aus dem eingegebenen Wert erzeugter Wert.

    • contact_data_typeContactDataType

      Art der Kontaktdaten.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • archivedboolean

    Ob die Person archiviert ist.

  • subscribed_newsletterboolean

    Ob die Person den Newsletter abonniert hat.

  • subscribed_magazineboolean

    Ob die Person das Magazin abonniert hat.

  • printed_member_cardboolean

    Ob für die Person ein Mitgliedsausweis gedruckt wurde.

  • has_login_userboolean

    Ob die Person einen Anmelde-Benutzer hat.

  • profile_picture_urlstring

    URL des Profilbilds der Person.

  • log_book_staffboolean

    Logbuch-Kennzeichen: Personal.

  • log_book_staff1boolean

    Logbuch-Kennzeichen: Personal, Stufe 1.

  • log_book_staff2boolean

    Logbuch-Kennzeichen: Personal, Stufe 2.

  • log_book_memberboolean

    Logbuch-Kennzeichen: Mitglied.

  • log_book_trainerboolean

    Logbuch-Kennzeichen: Trainer.

  • log_book_trainer1boolean

    Logbuch-Kennzeichen: Trainer, Stufe 1.

  • log_book_trainer2boolean

    Logbuch-Kennzeichen: Trainer, Stufe 2.

  • log_book_head_of_departmentboolean

    Logbuch-Kennzeichen: Abteilungsleitung.

  • log_book_supervisory_boardboolean

    Logbuch-Kennzeichen: Aufsichtsrat.

  • log_book_board_of_directorsboolean

    Logbuch-Kennzeichen: Vorstand.

  • log_book_honorary_memberboolean

    Logbuch-Kennzeichen: Ehrenmitglied.

  • log_book_club_card_oneboolean

    Logbuch-Kennzeichen: Vereinskarte.

  • log_book_health_recoveredboolean

    Logbuch-Kennzeichen: von Krankheit genesen.

  • log_book_health_vaccinatedboolean

    Logbuch-Kennzeichen: geimpft.

  • log_book_health_vaccinated_additionstring

    Details der Impfung.

  • log_book_good_conductboolean

    Logbuch-Kennzeichen: Führungszeugnis.

  • log_book_first_aidboolean

    Logbuch-Kennzeichen: Erste-Hilfe-Schulung.

  • log_book_measles_vaccinationboolean

    Logbuch-Kennzeichen: Masernimpfung.

  • sync_lanistaboolean

    Ob die Person mit Lanista synchronisiert ist.

  • categoryCRMPersonCategory

    Personenkategorie.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel der Personenkategorie. Interne ID.

    • namestring

      Name der Personenkategorie.

    • name_pluralstring

      Pluralbezeichnung der Personenkategorie.

    • descriptionstring

      Beschreibung der Personenkategorie.

    • deletedboolean

      Die Kategorie ist gelöscht.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • enabled_customer_create_newboolean

      Personen dieser Kategorie dürfen in der Kunden-App neue Personen anlegen.

    • customer_register_min_numberinteger

      Mindestanzahl Personen, die gemeinsam angemeldet werden können.

    • customer_add_ignore_invite_codeboolean

      Personen können ohne Einladungscode hinzugefügt werden.

    • customer_ui_allowed_ticket_typesstring

      Ticketarten, die Kunden in der Kunden-App anlegen dürfen.

    • enabled_customer_ui_selectionboolean

      Kunden können die Kategorie in der Kunden-App auswählen.

    • orderinteger

      Position des Datensatzes in der Reihenfolge.

  • nicknamestring

    Spitzname der Person.

  • preferred_color_hexstring

    Bevorzugte Farbe der Person als Hexwert.

  • avatar_tokenstring

    Token des Avatarbildes.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • … 2 weitere Felder
Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "crmperson": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "address": "string"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "title": "Beispiel",
  "language": "de",
  "support_description": "Text",
  "profile_picture_url": "https://vynst.de",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163"
}

Gibt eine einzelne Person mit der angegebenen ID zurück.

GET/api/crm/crmpeople/{id}

Pfad-Parameter

idPflichtstring

Antworten

200Gibt eine einzelne Person mit der angegebenen ID zurück.CRMPerson10

Felder anzeigen (81)
  • idinteger

    Primärschlüssel der Person. Interne ID.

  • first_namestring

    Vorname der Person.

  • last_namestring

    Nachname der Person.

  • numberinteger

    Mitglieds- oder Kundennummer der Person.

  • manual_numberinteger

    Manuell gesetzte Nummer statt der automatischen Nummer.

  • number_stringstring

    Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

  • genderstring

    Geschlecht der Person.

  • titlestring

    Akademischer oder sonstiger Titel der Person.

  • positionstring

    Position oder Rolle der Person.

  • languagestring

    Bevorzugte Sprache der Person.

  • special_salutationstring

    Besonderer Anredetext für Briefe.

  • form_of_salutationstring

    Form der Anrede, zum Beispiel förmlich oder informell.

  • birthdaystring (date-time)

    Geburtstag der Person.

  • known_allergiesstring

    Bekannte Allergien der Person.

  • confirmed_no_allergiesboolean

    Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

  • allow_photosboolean

    Fotos der Person dürfen aufgenommen und veröffentlicht werden.

  • allow_leaving_aloneboolean

    Die Person darf die Veranstaltung allein verlassen.

  • authorized_pickupstring

    Personen, die die Person abholen dürfen.

  • needs_supportboolean

    Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.

  • support_descriptionstring

    Beschreibung der Unterstützung, die die Person benötigt.

  • financial_supportboolean

    Die Person erhält finanzielle Unterstützung.

  • financial_support_numberstring

    Nummer der finanziellen Förderung.

  • municipal_supportboolean

    Die Person erhält kommunale Unterstützung.

  • municipal_support_numberstring

    Nummer der kommunalen Förderung.

  • grade_levelinteger

    Schuljahrgang der Person.

  • school_classstring

    Schulklasse der Person.

  • start_timestring (date-time)

    Beginn der Mitgliedschaft oder Aktivität.

  • start_time_reasonstring

    Grund für den Beginn.

  • end_timestring (date-time)

    Ende der Mitgliedschaft oder Aktivität.

  • end_time_reasonstring

    Grund für das Ende.

  • confirmed_gtc_timestring (date-time)

    Zeitpunkt, zu dem die AGB bestätigt wurden.

  • chatbot_opt_inboolean

    Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.

  • chatbot_opt_in_atstring (date-time)

    Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.

  • chatbot_opt_in_text_versionstring

    Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

  • app_usage_statistics_opt_outboolean

    Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.

  • crm_person_contact_dataarray<CRMPersonContactData>

    Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Kontaktdaten-Eintrags. Interne ID.

    • namestring

      Name des Kontaktdateneintrags.

    • valuestring

      Wert des Kontaktdateneintrags, z. B. eine Telefonnummer oder E-Mail-Adresse.

    • generated_valuestring

      Aus dem eingegebenen Wert erzeugter Wert.

    • contact_data_typeContactDataType

      Art der Kontaktdaten.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • archivedboolean

    Ob die Person archiviert ist.

  • subscribed_newsletterboolean

    Ob die Person den Newsletter abonniert hat.

  • subscribed_magazineboolean

    Ob die Person das Magazin abonniert hat.

  • printed_member_cardboolean

    Ob für die Person ein Mitgliedsausweis gedruckt wurde.

  • has_login_userboolean

    Ob die Person einen Anmelde-Benutzer hat.

  • profile_picture_urlstring

    URL des Profilbilds der Person.

  • log_book_staffboolean

    Logbuch-Kennzeichen: Personal.

  • log_book_staff1boolean

    Logbuch-Kennzeichen: Personal, Stufe 1.

  • log_book_staff2boolean

    Logbuch-Kennzeichen: Personal, Stufe 2.

  • log_book_memberboolean

    Logbuch-Kennzeichen: Mitglied.

  • log_book_trainerboolean

    Logbuch-Kennzeichen: Trainer.

  • log_book_trainer1boolean

    Logbuch-Kennzeichen: Trainer, Stufe 1.

  • log_book_trainer2boolean

    Logbuch-Kennzeichen: Trainer, Stufe 2.

  • log_book_head_of_departmentboolean

    Logbuch-Kennzeichen: Abteilungsleitung.

  • log_book_supervisory_boardboolean

    Logbuch-Kennzeichen: Aufsichtsrat.

  • log_book_board_of_directorsboolean

    Logbuch-Kennzeichen: Vorstand.

  • log_book_honorary_memberboolean

    Logbuch-Kennzeichen: Ehrenmitglied.

  • log_book_club_card_oneboolean

    Logbuch-Kennzeichen: Vereinskarte.

  • log_book_health_recoveredboolean

    Logbuch-Kennzeichen: von Krankheit genesen.

  • log_book_health_vaccinatedboolean

    Logbuch-Kennzeichen: geimpft.

  • log_book_health_vaccinated_additionstring

    Details der Impfung.

  • log_book_good_conductboolean

    Logbuch-Kennzeichen: Führungszeugnis.

  • log_book_first_aidboolean

    Logbuch-Kennzeichen: Erste-Hilfe-Schulung.

  • log_book_measles_vaccinationboolean

    Logbuch-Kennzeichen: Masernimpfung.

  • sync_lanistaboolean

    Ob die Person mit Lanista synchronisiert ist.

  • categoryCRMPersonCategory

    Personenkategorie.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel der Personenkategorie. Interne ID.

    • namestring

      Name der Personenkategorie.

    • name_pluralstring

      Pluralbezeichnung der Personenkategorie.

    • descriptionstring

      Beschreibung der Personenkategorie.

    • deletedboolean

      Die Kategorie ist gelöscht.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • enabled_customer_create_newboolean

      Personen dieser Kategorie dürfen in der Kunden-App neue Personen anlegen.

    • customer_register_min_numberinteger

      Mindestanzahl Personen, die gemeinsam angemeldet werden können.

    • customer_add_ignore_invite_codeboolean

      Personen können ohne Einladungscode hinzugefügt werden.

    • customer_ui_allowed_ticket_typesstring

      Ticketarten, die Kunden in der Kunden-App anlegen dürfen.

    • enabled_customer_ui_selectionboolean

      Kunden können die Kategorie in der Kunden-App auswählen.

    • orderinteger

      Position des Datensatzes in der Reihenfolge.

  • nicknamestring

    Spitzname der Person.

  • preferred_color_hexstring

    Bevorzugte Farbe der Person als Hexwert.

  • avatar_tokenstring

    Token des Avatarbildes.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • … 2 weitere Felder
Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "title": "Beispiel",
  "language": "de",
  "support_description": "Text",
  "profile_picture_url": "https://vynst.de",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163"
}

Aktualisiert eine einzelne Person mit der angegebenen ID

PUT/api/crm/crmpeople/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • crmpersonCRMPerson3
    Felder anzeigen (21)
    • categoryCRMPersonCategory2

      Personenkategorie.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

    • notestring

      Diese Eigenschaft wird verwendet, um eine Notiz zu einer Entität zu speichern

    • fixed_price_addon_onenumber (float)

      Preis der ersten Festpreis-Zusatzleistung.

    • fixed_price_addon_twonumber (float)

      Preis der zweiten Festpreis-Zusatzleistung.

    • use_in_aiboolean

      Diese Eigenschaft markiert eine Entität für die Synchronisierung mit einem RAG.

    • only_personal_aiboolean

      Diese Eigenschaft wird verwendet, um nur die Daten für die persönliche KI einzuschließen.

    • created_fromstring

      Dieses Feld dient zur Speicherung der Herkunft der Entität, etwa „import“, „ticket“ oder „manual“. Wird vor allem für Statistik- und Nachverfolgungszwecke verwendet.

Antworten

200Aktualisiert eine einzelne Person mit der angegebenen IDCRMPerson10

Felder anzeigen (81)
  • idinteger

    Primärschlüssel der Person. Interne ID.

  • first_namestring

    Vorname der Person.

  • last_namestring

    Nachname der Person.

  • numberinteger

    Mitglieds- oder Kundennummer der Person.

  • manual_numberinteger

    Manuell gesetzte Nummer statt der automatischen Nummer.

  • number_stringstring

    Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

  • genderstring

    Geschlecht der Person.

  • titlestring

    Akademischer oder sonstiger Titel der Person.

  • positionstring

    Position oder Rolle der Person.

  • languagestring

    Bevorzugte Sprache der Person.

  • special_salutationstring

    Besonderer Anredetext für Briefe.

  • form_of_salutationstring

    Form der Anrede, zum Beispiel förmlich oder informell.

  • birthdaystring (date-time)

    Geburtstag der Person.

  • known_allergiesstring

    Bekannte Allergien der Person.

  • confirmed_no_allergiesboolean

    Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

  • allow_photosboolean

    Fotos der Person dürfen aufgenommen und veröffentlicht werden.

  • allow_leaving_aloneboolean

    Die Person darf die Veranstaltung allein verlassen.

  • authorized_pickupstring

    Personen, die die Person abholen dürfen.

  • needs_supportboolean

    Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.

  • support_descriptionstring

    Beschreibung der Unterstützung, die die Person benötigt.

  • financial_supportboolean

    Die Person erhält finanzielle Unterstützung.

  • financial_support_numberstring

    Nummer der finanziellen Förderung.

  • municipal_supportboolean

    Die Person erhält kommunale Unterstützung.

  • municipal_support_numberstring

    Nummer der kommunalen Förderung.

  • grade_levelinteger

    Schuljahrgang der Person.

  • school_classstring

    Schulklasse der Person.

  • start_timestring (date-time)

    Beginn der Mitgliedschaft oder Aktivität.

  • start_time_reasonstring

    Grund für den Beginn.

  • end_timestring (date-time)

    Ende der Mitgliedschaft oder Aktivität.

  • end_time_reasonstring

    Grund für das Ende.

  • confirmed_gtc_timestring (date-time)

    Zeitpunkt, zu dem die AGB bestätigt wurden.

  • chatbot_opt_inboolean

    Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.

  • chatbot_opt_in_atstring (date-time)

    Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.

  • chatbot_opt_in_text_versionstring

    Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

  • app_usage_statistics_opt_outboolean

    Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.

  • crm_person_contact_dataarray<CRMPersonContactData>

    Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Kontaktdaten-Eintrags. Interne ID.

    • namestring

      Name des Kontaktdateneintrags.

    • valuestring

      Wert des Kontaktdateneintrags, z. B. eine Telefonnummer oder E-Mail-Adresse.

    • generated_valuestring

      Aus dem eingegebenen Wert erzeugter Wert.

    • contact_data_typeContactDataType

      Art der Kontaktdaten.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • archivedboolean

    Ob die Person archiviert ist.

  • subscribed_newsletterboolean

    Ob die Person den Newsletter abonniert hat.

  • subscribed_magazineboolean

    Ob die Person das Magazin abonniert hat.

  • printed_member_cardboolean

    Ob für die Person ein Mitgliedsausweis gedruckt wurde.

  • has_login_userboolean

    Ob die Person einen Anmelde-Benutzer hat.

  • profile_picture_urlstring

    URL des Profilbilds der Person.

  • log_book_staffboolean

    Logbuch-Kennzeichen: Personal.

  • log_book_staff1boolean

    Logbuch-Kennzeichen: Personal, Stufe 1.

  • log_book_staff2boolean

    Logbuch-Kennzeichen: Personal, Stufe 2.

  • log_book_memberboolean

    Logbuch-Kennzeichen: Mitglied.

  • log_book_trainerboolean

    Logbuch-Kennzeichen: Trainer.

  • log_book_trainer1boolean

    Logbuch-Kennzeichen: Trainer, Stufe 1.

  • log_book_trainer2boolean

    Logbuch-Kennzeichen: Trainer, Stufe 2.

  • log_book_head_of_departmentboolean

    Logbuch-Kennzeichen: Abteilungsleitung.

  • log_book_supervisory_boardboolean

    Logbuch-Kennzeichen: Aufsichtsrat.

  • log_book_board_of_directorsboolean

    Logbuch-Kennzeichen: Vorstand.

  • log_book_honorary_memberboolean

    Logbuch-Kennzeichen: Ehrenmitglied.

  • log_book_club_card_oneboolean

    Logbuch-Kennzeichen: Vereinskarte.

  • log_book_health_recoveredboolean

    Logbuch-Kennzeichen: von Krankheit genesen.

  • log_book_health_vaccinatedboolean

    Logbuch-Kennzeichen: geimpft.

  • log_book_health_vaccinated_additionstring

    Details der Impfung.

  • log_book_good_conductboolean

    Logbuch-Kennzeichen: Führungszeugnis.

  • log_book_first_aidboolean

    Logbuch-Kennzeichen: Erste-Hilfe-Schulung.

  • log_book_measles_vaccinationboolean

    Logbuch-Kennzeichen: Masernimpfung.

  • sync_lanistaboolean

    Ob die Person mit Lanista synchronisiert ist.

  • categoryCRMPersonCategory

    Personenkategorie.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel der Personenkategorie. Interne ID.

    • namestring

      Name der Personenkategorie.

    • name_pluralstring

      Pluralbezeichnung der Personenkategorie.

    • descriptionstring

      Beschreibung der Personenkategorie.

    • deletedboolean

      Die Kategorie ist gelöscht.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • enabled_customer_create_newboolean

      Personen dieser Kategorie dürfen in der Kunden-App neue Personen anlegen.

    • customer_register_min_numberinteger

      Mindestanzahl Personen, die gemeinsam angemeldet werden können.

    • customer_add_ignore_invite_codeboolean

      Personen können ohne Einladungscode hinzugefügt werden.

    • customer_ui_allowed_ticket_typesstring

      Ticketarten, die Kunden in der Kunden-App anlegen dürfen.

    • enabled_customer_ui_selectionboolean

      Kunden können die Kategorie in der Kunden-App auswählen.

    • orderinteger

      Position des Datensatzes in der Reihenfolge.

  • nicknamestring

    Spitzname der Person.

  • preferred_color_hexstring

    Bevorzugte Farbe der Person als Hexwert.

  • avatar_tokenstring

    Token des Avatarbildes.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • … 2 weitere Felder
Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "crmperson": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "address": "string"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "title": "Beispiel",
  "language": "de",
  "support_description": "Text",
  "profile_picture_url": "https://vynst.de",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163"
}

Aktualisiert eine einzelne Person mit der angegebenen ID

PATCH/api/crm/crmpeople/{id}

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • crmpersonCRMPerson3
    Felder anzeigen (21)
    • categoryCRMPersonCategory2

      Personenkategorie.

    • addressstring

      Adresse als Text.

    • address_streetstring

      Straße der Adresse.

    • address_house_numberstring

      Hausnummer der Adresse.

    • address_street_levelstring

      Straße und Hausnummer der Adresse.

    • address_costring

      Care-of-Zeile der Adresse.

    • address_citystring

      Ort der Adresse.

    • address_zipstring

      Postleitzahl der Adresse.

    • address_admin_level1string

      Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

    • address_countrystring

      Ländercode der Adresse.

    • address_full_countrystring

      Vollständiger Name des Landes der Adresse.

    • address_geo_latstring

      Breitengrad der Adresse.

    • address_geo_lngstring

      Längengrad der Adresse.

    • address_external_provider_idstring

      Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • ucatsarray<UnifiedCategory11>

      Vereinheitlichte Kategorien des Datensatzes.

    • notestring

      Diese Eigenschaft wird verwendet, um eine Notiz zu einer Entität zu speichern

    • fixed_price_addon_onenumber (float)

      Preis der ersten Festpreis-Zusatzleistung.

    • fixed_price_addon_twonumber (float)

      Preis der zweiten Festpreis-Zusatzleistung.

    • use_in_aiboolean

      Diese Eigenschaft markiert eine Entität für die Synchronisierung mit einem RAG.

    • only_personal_aiboolean

      Diese Eigenschaft wird verwendet, um nur die Daten für die persönliche KI einzuschließen.

    • created_fromstring

      Dieses Feld dient zur Speicherung der Herkunft der Entität, etwa „import“, „ticket“ oder „manual“. Wird vor allem für Statistik- und Nachverfolgungszwecke verwendet.

Antworten

200Aktualisiert eine einzelne Person mit der angegebenen IDCRMPerson10

Felder anzeigen (81)
  • idinteger

    Primärschlüssel der Person. Interne ID.

  • first_namestring

    Vorname der Person.

  • last_namestring

    Nachname der Person.

  • numberinteger

    Mitglieds- oder Kundennummer der Person.

  • manual_numberinteger

    Manuell gesetzte Nummer statt der automatischen Nummer.

  • number_stringstring

    Mitglieds- oder Kundennummer als Text, einschließlich Präfix.

  • genderstring

    Geschlecht der Person.

  • titlestring

    Akademischer oder sonstiger Titel der Person.

  • positionstring

    Position oder Rolle der Person.

  • languagestring

    Bevorzugte Sprache der Person.

  • special_salutationstring

    Besonderer Anredetext für Briefe.

  • form_of_salutationstring

    Form der Anrede, zum Beispiel förmlich oder informell.

  • birthdaystring (date-time)

    Geburtstag der Person.

  • known_allergiesstring

    Bekannte Allergien der Person.

  • confirmed_no_allergiesboolean

    Erziehungsberechtigte(r) bestätigt, dass keine bekannten Allergien vorliegen.

  • allow_photosboolean

    Fotos der Person dürfen aufgenommen und veröffentlicht werden.

  • allow_leaving_aloneboolean

    Die Person darf die Veranstaltung allein verlassen.

  • authorized_pickupstring

    Personen, die die Person abholen dürfen.

  • needs_supportboolean

    Die Person benötigt Unterstützung, zum Beispiel zur Inklusion.

  • support_descriptionstring

    Beschreibung der Unterstützung, die die Person benötigt.

  • financial_supportboolean

    Die Person erhält finanzielle Unterstützung.

  • financial_support_numberstring

    Nummer der finanziellen Förderung.

  • municipal_supportboolean

    Die Person erhält kommunale Unterstützung.

  • municipal_support_numberstring

    Nummer der kommunalen Förderung.

  • grade_levelinteger

    Schuljahrgang der Person.

  • school_classstring

    Schulklasse der Person.

  • start_timestring (date-time)

    Beginn der Mitgliedschaft oder Aktivität.

  • start_time_reasonstring

    Grund für den Beginn.

  • end_timestring (date-time)

    Ende der Mitgliedschaft oder Aktivität.

  • end_time_reasonstring

    Grund für das Ende.

  • confirmed_gtc_timestring (date-time)

    Zeitpunkt, zu dem die AGB bestätigt wurden.

  • chatbot_opt_inboolean

    Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das prüfbare Protokoll steht in ChatbotConsent.

  • chatbot_opt_in_atstring (date-time)

    Zeitpunkt, zu dem die Person dem Chatbot zugestimmt hat.

  • chatbot_opt_in_text_versionstring

    Version des Einwilligungstextes, dem zugestimmt wurde. Weicht sie von der aktuellen Version ab, ist das Opt-in abgelaufen.

  • app_usage_statistics_opt_outboolean

    Widerspruch gegen die anonyme Nutzungsstatistik der Mitglieder-App. Die App liest ihn aus den StaticData und schickt dann nichts mehr; die gezählten Aufrufe selbst haben keinen Bezug zur Person.

  • crm_person_contact_dataarray<CRMPersonContactData>

    Kontaktdaten der Person, zum Beispiel Telefon und E-Mail.

    Felder anzeigen (6)
    • idinteger

      Primärschlüssel des Kontaktdaten-Eintrags. Interne ID.

    • namestring

      Name des Kontaktdateneintrags.

    • valuestring

      Wert des Kontaktdateneintrags, z. B. eine Telefonnummer oder E-Mail-Adresse.

    • generated_valuestring

      Aus dem eingegebenen Wert erzeugter Wert.

    • contact_data_typeContactDataType

      Art der Kontaktdaten.

    • search_stringstring

      Text, unter dem die Entität gesucht werden kann.

  • archivedboolean

    Ob die Person archiviert ist.

  • subscribed_newsletterboolean

    Ob die Person den Newsletter abonniert hat.

  • subscribed_magazineboolean

    Ob die Person das Magazin abonniert hat.

  • printed_member_cardboolean

    Ob für die Person ein Mitgliedsausweis gedruckt wurde.

  • has_login_userboolean

    Ob die Person einen Anmelde-Benutzer hat.

  • profile_picture_urlstring

    URL des Profilbilds der Person.

  • log_book_staffboolean

    Logbuch-Kennzeichen: Personal.

  • log_book_staff1boolean

    Logbuch-Kennzeichen: Personal, Stufe 1.

  • log_book_staff2boolean

    Logbuch-Kennzeichen: Personal, Stufe 2.

  • log_book_memberboolean

    Logbuch-Kennzeichen: Mitglied.

  • log_book_trainerboolean

    Logbuch-Kennzeichen: Trainer.

  • log_book_trainer1boolean

    Logbuch-Kennzeichen: Trainer, Stufe 1.

  • log_book_trainer2boolean

    Logbuch-Kennzeichen: Trainer, Stufe 2.

  • log_book_head_of_departmentboolean

    Logbuch-Kennzeichen: Abteilungsleitung.

  • log_book_supervisory_boardboolean

    Logbuch-Kennzeichen: Aufsichtsrat.

  • log_book_board_of_directorsboolean

    Logbuch-Kennzeichen: Vorstand.

  • log_book_honorary_memberboolean

    Logbuch-Kennzeichen: Ehrenmitglied.

  • log_book_club_card_oneboolean

    Logbuch-Kennzeichen: Vereinskarte.

  • log_book_health_recoveredboolean

    Logbuch-Kennzeichen: von Krankheit genesen.

  • log_book_health_vaccinatedboolean

    Logbuch-Kennzeichen: geimpft.

  • log_book_health_vaccinated_additionstring

    Details der Impfung.

  • log_book_good_conductboolean

    Logbuch-Kennzeichen: Führungszeugnis.

  • log_book_first_aidboolean

    Logbuch-Kennzeichen: Erste-Hilfe-Schulung.

  • log_book_measles_vaccinationboolean

    Logbuch-Kennzeichen: Masernimpfung.

  • sync_lanistaboolean

    Ob die Person mit Lanista synchronisiert ist.

  • categoryCRMPersonCategory

    Personenkategorie.

    Felder anzeigen (12)
    • idinteger

      Primärschlüssel der Personenkategorie. Interne ID.

    • namestring

      Name der Personenkategorie.

    • name_pluralstring

      Pluralbezeichnung der Personenkategorie.

    • descriptionstring

      Beschreibung der Personenkategorie.

    • deletedboolean

      Die Kategorie ist gelöscht.

    • is_publicboolean

      Die Kategorie wird öffentlich angezeigt.

    • enabled_customer_create_newboolean

      Personen dieser Kategorie dürfen in der Kunden-App neue Personen anlegen.

    • customer_register_min_numberinteger

      Mindestanzahl Personen, die gemeinsam angemeldet werden können.

    • customer_add_ignore_invite_codeboolean

      Personen können ohne Einladungscode hinzugefügt werden.

    • customer_ui_allowed_ticket_typesstring

      Ticketarten, die Kunden in der Kunden-App anlegen dürfen.

    • enabled_customer_ui_selectionboolean

      Kunden können die Kategorie in der Kunden-App auswählen.

    • orderinteger

      Position des Datensatzes in der Reihenfolge.

  • nicknamestring

    Spitzname der Person.

  • preferred_color_hexstring

    Bevorzugte Farbe der Person als Hexwert.

  • avatar_tokenstring

    Token des Avatarbildes.

  • search_stringstring

    Text, unter dem die Entität gesucht werden kann.

  • addressstring

    Adresse als Text.

  • address_streetstring

    Straße der Adresse.

  • address_house_numberstring

    Hausnummer der Adresse.

  • address_street_levelstring

    Straße und Hausnummer der Adresse.

  • address_costring

    Care-of-Zeile der Adresse.

  • address_citystring

    Ort der Adresse.

  • address_zipstring

    Postleitzahl der Adresse.

  • address_admin_level1string

    Erste Verwaltungsebene der Adresse, z. B. das Bundesland.

  • address_countrystring

    Ländercode der Adresse.

  • address_full_countrystring

    Vollständiger Name des Landes der Adresse.

  • address_geo_latstring

    Breitengrad der Adresse.

  • address_geo_lngstring

    Längengrad der Adresse.

  • address_external_provider_idstring

    Feld zur Speicherung der externen Anbieter-ID der Adresse, z. B. Google-Maps-PlaceID wie google:ChIJVcKw5r90sEcRhdjNq6NItqE

  • createdstring (date-time)

    Zeitpunkt, zu dem der Datensatz angelegt wurde.

  • … 2 weitere Felder
Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "crmperson": {
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "address": "string"
  }
}
'
Antwort 200 application/json
{
  "id": 42,
  "first_name": "Lena",
  "last_name": "Hartmann",
  "title": "Beispiel",
  "language": "de",
  "support_description": "Text",
  "profile_picture_url": "https://vynst.de",
  "address_street": "Jakobistr. 39",
  "address_city": "Hannover",
  "address_zip": "30163"
}

Archiviert das vollständige Schulkonto, wenn die ausgewählte Person das einzige aktive Kind ist.

POST/api/crm/crmpeople/{id}/archive_account

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • companyIdstringPflicht

    CRMCompany-ID oder Kennung

Antworten

200Liefert die IDs der archivierten Konten und Personen

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople/42/archive_account \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "companyId": "string"
}
'
Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople/42/own_company \
  --header 'x-iw-jwt-token: <TOKEN>'

Liefert aktive Schulkonten, für die die ausgewählte Person das einzige aktive Kind ist.

GET/api/crm/crmpeople/{id}/archive_account_candidates

Pfad-Parameter

idPflichtstring

Antworten

200Liefert die IDs und Namen der berechtigten Konten

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople/42/archive_account_candidates \
  --header 'x-iw-jwt-token: <TOKEN>'

Eine oder mehrere Personen in die angegebene Hauptperson zusammenführen.

POST/api/crm/crmpeople/{id}/merge

Migriert Tickets (alle), Fragebogenantworten, Veranstaltungsanmeldungen, einzelne Buchungen und Logbucheinträge (Mitgliedschaften / Funktionen / Rollen) von den Quellpersonen auf die Hauptperson (die letzten vier mit Dublettenprüfung) und archiviert die migrierten Quellpersonen. Die Firma jedes migrierten Datensatzes bleibt erhalten, wenn die Hauptperson ihr bereits angehört; andernfalls wird sie durch die Hauptfirma der Hauptperson ersetzt. Im SCHOOL-Modus muss jede Quellperson eine Schule (vereinheitlichte Kategorie eines Logbucheintrags) mit der Hauptperson teilen, andernfalls wird die Anfrage mit einem 400 abgelehnt.

Request-Body:

  • ids (int[]): IDs der Personen, die in die Hauptperson zusammengeführt werden sollen
  • includeContactData (bool, optional): E-Mail-Adressen / Telefonnummern aus Quellpersonen übernehmen
  • copyScalarFields (bool, optional): skalare Personendatenfelder (Geburtstag, Geschlecht, Adresse, Schuldaten, ...) aus Quellpersonen kopieren, wenn das Feld der Hauptperson leer ist

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • idsarray<integer>

    IDs der Personen, die in die Hauptperson zusammengeführt werden sollen

  • includeContactDataboolean

    Kontaktdaten (E-Mail-Adressen / Telefonnummern) aus den Quellpersonen übernehmen

  • copyScalarFieldsboolean

    Skalare Personendatenfelder aus Quellpersonen kopieren, wenn das Feld der Hauptperson leer ist

Antworten

200Liefert die Statistik des Zusammenführungsergebnisses

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople/42/merge \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "ids": [
    1
  ],
  "includeContactData": true,
  "copyScalarFields": true
}
'

Vorschau einer DSGVO-Löschung (Art. 17) der Person: was sie blockiert und welche Daten gelöscht, anonymisiert oder aufgrund gesetzlicher Aufbewahrungsfristen beibehalten würden.

GET/api/crm/crmpeople/{id}/gdpr_erasure

Pfad-Parameter

idPflichtstring

Antworten

200Liefert die Sperrgründe und die betroffenen Daten (Positionen) einer DSGVO-Löschung

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople/42/gdpr_erasure \
  --header 'x-iw-jwt-token: <TOKEN>'

Führt die DSGVO-Löschung (Art. 17 DSGVO) der Person aus. Die Person wird anonymisiert und archiviert, ihre personenbezogenen Daten (Kontaktdaten, Login, Anhänge, Kommunikation, Kopien in Anmeldungen / Buchungen / Tickets, Änderungsverlauf) werden gelöscht. Buchhaltungsbelege bleiben erhalten. Nicht umkehrbar.

POST/api/crm/crmpeople/{id}/gdpr_erasure

Pfad-Parameter

idPflichtstring

Request-Body application/json

  • confirmbooleanPflicht

    Muss true sein, die Löschung kann nicht rückgängig gemacht werden

Antworten

200Liefert, was gelöscht, anonymisiert und aufbewahrt wurde

Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople/42/gdpr_erasure \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{"confirm":true}'

Liefert die Liste der doppelten Personen, gruppiert nach Name und Geburtstag.

GET/api/crm/crmpeople/duplicates

Jede Gruppe enthält das vorgeschlagene Zusammenführungsziel (die Person mit einem aktiven Login-Benutzer bzw. Zugang zum Kundenportal, sonst die Person mit der letzten Aktivität) sowie pro Person Kontextinformationen (verknüpfte Firmen, aktive Veranstaltungsanmeldungen und aktive Mitgliedschaften / Funktionen / Rollen).

Query-Parameter

includeArchivedbooleanArchivierte Personen in die Dublettenerkennung einbeziehen | Standardwert: true
schoolModebooleanSchulmodus überschreiben, der aus der Einstellung inwendo_short_info_mode abgeleitet wird
unifiedCategoryIdintegerDublettenerkennung auf eine einzige einheitliche Kategorie beschränken (Schulmodus)
ucatsstringErsatzwert für unifiedCategoryId, akzeptiert den kommagetrennten Kategoriefilter der Personenliste

Antworten

200Liefert die Liste der doppelten Personengruppen

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople/duplicates \
  --header 'x-iw-jwt-token: <TOKEN>'

Liefert die aktuell verfügbaren Zugriffs-Tags einer Person, gruppiert nach Unternehmen.

GET/api/crm/crmpeople/{id}/access_tags

Neben den wirksamen AccessTags enthält die Antwort die Herkunft jedes einzelnen Tags (Firma, Abonnement, Logbucheintrag / Rolle oder temporärer Zugang). Damit lässt sich beantworten, warum eine Person dieses Zugriffsrecht hat.

Pfad-Parameter

idPflichtstring

Query-Parameter

companyIdstringOptionale CRMCompany-ID oder Kurzkennung, um die Berechnung auf eine der Firmen der Person zu beschränken

Antworten

200Liefert die verfügbaren Zugriffs-Tags der Person

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/crmpeople/42/access_tags \
  --header 'x-iw-jwt-token: <TOKEN>'

Liefert eine Liste der Personen mit passender Verknüpfungskennung.

GET/api/crm/linked_person

Query-Parameter

searchStringstringText, nach dem in der Liste gesucht wird
orderFieldNamestringName des Bestellfelds
orderFieldSortstringSortiermodusErlaubt: DESCASC
pageintegerSeite der Liste
pageSizeintegerAnzahl der Einträge je Seite
withMaxPageNumberstringgibt die Anzahl verfügbarer Seiten als Header zurück, wenn dies gesetzt ist

Antworten

default

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/linked_person \
  --header 'x-iw-jwt-token: <TOKEN>'
Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/crm/linked_person \
  --header 'x-iw-jwt-token: <TOKEN>'
Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/crm/linked_person \
  --header 'x-iw-jwt-token: <TOKEN>'
Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/crm/linked_person \
  --header 'x-iw-jwt-token: <TOKEN>'
Anfrage
curl --request POST \
  --url https://eure-instanz.iw-erp.de/api/crm/multi_linked_person \
  --header 'x-iw-jwt-token: <TOKEN>'
Anfrage
curl --request PUT \
  --url https://eure-instanz.iw-erp.de/api/crm/multi_linked_person \
  --header 'x-iw-jwt-token: <TOKEN>'
Anfrage
curl --request PATCH \
  --url https://eure-instanz.iw-erp.de/api/crm/multi_linked_person \
  --header 'x-iw-jwt-token: <TOKEN>'

Gibt eine einzelne Person mit der angegebenen ID und passender Verknüpfungskennung zurück.

GET/api/crm/linked_person/{id}

Pfad-Parameter

idPflichtstring

Antworten

default

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/linked_person/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

Gibt einen Anmeldelink für die Person mit der angegebenen ID und passender Verknüpfungskennung zurück.

GET/api/crm/linked_person_sso/{id}

Pfad-Parameter

idPflichtstring

Antworten

default

Anfrage
curl --request GET \
  --url https://eure-instanz.iw-erp.de/api/crm/linked_person_sso/42 \
  --header 'x-iw-jwt-token: <TOKEN>'