Call

Smart home and automation6 EndpointsSipgateAPI / Call

Returns a list of SIPCall

GET/api/sip/calls

Query parameters

`comType`string
`comCreated`string
`comTitle`string
`comSearchString`string
`comDone`string
`comPersonExt`string
`comDepartmentExt`string
`comCompanyExt`string
`comProjectExt`string
`comPersonInt`string
`comDepartmentInt`string
`comCompanyInt`string
`comProjectInt`string
`incoming`boolean
`sip_id`string
`number_in`string
`crmperson_in_id`string
`crmdepartment_in_id`string
`crmcompany_in_id`string
`number_answering`string
`crmperson_answering_id`string
`crmdepartment_answering_id`string
`crmcompany_answering_id`string
`number_out`string
`crmperson_out_id`string
`crmdepartment_out_id`string
`crmcompany_out_id`string
`date_new`string
`date_answer`string
`date_hangup`string
`reason_hangup`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns a list of SIPCallarray<SIPCall>

Show fields (12)

idinteger
Primary key of the communication item. Internal ID.
com_typestring
Type of the communication item.
com_createdstring (date-time)
Point in time the item was created.
com_titlestring
Title of the communication item.
com_search_stringstring
Searchable text of the communication item.
com_doneboolean
Whether the item is done.
com_person_extCRMPerson10
External person the item refers to.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- 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 gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
com_department_extCRMDepartment
External department the item refers to.
Show fields (23)
- idinteger
  Primary key of the department. Internal ID.
- companiesarray<CRMCompany>
  Companies the department belongs to.
- personsarray<CRMPerson10>
  Persons assigned to the department.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
com_company_extCRMCompany
External company the item refers to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
com_project_extCRMProject14
External project the item refers to.
Show fields (19)
- idinteger
  Primary key of the project. Internal ID.
- namestring
  Name of the project.
- closedstring (date-time)
  Time the project was closed.
- billedstring (date-time)
  Time the project was billed.
- numberstring
  Number of the project.
- startstring (date-time)
  Start of the project.
- endstring (date-time)
  End of the project.
- descriptionstring
  Description of the project.
- companyCRMCompany
  Company the project belongs to.
- internal_main_contactUser14
  Internal login user who is the main contact.
- categoryCRMProjectCategory
  Category of the project.
- archivedboolean
  The project is archived.
- visible_for_customerboolean
  The project is visible in the customer app.
- name_for_customerstring
  Name of the project shown to customers.
- invoice_emailstring
  E-mail address for invoices of the project.
- time_report_emailstring
  E-mail address for time reports of the project.
- search_stringstring
  Text that the entity can be searched by.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
com_person_intCRMPerson10
Internal person the item refers to.
Show fields (13)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- … 70 more fields
… 15 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/sip/calls \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/sip/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/sip/calls"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/sip/calls', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/sip/calls"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/sip/calls")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/sip/calls"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/sip_call_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await SipCallController.getAll();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "com_title": "Beispiel",
    "com_type": "string",
    "com_created": "2026-10-15T09:30:00+02:00",
    "com_search_string": "string",
    "com_done": true,
    "com_person_ext": {
      "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"
    },
    "com_department_ext": {
      "id": 42,
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "name": "Beispiel",
      "main_phone": "+49 511 123456",
      "main_email": "lena.hartmann@example.org",
      "address": "string"
    },
    "com_company_ext": {
      "id": 42,
      "short_name": "Beispiel",
      "company_name": "Beispiel",
      "secondary_name": "Beispiel",
      "invoice_email": "lena.hartmann@example.org",
      "send_invoice_email": true,
      "time_report_email": "lena.hartmann@example.org",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "com_project_ext": {
      "id": 42,
      "name": "Beispiel",
      "description": "Text",
      "invoice_email": "lena.hartmann@example.org",
      "time_report_email": "lena.hartmann@example.org",
      "closed": "2026-10-15T09:30:00+02:00",
      "billed": "2026-10-15T09:30:00+02:00",
      "number": "string",
      "start": "2026-10-15T09:30:00+02:00",
      "end": "2026-10-15T09:30:00+02:00"
    }
  }
]

Start a SIPCall

POST/api/sip/calls

Request body application/json

callFormStartCall

Responses

200Start a SIPCallFormStartCall

Request

curl --request POST \
  --url https://your-instance.iw-erp.de/api/sip/calls \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '{}'

