Difference between revisions of "API"

From docs
Jump to: navigation, search
(→‎People)
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 Categories ==
 +
 +
The CallProof API is organized into the following categories:
 +
 +
* API Ping
 +
* Reps
 +
* App Stats
 +
* Contacts
 +
* Contact Phones
 +
* Contact Notes
 +
* People
 +
* Calls
 +
* Appointments
 +
* Custom Fields
 +
* Companies
 +
* Opportunities
 +
* Follow-ups
 +
* Event Forms
 +
 +
----
 +
 +
== API Ping ==
 +
 +
'''Purpose'''
 +
 +
Verifies that the API is available and responding.
 +
 +
'''Endpoints'''
 +
 +
* [[API:Ping|API Ping]]
 +
 +
----
 +
 +
== Reps ==
 +
 +
'''Purpose'''
  
−
=== API Ping ===
+
Manage and retrieve sales representative information and statistics.
  
−
API Ping:
+
'''Endpoints'''
−
::[[API:Ping|https://app.callproof.com/api/ping/]]
 
  
 +
* [[API:Reps:Get|Get Reps]]
 +
* [[API:Reps:Stats:HTML:Update|Update Reps Stats HTML]]
 +
* [[API:Reps:Stats:HTML:Delete|Delete Reps Stats HTML]]
  
−
=== Reps ===
+
----
  
−
Update Reps Stats HTML:
+
== App Stats ==
−
::[[API:Reps:Stats:HTML:Update|https://app.callproof.com/api/reps/stats/html/update/]]
 
  
−
Delete Reps Stats HTML:
+
'''Purpose'''
−
::[[API:Reps:Stats:HTML:Delete|https://app.callproof.com/api/reps/stats/html/delete/]]
 
  
−
Get Reps:
+
Retrieve company statistics and generated dashboard data.
−
::[[API:Reps:Get|https://app.callproof.com/api/reps/get/]]
 
  
 +
'''Endpoints'''
  
−
=== App Stats ===
+
* [[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]]
  
−
Created Company Notes:
+
----
−
::[[API:Companies:Notes:Created|https://app.callproof.com/api/companies/notes/created/]]
 
  
−
Update Company Stats HTML:
+
== Contacts ==
−
::[[API:Companies:Stats:HTML:Update|https://app.callproof.com/api/companies/stats/html/update/]]
 
  
−
Delete Company Stats HTML:
+
'''Purpose'''
−
::[[API:Companies:Stats:HTML:Delete|https://app.callproof.com/api/companies/stats/html/delete/]]
 
  
−
=== Contacts ===
+
Create, update, search, retrieve, and delete contacts.
  
−
Created Contacts:
+
'''Endpoints'''
−
::[[API:Contacts:Created|https://app.callproof.com/api/contacts/created/]]
 
  
−
Updated Contacts:
+
* [[API:Contacts:Created|Created Contacts]]
−
::[[API:Contacts:Updated|https://app.callproof.com/api/contacts/updated/]]
+
* [[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]]
  
−
Find Contacts:
+
----
−
::[[API:Contacts:Find|https://app.callproof.com/api/contacts/find/]]
 
  
−
Get Contact:
+
== Contact Phones ==
−
::[[API:Contact:Get|https://app.callproof.com/api/contact/get/]]
 
  
−
Update Contact:
+
'''Purpose'''
−
::[[API:Contact:Update|https://app.callproof.com/api/contact/update/]]
 
  
−
Update Contact Reps:
+
Manage phone numbers associated with contacts.
−
::[[API:Contact:Update:Reps|https://app.callproof.com/api/contact/update/reps/]]
 
  
−
Create Contact:
+
'''Endpoints'''
−
::[[API:Contact:New|https://app.callproof.com/api/contact/new/]]
 
  
−
Delete Contact:
+
* [[API:Contact Phones:Updated|Get Updated Contact Phones]]
−
::[[API:Contact:Delete|https://app.callproof.com/api/contact/delete/]]
+
* [[API:ContactPhones:Get|Get Contact Phones]]
 +
* [[API:ContactPhone:Update|Update Contact Phone]]
 +
* [[API:ContactPhone:New|Create Contact Phone]]
  
−
Update Contact Custom Fields:
+
----
−
::[[API:Contact:CustomFields:Update|https://app.callproof.com/api/contact/custom_fields/update/]]
 
  
−
Get Contact Files:
+
== Contact Notes ==
−
::[[API:Contact:Files:Get|https://app.callproof.com/api/contact/files/created/]]
 
  
−
Upload New Contact Files:
+
'''Purpose'''
−
::[[API:Contact:Files:New|https://app.callproof.com/api/contact/files/new/]]
 
  
−
Get Contact Images:
+
Create and manage notes attached to contacts.
−
::[[API:Contact:Images:Get|https://app.callproof.com/api/contact/images/get/]]
 
  
−
Get Contact Emails Messages:
+
'''Endpoints'''
−
::[[API:Contact:Email:Get|https://app.callproof.com/api/contact/email/messages/get/]]
 
  
−
New Emails Messages:
+
* [[API:ContactNotes:Get|Get Contact Notes]]
−
::[[API:Email:New|https://app.callproof.com/api/contact/email/messages/new/]]
+
* [[API:ContactNote:Update|Update Contact Note]]
 +
* [[API:ContactNote:New|Create Contact Note]]
 +
* [[API:ContactNote:Delete|Delete Contact Note]]
  
−
=== Contact Phones ===
+
----
  
−
Get Updated Contact Phones:
+
== People ==
−
::[[API:Contact Phones:Updated|https://app.callproof.com/api/contact_phones/updated/]]
 
  
−
Get Contact Phones:
+
'''Purpose'''
−
::[[API:ContactPhones:Get|https://app.callproof.com/api/contact_phones/get/]]
 
  
−
Update Contact Phone:
+
Manage personnel associated with contacts.
−
::[[API:ContactPhone:Update|https://app.callproof.com/api/contact_phone/update/]]
 
  
−
Create Contact Phone:
+
'''Endpoints'''
−
::[[API:ContactPhone:New|https://app.callproof.com/api/contact_phone/new/]]
 
  
 +
* [[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]]
  
−
=== Contact Notes ===
+
----
  
−
Get Contact Notes:
+
== Calls ==
−
::[[API:ContactNotes:Get|https://app.callproof.com/api/contact_notes/get/]]
 
  
−
Update Contact Note:
+
'''Purpose'''
−
::[[API:ContactNote:Update|https://app.callproof.com/api/contact_note/update/]]
 
  
−
Create Contact Note:
+
Create and retrieve phone call information.
−
::[[API:ContactNote:New|https://app.callproof.com/api/contact_note/new/]]
 
  
−
Delete Contact Note:
+
'''Endpoints'''
−
::[[API:ContactNote:Delete|https://app.callproof.com/api/contact_note/delete/]]
 
  
 +
* [[API:Calls:Created|Created Calls]]
 +
* [[API:Calls:ByID|Calls By ID]]
 +
* [[API:Call:Create|Create Call]]
  
−
=== People ===
+
----
  
−
Get People:
+
== Appointments ==
−
::[[API:People:Get|https://app.callproof.com/api/contact/personnel/get/<contact_id>/]]
 
  
−
Create Personnel:
+
'''Purpose'''
−
::[[API:People:Create|https://app.callproof.com/api/contact/personnel/create/]]
 
  
−
Update Personnel:
+
Manage customer appointments.
−
::[[API:People:Update|https://app.callproof.com/api/contact/personnel/update/]]
 
  
−
Delete Personnel:
+
'''Endpoints'''
−
::[[API:People:Delete|https://app.callproof.com/api/contact/personnel/delete/<personnel_id/>]]
 
  
−
Get Personnel contact phones:  
+
* [[API:Appointments:Updated|Updated Appointments]]
−
::[[API:People:Phones:Get|https://app.callproof.com/api/contact/personnel/phones/get/<personnel_id>/]]
+
* [[API:Appointment:New|Create Appointment]]
 +
* [[API:Appointment:End|End Appointment]]
  
−
Get People Roles:
+
----
−
::[[API:People:Roles:Get|https://app.callproof.com/api/contact/people/roles/get/]]
 
  
−
=== Calls ===
+
== Custom Fields ==
  
−
Created Calls:
+
'''Purpose'''
−
::[[API:Calls:Created|https://app.callproof.com/api/calls/created/]]
 
  
−
Calls By ID:
+
Manage custom fields and their options.
−
::[[API:Calls:ByID|https://app.callproof.com/api/calls/by_id/]]
 
  
−
Create Call:
+
'''Endpoints'''
−
::[[API:Call:Create|https://app.callproof.com/api/call/create/]]
 
  
−
=== Appointments ===
+
* [[API:CustomFields:Get|Get Custom Fields]]
 +
* [[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]]
  
−
Updated Appointments:
+
----
−
::[[API:Appointments:Updated|https://app.callproof.com/api/appts/updated/]]
 
  
−
New Appointment:
+
== Companies ==
−
::[[API:Appointment:New|https://app.callproof.com/api/appts/new/]]
 
  
−
End Appointment:
+
'''Purpose'''
−
::[[API:Appointment:End|https://app.callproof.com/api/appts/end/]]
 
  
−
=== Custom Fields ===
+
Create, update, and delete company records.
  
−
Get Custom Fields:
+
'''Endpoints'''
−
::[[API:CustomFields:Get|https://app.callproof.com/api/custom_fields/get/]]
 
  
−
Update Custom Field:
+
* [[API:Companies:Create|Create Companies]]
−
::[[API:CustomField:Update|https://app.callproof.com/api/custom_field/update/]]
+
* [[API:Companies:Update|Update Companies]]
 +
* [[API:Companies:Delete|Delete Companies]]
  
−
Create Custom Field:
+
----
−
::[[API:CustomField:Create|https://app.callproof.com/api/custom_field/new/]]
 
  
−
Update Custom Field Option:
+
== Opportunities ==
−
::[[API:CustomFieldOption:Update|https://app.callproof.com/api/custom_field/option/update/]]
 
  
−
Create Custom Field Option:
+
'''Purpose'''
−
::[[API:CustomFieldOption:Create|https://app.callproof.com/api/custom_field/option/new/]]
 
  
−
=== Companies ===
+
Manage sales opportunities.
  
 +
'''Endpoints'''
  
−
Create Companies:
+
* [[API:Opportunity:Stages:Get|Get Opportunity Stages]]
−
::[[API:Companies:Create|https://app.callproof.com/api/companies/new/]]
+
* [[API:Opportunity:Type:Get|Get Opportunity Types]]
 +
* [[API:Opportunity:Contact:Get|Get Contact Opportunities]]
 +
* [[API:Opportunity:Create|Create Opportunity]]
  
−
Update Companies:
+
----
−
::[[API:Companies:Update|https://app.callproof.com/api/companies/update/]]
 
  
−
Delete Companies:
+
== Follow-ups ==
−
::[[API:Companies:Delete|https://app.callproof.com/api/companies/delete/]]
 
  
−
=== Opportunity ===
+
'''Purpose'''
  
 +
Manage follow-up tasks and reminders.
  
−
Get Opportunity Stages:
+
'''Endpoints'''
−
::[[API:Opportunity:Stages:Get|https://app.callproof.com/api/opportunity/stages/get/]]
 
  
−
Get Opportunity Type:
+
* [[API:Followup:Updated|Updated Follow-ups]]
−
::[[API:Opportunity:Type:Get|https://app.callproof.com/api/opportunity/type/get/]]
+
* [[API:Followup:Create|Create Follow-up]]
  
−
Get Contact Opportunity:
+
----
−
::[[API:Opportunity:Contact:Get|https://app.callproof.com/api/opportunity/get/]]
 
  
−
Create Opportunity:
+
== Event Forms ==
−
::[[API:Opportunity:Create|https://app.callproof.com/api/opportunity/new/]]
 
  
−
=== Followup ===
+
'''Purpose'''
  
−
Updated Followup:
+
Retrieve and submit Event Form data.
−
::[[API:Followup:Updated|https://app.callproof.com/api/followup/updated/]]
 
  
−
New Followup:
+
'''Endpoints'''
−
::[[API:Followup:Create|https://app.callproof.com/api/followup/new/]]
 
  
−
=== Event Forms ===
+
* [[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]]
  
 +
----
  
−
Get Event Forms:
+
== API Error Codes ==
−
::[[API:EventForms:Get|https://app.callproof.com/api/event_form/get/]]
 
  
−
Get Contact Event Forms:
+
CallProof follows standard HTTP response status codes for API requests.
−
::[[API:EventForms:Contact:Get|https://app.callproof.com/api/contact/event_form/get/]]
 
  
−
Get Event Forms Details:
+
Common response codes include:
−
::[[API:EventForms:Details:Get|https://app.callproof.com/api/contact/event_form/details/get/]]
 
  
−
Create Event Form:
+
* 200 — OK
−
::[[API:EventForms:Contact:Create|https://app.callproof.com/api/contact/event_form/create/]]
+
* 201 — Created
 +
* 400 — Bad Request
 +
* 401 — Unauthorized
 +
* 403 — Forbidden
 +
* 404 — Not Found
 +
* 500 — Internal Server Error
  
−
=== API Errors  ===
+
For complete HTTP status code definitions, refer to:
  
−
We followed standard errors from w3.org.  A link is provided here:  http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
+
https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

Revision as of 07:29, 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 Categories

The CallProof API is organized into the following categories:

  • API Ping
  • Reps
  • App Stats
  • Contacts
  • Contact Phones
  • Contact Notes
  • People
  • Calls
  • Appointments
  • Custom Fields
  • Companies
  • Opportunities
  • Follow-ups
  • Event Forms

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

For complete HTTP status code definitions, refer to:

https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html

Retrieved from "http://docs.callproof.com/index.php?title=API&oldid=2081"