Returns a list of accounts / companies
Query parameters
-
searchString
string text to search for in the list
-
orderFieldName
string name of the order field
-
orderFieldSort
string sorting mode
Values are
DESC
orASC
. -
page
integer page of the list
Default value is
0
. -
pageSize
integer number of entries for each page
Minimum value is
1
, maximum value is200
. Default value is50
. -
withMaxPageNumber
string returns the number of pages available as a header if this is set
-
iw-build-id
string build id of the client
-
iw-package-id
string package id of the client
GET
/api/crm/crmcompanies
curl \
--request GET 'https://replace-with-own-host.iw-erp.de/api/crm/crmcompanies' \
--header "x-session-token: $API_KEY"
Response examples (200)
[
{
"id": 42,
"short_name": "string",
"company_name": "string",
"secondary_name": "string",
"direct_dial": "string",
"invoice_email": "string",
"send_invoice_email": true,
"send_invoice_letter": true,
"time_report_email": "string",
"payment_goal": {
"id": 42,
"name": "string",
"date_string": "string",
"deleted": true,
"global_default": true
},
"payment_interval": "string",
"vatid": "string",
"taxnumber": "string",
"buyer_reference_id": "string",
"tax": {
"id": 42,
"name": "string",
"value": 42.0,
"deleted": true,
"global_default": true
},
"info": "string",
"number": "string",
"manual_number": 42,
"number_string": "string",
"is_customer": true,
"is_supplier": true,
"is_other": true,
"is_member": true,
"archived": true,
"category": {
"id": 42,
"name": "string",
"description": "string",
"deleted": true,
"global_default": true,
"enabled_customer_portal": true,
"g_drive_root_dir": "string",
"g_drive_root_dir_archived": "string",
"require_company_address": true,
"require_company_billing": true
},
"visible_for_customer": true,
"search_string": "string",
"address": "string",
"address_street": "string",
"address_house_number": "string",
"address_street_level": "string",
"address_co": "string",
"address_city": "string",
"address_zip": "string",
"address_admin_level1": "string",
"address_country": "string",
"address_full_country": "string",
"address_geo_lat": "string",
"address_geo_lng": "string",
"address_external_provider_id": "string",
"main_phone": "string",
"main_fax": "string",
"main_email": "string",
"website": "string",
"created": "2025-05-04T09:42:00Z",
"updated": "2025-05-04T09:42:00Z",
"payment_type": {
"id": 42,
"name": "string",
"auto": true,
"conditions": "string",
"linked_keywords": "string",
"global_default": true,
"bank_import_default": true,
"is_direct_debit": true,
"is_external": true,
"deleted": true
}
}
]