const options = {
  method: 'POST',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://your-instance.iw-erp.de/api/sip/calls', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/sip/calls"

payload = {}
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://your-instance.iw-erp.de/api/sip/calls', [
  'body' => '{}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Post,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/sip/calls"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/sip/calls")
  .post(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/sip/calls"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/sip_call_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/sip_device.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await SipCallController.post('…', SipDevice.fromJson({}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{}

Returns a single SIPCall with the given id

GET/api/sip/calls/{id}

Path parameters

idrequiredstring

Responses

200Returns a single SIPCall with the given idSIPCall2

Show fields (12)

idinteger
Primary key of the communication item. Internal ID.
com_typestring
Type of the communication item.
com_createdstring (date-time)
Point in time the item was created.
com_titlestring
Title of the communication item.
com_search_stringstring
Searchable text of the communication item.
com_doneboolean
Whether the item is done.
com_person_extCRMPerson10
External person the item refers to.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- 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 gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
com_department_extCRMDepartment
External department the item refers to.
Show fields (23)
- idinteger
  Primary key of the department. Internal ID.
- companiesarray<CRMCompany>
  Companies the department belongs to.
- personsarray<CRMPerson10>
  Persons assigned to the department.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
com_company_extCRMCompany
External company the item refers to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
com_project_extCRMProject15
External project the item refers to.
Show fields (19)
- idinteger
  Primary key of the project. Internal ID.
- namestring
  Name of the project.
- closedstring (date-time)
  Time the project was closed.
- billedstring (date-time)
  Time the project was billed.
- numberstring
  Number of the project.
- startstring (date-time)
  Start of the project.
- endstring (date-time)
  End of the project.
- descriptionstring
  Description of the project.
- companyCRMCompany
  Company the project belongs to.
- internal_main_contactUser14
  Internal login user who is the main contact.
- categoryCRMProjectCategory
  Category of the project.
- archivedboolean
  The project is archived.
- visible_for_customerboolean
  The project is visible in the customer app.
- name_for_customerstring
  Name of the project shown to customers.
- invoice_emailstring
  E-mail address for invoices of the project.
- time_report_emailstring
  E-mail address for time reports of the project.
- search_stringstring
  Text that the entity can be searched by.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
com_person_intCRMPerson10
Internal person the item refers to.
Show fields (13)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- … 70 more fields
… 24 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/sip/calls/42 \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/sip/calls/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/sip/calls/42"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/sip/calls/42', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/sip/calls/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/sip/calls/42")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/sip/calls/42"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/sip_call_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await SipCallController.get('42');
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "com_title": "Beispiel",
  "com_type": "string",
  "com_created": "2026-10-15T09:30:00+02:00",
  "com_search_string": "string",
  "com_done": true,
  "com_person_ext": {
    "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"
  },
  "com_department_ext": {
    "id": 42,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "name": "Beispiel",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "address": "string"
  },
  "com_company_ext": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "com_project_ext": {
    "id": 42,
    "name": "Beispiel",
    "description": "Text",
    "invoice_email": "lena.hartmann@example.org",
    "time_report_email": "lena.hartmann@example.org",
    "closed": "2026-10-15T09:30:00+02:00",
    "billed": "2026-10-15T09:30:00+02:00",
    "number": "string",
    "start": "2026-10-15T09:30:00+02:00",
    "end": "2026-10-15T09:30:00+02:00"
  }
}

Updates a single SIPCall

PUT/api/sip/calls/{id}

Path parameters

idrequiredstring

Request body application/json

callSIPCall3
Show fields (26)
- idinteger
  Primary key of the communication item. Internal ID.
- com_typestring
  Type of the communication item.
- com_createdstring (date-time)
  Point in time the item was created.
- com_titlestring
  Title of the communication item.
- com_search_stringstring
  Searchable text of the communication item.
- com_doneboolean
  Whether the item is done.
- com_person_extCRMPerson10
  External person the item refers to.
- com_department_extCRMDepartment
  External department the item refers to.
- com_company_extCRMCompany
  External company the item refers to.
- com_project_extCRMProject
  External project the item refers to.
- com_person_intCRMPerson10
  Internal person the item refers to.
- com_department_intCRMDepartment
  Internal department the item refers to.
- com_company_intCRMCompany
  Internal company the item refers to.
- com_project_intCRMProject
  Internal project the item refers to.
- search_stringstring
  Text that the entity can be searched by.
- incomingboolean
  Whether the call is incoming.
- sip_idstring
  ID of the call in the SIP system.
- number_instring
  Phone number of the caller.
