API
Contents
CallProof REST API
The CallProof REST API allows developers to integrate external applications with the CallProof platform. Using the API, you can create, retrieve, update, and delete CRM data such as contacts, companies, appointments, opportunities, follow-ups, event forms, and more.
Overview
The API provides secure access to CallProof data using API Keys. It is intended for custom integrations, mobile applications, reporting tools, and automated workflows.
Common uses include:
- Synchronizing customer data with external CRM systems
- Creating and updating contacts automatically
- Managing companies, opportunities, appointments, and follow-ups
- Uploading files and images
- Retrieving reports and activity data
- Integrating CallProof with third-party applications
Authentication
All API requests require a valid API Key.
To generate an API Key, see:
Response Format
Unless otherwise noted, all endpoints return JSON responses.
Typical response:
- Success
- Validation errors
- Authentication errors
- Permission errors
Refer to each endpoint for request parameters and response examples.
API Ping
Purpose
Verifies that the API is available and responding.
Endpoints
Reps
Purpose
Manage and retrieve sales representative information and statistics.
Endpoints
App Stats
Purpose
Retrieve company statistics and generated dashboard data.
Endpoints
Contacts
Purpose
Create, update, search, retrieve, and delete contacts.
Endpoints
- Created Contacts
- Updated Contacts
- Find Contacts
- Get Contact
- Update Contact
- Update Contact Reps
- Create Contact
- Delete Contact
- Update Contact Custom Fields
- Get Contact Files
- Upload Contact Files
- Get Contact Images
- Get Contact Email Messages
- Create Email Message
Contact Phones
Purpose
Manage phone numbers associated with contacts.
Endpoints
Contact Notes
Purpose
Create and manage notes attached to contacts.
Endpoints
People
Purpose
Manage personnel associated with contacts.
Endpoints
Calls
Purpose
Create and retrieve phone call information.
Endpoints
Appointments
Purpose
Manage customer appointments.
Endpoints
Custom Fields
Purpose
Manage custom fields and their options.
Endpoints
- Get Custom Fields
- Update Custom Field
- Create Custom Field
- Update Custom Field Option
- Create Custom Field Option
Companies
Purpose
Create, update, and delete company records.
Endpoints
Opportunities
Purpose
Manage sales opportunities.
Endpoints
Follow-ups
Purpose
Manage follow-up tasks and reminders.
Endpoints
Event Forms
Purpose
Retrieve and submit Event Form data.
Endpoints
API Error Codes
CallProof follows standard HTTP response status codes for API requests.
Common response codes include:
- 200 — OK
- 201 — Created
- 400 — Bad Request
- 401 — Unauthorized
- 403 — Forbidden
- 404 — Not Found
- 500 — Internal Server Error
For complete HTTP status code definitions, refer to:
