API FAQs

The WhatConverts API allows developers to programmatically access and manage lead data.

This article answers common questions about API authentication, retrieving and creating leads, webhooks, endpoints, and troubleshooting common API issues.

Overview

What is the WhatConverts API?

The WhatConverts API allows you to programmatically interact with your WhatConverts account and lead data.

You can use the API to:

• Retrieve leads and attribution data
• Access call recordings
• Send leads from external systems into WhatConverts
• Sync lead data with CRMs or internal tools

Who should use the API?

The API is designed for developers or technical users who want to integrate WhatConverts data with other systems.

If you want to send leads to other platforms without writing code, you may prefer using an integration such as Zapier.

What is the difference between the API, Webhooks, and Endpoints?

The API, Webhooks, and Endpoints are different ways to exchange data between systems.

The main difference is who initiates the data transfer.

For example:

• Use the API to retrieve leads for a custom dashboard.
• Use Webhooks to automatically send leads to a CRM.
• Use Endpoints to send offline leads into WhatConverts.

Where can I find the API documentation?

The complete WhatConverts API documentation includes available endpoints, parameters, and request examples.

You can access the documentation here.

Setup & Authentication

How do I find my API credentials?

To generate or view your Profile API credentials, follow the steps in the Generate a Profile API Key article.

To generate or view your Master Account API credentials, follow the steps in the Generate a Master API Key article.

What type of authentication does the API use?

The WhatConverts API uses HTTP Basic Authentication.

Your credentials are used as follows:

• Username: API Token
• Password: API Secret

These credentials must be included with every API request.

What request format does the WhatConverts API use?

The WhatConverts API uses the Content-Type multipart/form-data format for requests.

Example header:

Content-Type: multipart/form-data

This means request data should be sent as form-data parameters rather than JSON when making API requests.

What date format does the API use?

The API expects dates in ISO 8601 format using UTC.

Examples:

• 2026-03-10
• 2026-03-10T13:41:00Z

Using the correct date format ensures filters and queries return accurate results.

Are there API rate limits?

Yes. API requests are subject to daily limits depending on the type of API credentials used.

Typical limits include:

• Profile API Key: Up to 1,000 requests per day
• Master Account API Key: Up to 10,000 requests per day

If you require higher limits for a large integration, contact WhatConverts support.

Working with Leads

Can I retrieve leads using the API?

Yes. The API allows you to retrieve lead data from your account.

Lead responses can include information such as:

• Lead contact information
• Lead type (call, form, chat, etc.)
• Attribution data
• Campaign and keyword details
• Call duration and recordings
• Lead status and notes

When retrieving leads, you can filter results using parameters such as date_start and date_end.

Can I create leads using the API?

Yes. You can create leads in WhatConverts using the API.

This is commonly used to:

• Import leads from external systems
• Track offline leads
• Sync leads from CRMs or proprietary platforms

Can I update existing leads using the API?

Yes. Certain lead fields can be updated through the API, including:

• Lead status
• Notes
• Lead value
• Custom fields

Can I access call recordings through the API?

Yes. If call recording is enabled, the API can return links to call recordings associated with leads.

These recordings can be accessed through the recordings API endpoint.

Webhooks & Endpoints

What are Webhooks used for?

Webhooks automatically send lead data from WhatConverts to another system when a lead is created.

They are commonly used to:

• Send leads to CRMs
• Trigger marketing automations
• Update internal databases
• Send leads to reporting tools

What are Endpoints used for?

Endpoints allow external systems to send lead data into WhatConverts.

They are commonly used when leads originate outside of your website or tracking setup, such as:

• Leads created in a CRM
• Offline leads entered by a sales team
• Leads generated by custom applications
• Sales or revenue data associated with a lead

This allows external or offline leads to appear alongside your other tracked leads.

How do I set up a Webhook or Endpoint?

To set up a webhook, follow the steps in the Set Up Webhooks in WhatConverts article.

To set up an endpoint, follow the steps in the Use Endpoints article.

Testing & Troubleshooting

How can I test API requests?

You can test API requests using tools such as:

• Postman
• cURL
• API testing tools built into development environments

Example cURL request:

curl -u token:secret https://app.whatconverts.com/api/v1/leads

This retrieves leads using Basic Authentication.

Why am I receiving a 401 Unauthorized error?

A 401 Unauthorized error usually indicates an authentication issue.

Check that:

• Your API Token and API Secret are correct
• Your credentials are included with the request
• You are using the correct credentials for the account or profile

Why am I not receiving the expected lead data?

If the API response does not include the expected data, verify that:

• The correct endpoint is being used
• Date filters include the correct time range
• The leads exist in the profile being queried
• Request parameters are formatted correctly

Related Topics

• Generate a Profile API Key
• Generate a Master API Key
• Set Up Webhooks in WhatConverts
• Use Endpoints