- number_answeringstring
  Phone number that answered the call.
- number_outstring
  Phone number the call was made to.
- date_newstring (date-time)
  Point in time the call was received.
- date_answerstring (date-time)
  Point in time the call was answered.
- date_hangupstring (date-time)
  Point in time the call ended.
- reason_hangupstring
  Reason the call ended.
- slack_idstring
  ID of the Slack message that announces the call.
- messagestring
  Message of the call, e.g. the caller's message.

Responses

200Updates a single SIPCallSIPCall2

Show fields (12)

idinteger
Primary key of the communication item. Internal ID.
com_typestring
Type of the communication item.
com_createdstring (date-time)
Point in time the item was created.
com_titlestring
Title of the communication item.
com_search_stringstring
Searchable text of the communication item.
com_doneboolean
Whether the item is done.
com_person_extCRMPerson10
External person the item refers to.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- 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 gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
com_department_extCRMDepartment
External department the item refers to.
Show fields (23)
- idinteger
  Primary key of the department. Internal ID.
- companiesarray<CRMCompany>
  Companies the department belongs to.
- personsarray<CRMPerson10>
  Persons assigned to the department.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
com_company_extCRMCompany
External company the item refers to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
com_project_extCRMProject15
External project the item refers to.
Show fields (19)
- idinteger
  Primary key of the project. Internal ID.
- namestring
  Name of the project.
- closedstring (date-time)
  Time the project was closed.
- billedstring (date-time)
  Time the project was billed.
- numberstring
  Number of the project.
- startstring (date-time)
  Start of the project.
- endstring (date-time)
  End of the project.
- descriptionstring
  Description of the project.
- companyCRMCompany
  Company the project belongs to.
- internal_main_contactUser14
  Internal login user who is the main contact.
- categoryCRMProjectCategory
  Category of the project.
- archivedboolean
  The project is archived.
- visible_for_customerboolean
  The project is visible in the customer app.
- name_for_customerstring
  Name of the project shown to customers.
- invoice_emailstring
  E-mail address for invoices of the project.
- time_report_emailstring
  E-mail address for time reports of the project.
- search_stringstring
  Text that the entity can be searched by.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
com_person_intCRMPerson10
Internal person the item refers to.
Show fields (13)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- … 70 more fields
… 24 more fields

Request

