CRM-Snitcher – easy data export by webservices

CRM-Snitcher is a small web service tool that can be used to inspect CRM modules, display field definitions, and query records in a targeted way. One particularly practical function is the complete CSV export of any module. This allows all records of a module to be downloaded and then processed further in Excel, LibreOffice, Numbers, or other analysis tools.

The export is suitable, for example, for data checks, migrations, support cases, duplicate analyses, or simple inventories.

What is exported?

The CSV download exports all records of the currently opened module. The fields of the module are determined based on the web service description and written to the CSV file as columns.

An important advantage: For linked fields, CRM-Snitcher outputs not only the internal CRM IDs wherever possible, but also readable content from the linked record. Instead of an ID such as 11×12345, the CSV may contain, for example, the name of a contact, an organization, or a user.

This makes the exported data much easier to read and reduces the amount of manual post-processing required.

Requirements

Valid web service access credentials are required for the export:

  • CRM URL
  • CRM user: API or access key of the user, which can be found in the CRM user administration

The access credentials are only kept in the current PHP session in CRM-Snitcher. They are not stored permanently.

Important: The CRM user being used must have web service access to the desired module. In addition, the user can only export the records that they are allowed to see according to the CRM permissions.

Step 1: Open CRM-Snitcher

Open CRM-Snitcher in your browser. After opening it, the login form for the CRM web service connection is displayed first.

Enter the CRM URL, the web service user, and the API key there. After a successful connection, CRM-Snitcher loads the list of modules to which the user has access.

Step 2: Select the desired module

The module overview displays all modules that can be accessed via the web service. Typical examples include:

  • Accounts
  • Contacts
  • Leads
  • Potentials
  • HelpDesk
  • Products
  • Services
  • Invoice
  • SalesOrder

Click the name of the module whose records you want to export.

After clicking, the module view opens. There, CRM-Snitcher displays, among other things:

  • the query area for web service queries
  • the CSV export area
  • the field definitions of the module
  • field names, labels, mandatory fields, and field types

 

Step 3: Start the CSV export

In the module browser, the CSV export section is located below the query block.

There you will find the button: Download all records as CSV

Clicking this button starts the complete export of all records of the currently opened module.

CRM-Snitcher generates the CSV file on the server side and then delivers it directly to the browser as a download.

 

Note for large amounts of data

For modules with a very large number of records, generating the CSV file may take some time. CRM-Snitcher therefore displays a spinner on the button when the download starts.

This is particularly important for large modules, for example:

  • many contacts
  • large activity histories
  • extensive tickets
  • invoices or orders spanning several years
  • heavily used custom modules

While the export is being prepared, the page should not be reloaded. Depending on the amount of data, server performance, and number of linked fields, the process may take anywhere from a few seconds to several minutes.

How CRM-Snitcher exports the data

The export runs via the CRM web service interface. CRM-Snitcher does not query the records directly from the database, but instead uses the regular web service operations.

As a result, the permissions of the logged-in user are applied automatically.

In simplified terms, the following happens:

  1. CRM-Snitcher loads the field definitions of the module using describe.
  2. The CSV columns are built from these definitions.
  3. All records of the module are then queried in blocks.
  4. Reference fields are detected.
  5. Linked records are loaded additionally and converted into readable values.
  6. The CSV file is output as a download.

Block-by-block querying is important so that larger modules can also be exported without having to load everything in a single request.

Linked fields are output in a more readable form.

Many CRM fields do not internally contain plain text, but web service IDs. Without resolving these references, such fields would be difficult to read in the CSV. CRM-Snitcher therefore tries to determine a meaningful display name from the linked record for references.

Example:

Instead of: 11×2457

the CSV will contain, wherever possible: Muster GmbH

Or, for contacts: Max Mustermann

If no suitable display name is found or the linked record cannot be loaded, the original ID is retained. This ensures that no information is lost.

Opening the CSV file

The exported file can be opened directly in common programs, for example:

  • Microsoft Excel
  • LibreOffice Calc
  • Apple Numbers
  • Google Sheets
  • Database or BI tools
  • Text editors

The file is output as a UTF-8 CSV so that umlauts and special characters are processed as cleanly as possible.

When opening the file in Excel, depending on the system and language settings, it may be useful to open the file via the import dialog and select UTF-8 as the character set there.

Typical use cases

CSV export via CRM-Snitcher is particularly helpful for:

  • quick data analyses
  • data cleanup
  • duplicate checks
  • migrations
  • before-and-after comparisons
  • support and troubleshooting
  • documentation of existing data inventories
  • exports from custom modules
  • checking reference fields

Since the export runs directly via the web service, no database access is required.

Security and responsibility

CRM-Snitcher is a technical tool for administrators, developers, and experienced CRM users. Even though the CSV export itself is read-only, the tool should be used with care.

Recommendations:

  • Use a dedicated web service user wherever possible.
  • Check the permissions of this user.
  • Export only the data you actually need.
  • Treat CSV files containing personal data confidentially.
  • Delete local export files when they are no longer needed.
  • Use the tool on production systems only deliberately and in a controlled manner.

Conclusion

CRM-Snitcher makes it possible to quickly download all records of any CRM module as a CSV file. The export is particularly useful because it does not only output raw data, but also converts linked fields into readable content wherever possible.

This makes CRM-Snitcher very well suited for analyses, migrations, support tasks, and data checks without requiring direct database access.