API:ContactNotes:Get

API » Get Contact Notes

Base URL

https://app.callproof.com

Endpoint

/api/contact_notes/get/

Purpose

Retrieves notes associated with a specific contact in your CallProof company. Use this to view recent note history for a known contact, including who created each note and when it was created.

HTTP Method

GET

Headers

No required headers.

Header	Required	Description
—	—	No headers are required for this endpoint. Authentication is provided via query parameters.

Security

• Yes – Requires a valid API key and secret with permission to read contact notes.

Parameters

Query Parameters

Parameter	Type	Required	Description
key	string	Yes	Public API key assigned to your CallProof account.
secret	string	Yes	Private API secret paired with the API key.
id	integer	Yes	Unique identifier of the contact whose notes should be retrieved. Must belong to your company.

Path Parameters

None.

Request Body

None.

cURL Example

curl -X GET "https://app.callproof.com/api/contact_notes/get/?key=YOUR_API_KEY&secret=YOUR_API_SECRET&id=789"

Successful Response (200)

Returns up to 100 notes associated with the specified contact, ordered from newest to oldest.

Field	Type	Description
results	array	List of contact note objects.
results[].id	integer	Unique identifier for the note.
results[].created	string	Date and time the note was created (YYYY-MM-DD HH:MM:SS).
results[].created_by_id	integer	User ID of the person who created the note.
results[].created_by_email	string	Email address of the person who created the note.
results[].created_by	string	Display name of the person who created the note.
results[].contact_id	integer	Identifier of the contact associated with the note.
results[].contact	string	Display name of the associated contact.
results[].company_id	integer	Identifier of the company associated with the contact.
results[].company	string	Company name associated with the contact.
results[].note	string	Text content of the note.
errors	array	Empty list when the request succeeds.
code	integer	HTTP-style status value; 200 on success.

Example response:

{
  "results": [
    {
      "id": 1001,
      "created": "2024-06-15 14:30:00",
      "created_by_id": 456,
      "created_by_email": "rep@example.com",
      "created_by": "Jane Smith",
      "contact_id": 789,
      "contact": "John Doe",
      "company_id": 321,
      "company": "Acme Corp",
      "note": "Followed up on proposal."
    }
  ],
  "errors": [],
  "code": 200
}

Notes

• The id parameter is the contact ID, not the note ID.
• The contact must belong to your company.
• Up to 100 notes are returned.
• Notes are ordered from newest to oldest.
• This endpoint does not support pagination or date-range filtering.

Error Responses

Status Code	Meaning
400	Bad Request – The contact ID is missing, invalid, or does not match a contact in your company.
401	Unauthorized – The API key and/or secret is missing, invalid, inactive, associated with a disabled account, or lacks permission to read contact notes.
405	Method Not Allowed – A method other than GET was used.
500	Internal Server Error – An unexpected server problem occurred. Not specified in Swagger.

400 response body example:

{
  "results": [],
  "errors": ["Invalid 'id' field"],
  "code": 400
}

401 response body example:

{
  "results": [],
  "errors": ["Invalid API Key"],
  "code": 401
}

405 response body example:

{
  "results": [],
  "errors": ["Method not allowed"],
  "code": 405
}