Difference between revisions of "API"

From docs
Jump to: navigation, search
(→‎Companies)
 
(21 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 +
= CallProof REST API =
  
−
== 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.
  
−
The CallProof API can be used to automate backend workflows.
+
== 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:
  
−
=== API Keys ===
 
 
::[[Create API Keys|How to Create API Keys]]
 
::[[Create API Keys|How to Create API Keys]]
  
 +
== 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'''
 +
 +
* [[API:Ping|API Ping]]
 +
 +
----
 +
 +
== Reps ==
 +
 +
'''Purpose'''
 +
 +
Manage and retrieve sales representative information and statistics.
 +
 +
'''Endpoints'''
 +
 +
* [[API:Reps:Get|Get Reps]]
 +
* [[API:Reps:Stats:HTML:Update|Update Reps Stats HTML]]
 +
* [[API:Reps:Stats:HTML:Delete|Delete Reps Stats HTML]]
 +
 +
----
 +
 +
== App Stats ==
 +
 +
'''Purpose'''
 +
 +
Retrieve company statistics and generated dashboard data.
 +
 +
'''Endpoints'''
 +
 +
* [[API:Companies:Notes:Created|Created Company Notes]]
 +
* [[API:Companies:Stats:HTML:Update|Update Company Stats HTML]]
 +
* [[API:Companies:Stats:HTML:Delete|Delete Company Stats HTML]]
 +
 +
----
 +
 +
== Contacts ==
 +
 +
'''Purpose'''
 +
 +
Create, update, search, retrieve, and delete contacts.
 +
 +
'''Endpoints'''
 +
 +
* [[API:Contacts:Created|Created Contacts]]
 +
* [[API:Contacts:Updated|Updated Contacts]]
 +
* [[API:Contacts:Find|Find Contacts]]
 +
* [[API:Contact:Get|Get Contact]]
 +
* [[API:Contact:Update|Update Contact]]
 +
* [[API:Contact:Update:Reps|Update Contact Reps]]
 +
* [[API:Contact:New|Create Contact]]
 +
* [[API:Contact:Delete|Delete Contact]]
 +
* [[API:Contact:CustomFields:Update|Update Contact Custom Fields]]
 +
* [[API:Contact:Files:Get|Get Contact Files]]
 +
* [[API:Contact:Files:New|Upload Contact Files]]
 +
* [[API:Contact:Images:Get|Get Contact Images]]
 +
* [[API:Contact:Email:Get|Get Contact Email Messages]]
 +
* [[API:Email:New|Create Email Message]]
 +
 +
----
 +
 +
== Contact Phones ==
 +
 +
'''Purpose'''
 +
 +
Manage phone numbers associated with contacts.
 +
 +
'''Endpoints'''
 +
 +
* [[API:Contact Phones:Updated|Get Updated Contact Phones]]
 +
* [[API:ContactPhones:Get|Get Contact Phones]]
 +
* [[API:ContactPhone:Update|Update Contact Phone]]
 +
* [[API:ContactPhone:New|Create Contact Phone]]
 +
 +
----
 +
 +
== Contact Notes ==
 +
 +
'''Purpose'''
 +
 +
Create and manage notes attached to contacts.
  
−
=== API Ping ===
+
'''Endpoints'''
  
−
API Ping:
+
* [[API:ContactNotes:Get|Get Contact Notes]]
−
::[[API:Ping|https://app.callproof.com/api/ping/]]
+
* [[API:ContactNote:Update|Update Contact Note]]
 +
* [[API:ContactNote:New|Create Contact Note]]
 +
* [[API:ContactNote:Delete|Delete Contact Note]]
  
 +
----
  
−
=== Reps ===
+
== People ==
  
−
Update Reps Stats HTML:
+
'''Purpose'''
−
::[[API:Reps:Stats:HTML:Update|https://app.callproof.com/api/reps/stats/html/update/]]
 
  
−
Delete Reps Stats HTML:
+
Manage personnel associated with contacts.
−
::[[API:Reps:Stats:HTML:Delete|https://app.callproof.com/api/reps/stats/html/delete/]]
 
  
−
Get Reps:
+
'''Endpoints'''
−
::[[API:Reps:Get|https://app.callproof.com/api/reps/get/]]
 
  
 +
* [[API:People:Get|Get People]]
 +
* [[API:People:Create|Create Personnel]]
 +
* [[API:People:Update|Update Personnel]]
 +
* [[API:People:Delete|Delete Personnel]]
 +
* [[API:People:Phones:Get|Get Personnel Phones]]
 +
* [[API:People:Roles:Get|Get People Roles]]
  
−
=== App Stats ===
+
----
  
−
Created Company Notes:
+
== Calls ==
−
::[[API:Companies:Notes:Created|https://app.callproof.com/api/companies/notes/created/]]
 
  
−
Update Company Stats HTML:
+
'''Purpose'''
−
::[[API:Companies:Stats:HTML:Update|https://app.callproof.com/api/companies/stats/html/update/]]
 
  
−
Delete Company Stats HTML:
+
Create and retrieve phone call information.
−
::[[API:Companies:Stats:HTML:Delete|https://app.callproof.com/api/companies/stats/html/delete/]]
 
  
−
=== Contacts ===
+
'''Endpoints'''
  
−
Created Contacts:
+
* [[API:Calls:Created|Created Calls]]
−
::[[API:Contacts:Created|https://app.callproof.com/api/contacts/created/]]
+
* [[API:Calls:ByID|Calls By ID]]
 +
* [[API:Call:Create|Create Call]]
  
−
Updated Contacts:
+
----
−
::[[API:Contacts:Updated|https://app.callproof.com/api/contacts/updated/]]
 
  
−
Find Contacts:
+
== Appointments ==
−
::[[API:Contacts:Find|https://app.callproof.com/api/contacts/find/]]
 
  
−
Get Contact:
+
'''Purpose'''
−
::[[API:Contact:Get|https://app.callproof.com/api/contact/get/]]
 
  
−
Update Contact:
+
Manage customer appointments.
−
::[[API:Contact:Update|https://app.callproof.com/api/contact/update/]]
 
  
−
Update Contact Reps:
+
'''Endpoints'''
−
::[[API:Contact:Update:Reps|https://app.callproof.com/api/contact/update/reps/]]
 
  
−
Create Contact:
+
* [[API:Appointments:Updated|Updated Appointments]]
−
::[[API:Contact:New|https://app.callproof.com/api/contact/new/]]
+
* [[API:Appointment:New|Create Appointment]]
 +
* [[API:Appointment:End|End Appointment]]
  
−
Delete Contact:
+
----
−
::[[API:Contact:Delete|https://app.callproof.com/api/contact/delete/]]
 
  
−
Update Contact Custom Fields:
+
== Custom Fields ==
−
::[[API:Contact:CustomFields:Update|https://app.callproof.com/api/contact/custom_fields/update/]]
 
  
 +
'''Purpose'''
  
−
=== Contact Phones ===
+
Manage custom fields and their options.
  
−
Get Updated Contact Phones:
+
'''Endpoints'''
−
::[[API:Contact Phones:Updated|https://app.callproof.com/api/contact_phones/updated/]]
 
  
−
Get Contact Phones:
+
* [[API:CustomFields:Get|Get Custom Fields]]
−
::[[API:ContactPhones:Get|https://app.callproof.com/api/contact_phones/get/]]
+
* [[API:CustomField:Update|Update Custom Field]]
 +
* [[API:CustomField:Create|Create Custom Field]]
 +
* [[API:CustomFieldOption:Update|Update Custom Field Option]]
 +
* [[API:CustomFieldOption:Create|Create Custom Field Option]]
  
−
Update Contact Phone:
+
----
−
::[[API:ContactPhone:Update|https://app.callproof.com/api/contact_phone/update/]]
 
  
−
Create Contact Phone:
+
== Companies ==
−
::[[API:ContactPhone:New|https://app.callproof.com/api/contact_phone/new/]]
 
  
 +
'''Purpose'''
  
−
=== Contact Notes ===
+
Create, update, and delete company records.
  
−
Get Contact Notes:
+
'''Endpoints'''
−
::[[API:ContactNotes:Get|https://app.callproof.com/api/contact_notes/get/]]
 
  
−
Update Contact Note:
+
* [[API:Companies:Create|Create Companies]]
−
::[[API:ContactNote:Update|https://app.callproof.com/api/contact_note/update/]]
+
* [[API:Companies:Update|Update Companies]]
 +
* [[API:Companies:Delete|Delete Companies]]
  
−
Create Contact Note:
+
----
−
::[[API:ContactNote:New|https://app.callproof.com/api/contact_note/new/]]
 
  
−
Delete Contact Note:
+
== Opportunities ==
−
::[[API:ContactNote:Delete|https://app.callproof.com/api/contact_note/delete/]]
 
  
 +
'''Purpose'''
  
−
=== Calls ===
+
Manage sales opportunities.
  
−
Created Calls:
+
'''Endpoints'''
−
::[[API:Calls:Created|https://app.callproof.com/api/calls/created/]]
 
  
−
Calls By ID:
+
* [[API:Opportunity:Stages:Get|Get Opportunity Stages]]
−
::[[API:Calls:ByID|https://app.callproof.com/api/calls/by_id/]]
+
* [[API:Opportunity:Type:Get|Get Opportunity Types]]
 +
* [[API:Opportunity:Contact:Get|Get Contact Opportunities]]
 +
* [[API:Opportunity:Create|Create Opportunity]]
  
 +
----
  
−
=== Appointments ===
+
== Follow-ups ==
  
−
Updated Appointments:
+
'''Purpose'''
−
::[[API:Appointments:Updated|https://app.callproof.com/api/appts/updated/]]
 
  
 +
Manage follow-up tasks and reminders.
  
−
=== Custom Fields ===
+
'''Endpoints'''
  
−
Get Custom Fields:
+
* [[API:Followup:Updated|Updated Follow-ups]]
−
::[[API:CustomFields:Get|https://app.callproof.com/api/custom_fields/get/]]
+
* [[API:Followup:Create|Create Follow-up]]
  
−
Update Custom Field:
+
----
−
::[[API:CustomField:Update|https://app.callproof.com/api/custom_field/update/]]
 
  
−
Create Custom Field:
+
== Event Forms ==
−
::[[API:CustomField:Create|https://app.callproof.com/api/custom_field/new/]]
 
  
−
Update Custom Field Option:
+
'''Purpose'''
−
::[[API:CustomFieldOption:Update|https://app.callproof.com/api/custom_field/option/update/]]
 
  
−
Create Custom Field Option:
+
Retrieve and submit Event Form data.
−
::[[API:CustomFieldOption:Create|https://app.callproof.com/api/custom_field/option/new/]]
 
  
−
=== Companies ===
+
'''Endpoints'''
  
 +
* [[API:EventForms:Get|Get Event Forms]]
 +
* [[API:EventForms:Contact:Get|Get Contact Event Forms]]
 +
* [[API:EventForms:Details:Get|Get Event Form Details]]
 +
* [[API:EventForms:Contact:Create|Create Event Form]]
  
−
Create Companies:
+
----
−
::[[API:Companies:Create|https://app.callproof.com/api/companies/new/]]
 
  
−
Update Companies:
+
== API Error Codes ==
−
::[[API:Companies:Update|https://app.callproof.com/api/companies/update/]]
 
  
−
Delete Companies:
+
CallProof follows standard HTTP response status codes for API requests.
−
::[[API:Companies:Delete|https://app.callproof.com/api/companies/delete/]]
 
  
−
=== API Errors  ===
+
Common response codes include:
  
−
We followed standard errors from w3.org.  A link is provided here:  http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+
* 200 — OK
 +
* 201 — Created
 +
* 400 — Bad Request
 +
* 401 — Unauthorized
 +
* 403 — Forbidden
 +
* 404 — Not Found
 +
* 500 — Internal Server Error

Latest revision as of 14:56, 17 July 2026

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:

How to Create API Keys

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

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

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
Retrieved from "http://docs.callproof.com/index.php?title=API&oldid=2354"