Returns a list of accounts / companies

GET /api/crm/crmcompanies

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 or ASC.

  • page integer

    page of the list

    Default value is 0.

  • pageSize integer

    number of entries for each page

    Minimum value is 1, maximum value is 200. Default value is 50.

  • 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

Responses

  • 200 application/json

    Returns a list of accounts / companies

    Hide response attributes Show response attributes object
    • id integer
    • short_name string
    • company_name string
    • secondary_name string
    • direct_dial string
    • invoice_email string
    • send_invoice_email boolean
    • send_invoice_letter boolean
    • time_report_email string
    • payment_goal object
      Hide payment_goal attributes Show payment_goal attributes object
      • id integer
      • name string
      • date_string string
      • deleted boolean
      • global_default boolean
    • payment_interval string
    • vatid string
    • taxnumber string
    • buyer_reference_id string
    • tax object
      Hide tax attributes Show tax attributes object
      • id integer
      • name string Required
      • value number(float)

        Minimum value is 0, maximum value is 1.

      • deleted boolean
      • global_default boolean
    • info string
    • number string
    • manual_number integer
    • number_string string
    • is_customer boolean
    • is_supplier boolean
    • is_other boolean
    • is_member boolean
    • archived boolean
    • category object
      Hide category attributes Show category attributes object
      • id integer
      • name string
      • description string
      • deleted boolean
      • global_default boolean
      • enabled_customer_portal boolean
      • g_drive_root_dir string
      • g_drive_root_dir_archived string
      • require_company_address boolean
      • require_company_billing boolean
    • visible_for_customer boolean
    • 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 string(date-time)
    • updated string(date-time)
    • payment_type object
      Hide payment_type attributes Show payment_type attributes object
      • id integer
      • name string
      • auto boolean
      • conditions string
      • linked_keywords string
      • global_default boolean
      • bank_import_default boolean
      • is_direct_debit boolean
      • is_external boolean
      • deleted boolean
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
    }
  }
]