curl --request PUT \
  --url https://your-instance.iw-erp.de/api/sip/calls/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "call": {
    "id": 42,
    "com_title": "Beispiel",
    "com_type": "string",
    "com_created": "2026-10-15T09:30:00+02:00",
    "com_search_string": "string",
    "com_done": true
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    call: {
      id: 42,
      com_title: 'Beispiel',
      com_type: 'string',
      com_created: '2026-10-15T09:30:00+02:00',
      com_search_string: 'string',
      com_done: true
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/sip/calls/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/sip/calls/42"

payload = { "call": {
    "id": 42,
    "com_title": "Beispiel",
    "com_type": "string",
    "com_created": "2026-10-15T09:30:00+02:00",
    "com_search_string": "string",
    "com_done": True
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://your-instance.iw-erp.de/api/sip/calls/42', [
  'body' => '{"call":{"id":42,"com_title":"Beispiel","com_type":"string","com_created":"2026-10-15T09:30:00+02:00","com_search_string":"string","com_done":true}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Put,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/sip/calls/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"call\":{\"id\":42,\"com_title\":\"Beispiel\",\"com_type\":\"string\",\"com_created\":\"2026-10-15T09:30:00+02:00\",\"com_search_string\":\"string\",\"com_done\":true}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"call\":{\"id\":42,\"com_title\":\"Beispiel\",\"com_type\":\"string\",\"com_created\":\"2026-10-15T09:30:00+02:00\",\"com_search_string\":\"string\",\"com_done\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/sip/calls/42")
  .put(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/sip/calls/42"

	payload := strings.NewReader("{\"call\":{\"id\":42,\"com_title\":\"Beispiel\",\"com_type\":\"string\",\"com_created\":\"2026-10-15T09:30:00+02:00\",\"com_search_string\":\"string\",\"com_done\":true}}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/sip_call_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';
import 'package:iw_erp_api/model/sip_call.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await SipCallController.put(SipCall.fromJson({
  "id": 42,
  "com_title": "Beispiel",
  "com_type": "string",
  "com_created": "2026-10-15T09:30:00+02:00",
  "com_search_string": "string",
  "com_done": true
}));
if (result.success) {
  print(result.data);
}

Response 200 application/json

{
  "id": 42,
  "com_title": "Beispiel",
  "com_type": "string",
  "com_created": "2026-10-15T09:30:00+02:00",
  "com_search_string": "string",
  "com_done": true,
  "com_person_ext": {
    "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"
  },
  "com_department_ext": {
    "id": 42,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "name": "Beispiel",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "address": "string"
  },
  "com_company_ext": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "com_project_ext": {
    "id": 42,
    "name": "Beispiel",
    "description": "Text",
    "invoice_email": "lena.hartmann@example.org",
    "time_report_email": "lena.hartmann@example.org",
    "closed": "2026-10-15T09:30:00+02:00",
    "billed": "2026-10-15T09:30:00+02:00",
    "number": "string",
    "start": "2026-10-15T09:30:00+02:00",
    "end": "2026-10-15T09:30:00+02:00"
  }
}

Updates a single SIPCall

PATCH/api/sip/calls/{id}

Path parameters

idrequiredstring

Request body application/json

callSIPCall3
Show fields (26)
- idinteger
  Primary key of the communication item. Internal ID.
- com_typestring
  Type of the communication item.
- com_createdstring (date-time)
  Point in time the item was created.
- com_titlestring
  Title of the communication item.
- com_search_stringstring
  Searchable text of the communication item.
- com_doneboolean
  Whether the item is done.
- com_person_extCRMPerson10
  External person the item refers to.
- com_department_extCRMDepartment
  External department the item refers to.
- com_company_extCRMCompany
  External company the item refers to.
- com_project_extCRMProject
  External project the item refers to.
- com_person_intCRMPerson10
  Internal person the item refers to.
- com_department_intCRMDepartment
  Internal department the item refers to.
- com_company_intCRMCompany
  Internal company the item refers to.
- com_project_intCRMProject
  Internal project the item refers to.
- search_stringstring
  Text that the entity can be searched by.
- incomingboolean
  Whether the call is incoming.
- sip_idstring
  ID of the call in the SIP system.
- number_instring
  Phone number of the caller.
- number_answeringstring
  Phone number that answered the call.
- number_outstring
  Phone number the call was made to.
- date_newstring (date-time)
  Point in time the call was received.
- date_answerstring (date-time)
  Point in time the call was answered.
- date_hangupstring (date-time)
  Point in time the call ended.
- reason_hangupstring
  Reason the call ended.
- slack_idstring
  ID of the Slack message that announces the call.
- messagestring
  Message of the call, e.g. the caller's message.

Responses

200Updates a single SIPCallSIPCall2

Show fields (12)

idinteger
Primary key of the communication item. Internal ID.
com_typestring
Type of the communication item.
com_createdstring (date-time)
Point in time the item was created.
com_titlestring
Title of the communication item.
com_search_stringstring
Searchable text of the communication item.
com_doneboolean
Whether the item is done.
com_person_extCRMPerson10
External person the item refers to.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- 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 gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
com_department_extCRMDepartment
External department the item refers to.
Show fields (23)
- idinteger
  Primary key of the department. Internal ID.
- companiesarray<CRMCompany>
  Companies the department belongs to.
- personsarray<CRMPerson10>
  Persons assigned to the department.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
com_company_extCRMCompany
External company the item refers to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
com_project_extCRMProject15
External project the item refers to.
Show fields (19)
- idinteger
  Primary key of the project. Internal ID.
- namestring
  Name of the project.
- closedstring (date-time)
  Time the project was closed.
- billedstring (date-time)
  Time the project was billed.
- numberstring
  Number of the project.
- startstring (date-time)
  Start of the project.
- endstring (date-time)
  End of the project.
- descriptionstring
  Description of the project.
- companyCRMCompany
  Company the project belongs to.
- internal_main_contactUser14
  Internal login user who is the main contact.
- categoryCRMProjectCategory
  Category of the project.
- archivedboolean
  The project is archived.
- visible_for_customerboolean
  The project is visible in the customer app.
- name_for_customerstring
  Name of the project shown to customers.
- invoice_emailstring
  E-mail address for invoices of the project.
- time_report_emailstring
  E-mail address for time reports of the project.
- search_stringstring
  Text that the entity can be searched by.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
com_person_intCRMPerson10
Internal person the item refers to.
Show fields (13)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- … 70 more fields
… 24 more fields

Request

curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/sip/calls/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "call": {
    "id": 42,
    "com_title": "Beispiel",
    "com_type": "string",
    "com_created": "2026-10-15T09:30:00+02:00",
    "com_search_string": "string",
    "com_done": true
  }
}
'

const options = {
  method: 'PATCH',
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: JSON.stringify({
    call: {
      id: 42,
      com_title: 'Beispiel',
      com_type: 'string',
      com_created: '2026-10-15T09:30:00+02:00',
      com_search_string: 'string',
      com_done: true
    }
  })
};

fetch('https://your-instance.iw-erp.de/api/sip/calls/42', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/sip/calls/42"

payload = { "call": {
    "id": 42,
    "com_title": "Beispiel",
    "com_type": "string",
    "com_created": "2026-10-15T09:30:00+02:00",
    "com_search_string": "string",
    "com_done": True
  } }
headers = {
  "x-iw-jwt-token": "<TOKEN>",
  "content-type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://your-instance.iw-erp.de/api/sip/calls/42', [
  'body' => '{"call":{"id":42,"com_title":"Beispiel","com_type":"string","com_created":"2026-10-15T09:30:00+02:00","com_search_string":"string","com_done":true}}',
  'headers' => [
    'content-type' => 'application/json',
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Patch,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/sip/calls/42"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
  Content = new StringContent("{\"call\":{\"id\":42,\"com_title\":\"Beispiel\",\"com_type\":\"string\",\"com_created\":\"2026-10-15T09:30:00+02:00\",\"com_search_string\":\"string\",\"com_done\":true}}")
  {
    Headers =
    {
      ContentType = new MediaTypeHeaderValue("application/json")
    }
  }
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"call\":{\"id\":42,\"com_title\":\"Beispiel\",\"com_type\":\"string\",\"com_created\":\"2026-10-15T09:30:00+02:00\",\"com_search_string\":\"string\",\"com_done\":true}}");
Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/sip/calls/42")
  .patch(body)
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .addHeader("content-type", "application/json")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/sip/calls/42"

	payload := strings.NewReader("{\"call\":{\"id\":42,\"com_title\":\"Beispiel\",\"com_type\":\"string\",\"com_created\":\"2026-10-15T09:30:00+02:00\",\"com_search_string\":\"string\",\"com_done\":true}}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")
	req.Header.Add("content-type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with package:http (no controller in the iw_erp_api package)

import 'dart:convert';
import 'package:http/http.dart' as http;

final response = await http.patch(
  Uri.parse('https://your-instance.iw-erp.de/api/sip/calls/42'),
  headers: {'x-iw-jwt-token': '<TOKEN>', 'content-type': 'application/json'},
  body: jsonEncode({
    "call": {
      "id": 42,
      "com_title": "Beispiel",
      "com_type": "string",
      "com_created": "2026-10-15T09:30:00+02:00",
      "com_search_string": "string",
      "com_done": true
    }
  }),
);
print(response.body);

Response 200 application/json

{
  "id": 42,
  "com_title": "Beispiel",
  "com_type": "string",
  "com_created": "2026-10-15T09:30:00+02:00",
  "com_search_string": "string",
  "com_done": true,
  "com_person_ext": {
    "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"
  },
  "com_department_ext": {
    "id": 42,
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163",
    "address_country": "DE",
    "address_full_country": "DE",
    "name": "Beispiel",
    "main_phone": "+49 511 123456",
    "main_email": "lena.hartmann@example.org",
    "address": "string"
  },
  "com_company_ext": {
    "id": 42,
    "short_name": "Beispiel",
    "company_name": "Beispiel",
    "secondary_name": "Beispiel",
    "invoice_email": "lena.hartmann@example.org",
    "send_invoice_email": true,
    "time_report_email": "lena.hartmann@example.org",
    "address_street": "Jakobistr. 39",
    "address_city": "Hannover",
    "address_zip": "30163"
  },
  "com_project_ext": {
    "id": 42,
    "name": "Beispiel",
    "description": "Text",
    "invoice_email": "lena.hartmann@example.org",
    "time_report_email": "lena.hartmann@example.org",
    "closed": "2026-10-15T09:30:00+02:00",
    "billed": "2026-10-15T09:30:00+02:00",
    "number": "string",
    "start": "2026-10-15T09:30:00+02:00",
    "end": "2026-10-15T09:30:00+02:00"
  }
}

Returns every call that is currently running A call counts as running while it has no hangup and started inside the window configured in iw_call_active_max_age_minutes. The response is deliberately not cached, it has to be current.

GET/api/sip/calls/active

Answers with an empty list while iw_call_realtime_ui_enabled is off. The clients cannot read that setting themselves - it needs the settings scope, which a normal user does not have - so the switch has to work here, or the running-calls chip would show up on an installation that never enabled the feature.

Query parameters

`comType`string
`comCreated`string
`comTitle`string
`comSearchString`string
`comDone`string
`comPersonExt`string
`comDepartmentExt`string
`comCompanyExt`string
`comProjectExt`string
`comPersonInt`string
`comDepartmentInt`string
`comCompanyInt`string
`comProjectInt`string
`incoming`boolean
`sip_id`string
`number_in`string
`crmperson_in_id`string
`crmdepartment_in_id`string
`crmcompany_in_id`string
`number_answering`string
`crmperson_answering_id`string
`crmdepartment_answering_id`string
`crmcompany_answering_id`string
`number_out`string
`crmperson_out_id`string
`crmdepartment_out_id`string
`crmcompany_out_id`string
`date_new`string
`date_answer`string
`date_hangup`string
`reason_hangup`string
`searchString`string	text to search for in the list
`orderFieldName`string	name of the order field
`orderFieldSort`string	sorting modeAllowed: `DESCASC`
`page`integer	page of the list
`pageSize`integer	number of entries for each page
`withMaxPageNumber`string	returns the number of pages available as a header if this is set

Responses

200Returns every call that is currently runningarray<SIPCall>

Show fields (12)

idinteger
Primary key of the communication item. Internal ID.
com_typestring
Type of the communication item.
com_createdstring (date-time)
Point in time the item was created.
com_titlestring
Title of the communication item.
com_search_stringstring
Searchable text of the communication item.
com_doneboolean
Whether the item is done.
com_person_extCRMPerson10
External person the item refers to.
Show fields (81)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- birthdaystring (date-time)
  Birthday of the person.
- known_allergiesstring
  Known allergies of the person.
- confirmed_no_allergiesboolean
  Guardian confirmed that there are no known allergies.
- allow_photosboolean
  Photos of the person may be taken and published.
- allow_leaving_aloneboolean
  The person may leave the event alone.
- authorized_pickupstring
  Persons who are allowed to pick up the person.
- needs_supportboolean
  The person needs support, for example for inclusion.
- support_descriptionstring
  Description of the support the person needs.
- financial_supportboolean
  The person receives financial support.
- financial_support_numberstring
  Number of the financial support.
- municipal_supportboolean
  The person receives municipal support.
- municipal_support_numberstring
  Number of the municipal support.
- grade_levelinteger
  School grade level of the person.
- school_classstring
  School class of the person.
- start_timestring (date-time)
  Start of the membership or activity.
- start_time_reasonstring
  Reason for the start.
- end_timestring (date-time)
  End of the membership or activity.
- end_time_reasonstring
  Reason for the end.
- confirmed_gtc_timestring (date-time)
  Time the general terms and conditions were confirmed.
- chatbot_opt_inboolean
  Einwilligung in die Nutzung des KI-Assistenten. Denormalisierter aktueller Stand - das pruefbare Protokoll steht in ChatbotConsent.
- chatbot_opt_in_atstring (date-time)
  Time the person opted in to the chatbot.
- 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 gezaehlten Aufrufe selbst haben keinen Bezug zur Person.
- crm_person_contact_dataarray<CRMPersonContactData>
  Contact data of the person, for example phone and e-mail.
- archivedboolean
  Whether the person is archived.
- subscribed_newsletterboolean
  Whether the person subscribed to the newsletter.
- subscribed_magazineboolean
  Whether the person subscribed to the magazine.
- printed_member_cardboolean
  Whether a member card has been printed for the person.
- has_login_userboolean
  Whether the person has a login user.
- profile_picture_urlstring
  URL of the profile picture of the person.
- log_book_staffboolean
  Log book flag: staff.
- log_book_staff1boolean
  Log book flag: staff, level 1.
- log_book_staff2boolean
  Log book flag: staff, level 2.
- log_book_memberboolean
  Log book flag: member.
- log_book_trainerboolean
  Log book flag: trainer.
- log_book_trainer1boolean
  Log book flag: trainer, level 1.
- log_book_trainer2boolean
  Log book flag: trainer, level 2.
- log_book_head_of_departmentboolean
  Log book flag: head of department.
- log_book_supervisory_boardboolean
  Log book flag: supervisory board.
- log_book_board_of_directorsboolean
  Log book flag: board of directors.
- log_book_honorary_memberboolean
  Log book flag: honorary member.
- log_book_club_card_oneboolean
  Log book flag: club card.
- log_book_health_recoveredboolean
  Log book flag: recovered from illness.
- log_book_health_vaccinatedboolean
  Log book flag: vaccinated.
- log_book_health_vaccinated_additionstring
  Details of the vaccination.
- log_book_good_conductboolean
  Log book flag: certificate of good conduct.
- log_book_first_aidboolean
  Log book flag: first aid training.
- log_book_measles_vaccinationboolean
  Log book flag: measles vaccination.
- sync_lanistaboolean
  Whether the person is synchronized with Lanista.
- categoryCRMPersonCategory
  Person category.
- nicknamestring
  Nickname of the person.
- preferred_color_hexstring
  Preferred color of the person as hex value.
- avatar_tokenstring
  Token of the avatar image.
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- … 2 more fields
com_department_extCRMDepartment
External department the item refers to.
Show fields (23)
- idinteger
  Primary key of the department. Internal ID.
- companiesarray<CRMCompany>
  Companies the department belongs to.
- personsarray<CRMPerson10>
  Persons assigned to the department.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- namestring
  Name of the entity.
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
com_company_extCRMCompany
External company the item refers to.
Show fields (55)
- idinteger
  Primary key of the company. Internal ID.
- short_namestring
  Short name of the company.
- company_namestring
  Legal name of the company.
- secondary_namestring
  Second name line of the company.
- direct_dialstring
  Direct dial number of the company.
- invoice_emailstring
  E-mail address for invoices.
- send_invoice_emailboolean
  Send invoices by e-mail.
- send_invoice_letterboolean
  Send invoices by letter.
- time_report_emailstring
  E-mail address for time reports.
- payment_goalPaymentGoal
  Payment term of the company.
- payment_intervalstring
  Interval of the payments.
- vatidstring
  VAT identification number.
- taxnumberstring
  Tax number of the company.
- buyer_reference_idstring
  Leitweg-ID or custom reference ID defined by the customer
- taxTax
  Tax rate used for the company.
- infostring
  Information about the company.
- numberstring
  Customer or supplier number of the company.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Company number as text, including prefix.
- is_customerboolean
  The company is a customer.
- is_supplierboolean
  The company is a supplier.
- is_otherboolean
  The company is neither customer nor supplier.
- is_memberboolean
  The company is a member.
- archivedboolean
  The company is archived.
- categoryCRMCompanyCategory
  Category of the company.
- visible_for_customerboolean
  Whether the company is visible to the customer.
- founding_datestring (date-time)
  Founding date of the company.
- nace_sectionstring
  NACE section code (letter A-U)
- nace_codestring
  NACE code (numeric like 01.11, 62.01)
- search_stringstring
  Text that the entity can be searched by.
- addressstring
  Address as text.
- address_streetstring
  Street of the address.
- address_house_numberstring
  House number of the address.
- address_street_levelstring
  Street and house number of the address.
- address_costring
  Care-of line of the address.
- address_citystring
  City of the address.
- address_zipstring
  Postal code of the address.
- address_admin_level1string
  First administrative level of the address, e.g. the federal state.
- address_countrystring
  Country code of the address.
- address_full_countrystring
  Full name of the country of the address.
- address_geo_latstring
  Latitude of the address.
- address_geo_lngstring
  Longitude of the address.
- address_external_provider_idstring
  field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE
- main_phonestring
  Main phone number.
- main_faxstring
  Main fax number.
- main_emailstring
  Main e-mail address.
- websitestring
  Website address.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
- payment_typePaymentType
- company_employee_countinteger
  Number of employees of the company.
- company_founding_yearinteger
  Founding year of the company.
- company_family_ownedboolean
  Whether the company is family-owned.
- company_sales_volumestring
  Sales volume of the company.
- company_segmentstring
  Market segment of the company.
com_project_extCRMProject14
External project the item refers to.
Show fields (19)
- idinteger
  Primary key of the project. Internal ID.
- namestring
  Name of the project.
- closedstring (date-time)
  Time the project was closed.
- billedstring (date-time)
  Time the project was billed.
- numberstring
  Number of the project.
- startstring (date-time)
  Start of the project.
- endstring (date-time)
  End of the project.
- descriptionstring
  Description of the project.
- companyCRMCompany
  Company the project belongs to.
- internal_main_contactUser14
  Internal login user who is the main contact.
- categoryCRMProjectCategory
  Category of the project.
- archivedboolean
  The project is archived.
- visible_for_customerboolean
  The project is visible in the customer app.
- name_for_customerstring
  Name of the project shown to customers.
- invoice_emailstring
  E-mail address for invoices of the project.
- time_report_emailstring
  E-mail address for time reports of the project.
- search_stringstring
  Text that the entity can be searched by.
- createdstring (date-time)
  Point in time the entity was created.
- updatedstring (date-time)
  Point in time the entity was last updated.
com_person_intCRMPerson10
Internal person the item refers to.
Show fields (13)
- idinteger
  Primary key of the person. Internal ID.
- first_namestring
  First name of the person.
- last_namestring
  Last name of the person.
- numberinteger
  Member or customer number of the person.
- manual_numberinteger
  Number set manually instead of the automatic number.
- number_stringstring
  Member or customer number as text, including prefix.
- genderstring
  Gender of the person.
- titlestring
  Academic or other title of the person.
- positionstring
  Position or role of the person.
- languagestring
  Preferred language of the person.
- special_salutationstring
  Special salutation text for letters.
- form_of_salutationstring
  Form of salutation, for example formal or informal.
- … 70 more fields
… 15 more fields

Request

curl --request GET \
  --url https://your-instance.iw-erp.de/api/sip/calls/active \
  --header 'x-iw-jwt-token: <TOKEN>'

const options = {method: 'GET', headers: {'x-iw-jwt-token': '<TOKEN>'}};

fetch('https://your-instance.iw-erp.de/api/sip/calls/active', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://your-instance.iw-erp.de/api/sip/calls/active"

headers = {"x-iw-jwt-token": "<TOKEN>"}

response = requests.get(url, headers=headers)

print(response.text)

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://your-instance.iw-erp.de/api/sip/calls/active', [
  'headers' => [
    'x-iw-jwt-token' => '<TOKEN>',
  ],
]);

echo $response->getBody();

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
  Method = HttpMethod.Get,
  RequestUri = new Uri("https://your-instance.iw-erp.de/api/sip/calls/active"),
  Headers =
  {
    { "x-iw-jwt-token", "<TOKEN>" },
  },
};
using (var response = await client.SendAsync(request))
{
  response.EnsureSuccessStatusCode();
  var body = await response.Content.ReadAsStringAsync();
  Console.WriteLine(body);
}

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://your-instance.iw-erp.de/api/sip/calls/active")
  .get()
  .addHeader("x-iw-jwt-token", "<TOKEN>")
  .build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://your-instance.iw-erp.de/api/sip/calls/active"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-iw-jwt-token", "<TOKEN>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

Dart with the iw_erp_api package

import 'package:iw_erp_api/clients/sip_call_controller.dart';
import 'package:iw_erp_api/logic/iw_api_state.dart';

IwApiState().host = 'your-instance.iw-erp.de';
IwApiState().currentJwtApiToken = '<TOKEN>';

final result = await SipCallController.getActive();
if (result.success) {
  print(result.data);
}

Response 200 application/json

[
  {
    "id": 42,
    "com_title": "Beispiel",
    "com_type": "string",
    "com_created": "2026-10-15T09:30:00+02:00",
    "com_search_string": "string",
    "com_done": true,
    "com_person_ext": {
      "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"
    },
    "com_department_ext": {
      "id": 42,
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163",
      "address_country": "DE",
      "address_full_country": "DE",
      "name": "Beispiel",
      "main_phone": "+49 511 123456",
      "main_email": "lena.hartmann@example.org",
      "address": "string"
    },
    "com_company_ext": {
      "id": 42,
      "short_name": "Beispiel",
      "company_name": "Beispiel",
      "secondary_name": "Beispiel",
      "invoice_email": "lena.hartmann@example.org",
      "send_invoice_email": true,
      "time_report_email": "lena.hartmann@example.org",
      "address_street": "Jakobistr. 39",
      "address_city": "Hannover",
      "address_zip": "30163"
    },
    "com_project_ext": {
      "id": 42,
      "name": "Beispiel",
      "description": "Text",
      "invoice_email": "lena.hartmann@example.org",
      "time_report_email": "lena.hartmann@example.org",
      "closed": "2026-10-15T09:30:00+02:00",
      "billed": "2026-10-15T09:30:00+02:00",
      "number": "string",
      "start": "2026-10-15T09:30:00+02:00",
      "end": "2026-10-15T09:30:00+02:00"
    }
  }
]