Get Notes For Specific Contact

From docs
Revision as of 11:49, 17 July 2026 by Ashley DeBon (talk | contribs) (Created page with "== Get Contact Notes == === Base URL === https://apimobile.callproof.com === Endpoint === /api/contact/{id}/contact-note === Purpose === Retrieves notes for a specific cont...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Get Contact Notes

Base URL

https://apimobile.callproof.com

Endpoint

/api/contact/{id}/contact-note

Purpose

Retrieves notes for a specific contact that were created by the authenticated user. Each note includes the note text, created date/time (in the user’s timezone), origin/source, and the user who created it.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token

Security

  • Yes – Requires Bearer Token authentication.

Parameters

Path Parameters

Parameter Type Required Description
id integer Yes Unique identifier of the contact

Query Parameters

None.

Request Body

None.

Successful Response (200)

Returns the list of contact notes (newest first).

Field Type Description
clientStatusCode integer Status indicator for the client (for example, 200)
user_id integer Identifier of the authenticated user
company_id integer Identifier of the authenticated user’s company
data array List of note records (see below)
uri string Requested resource URI

data[]

Field Type Description
note_id integer Unique identifier of the note
note string Note text
created string Created date/time in the user’s timezone (format: m-d-Y g:i A, for example, 07-17-2026 4:30 PM)
origin string Source of the note (for example, the note source type name, or a source label embedded in the note text)
user_id integer Identifier of the authenticated user
user_name string Full name of the user associated with the note

Error Responses

Status Code Meaning
400 Bad Request – notes could not be retrieved
401 Unauthorized – missing, invalid, or expired Bearer token
  • 400 – An error occurred while retrieving notes (for example, "Error while retriving the Notes").
  • 401 – Authentication failed or the access token is missing/expired.