Get SalesCoach account based Contact notes

From docs
Revision as of 16:01, 21 July 2026 by Ashley DeBon (talk | contribs) (Get Contact Notes (AI Chat Bot))
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Mobile_API »Get Contact Notes (AI Chat Bot)

Base URL

https://apimobile.callproof.com

Endpoint

/api/ai/chat-bot/contact/{id}/contact-note

Purpose

Retrieves contact notes for a specific contact, scoped to the user resolved from the optional email header (or the authenticated user’s email). Notes are returned newest first, with created time converted to the user’s timezone.

HTTP Method

GET

Headers

Header Required Description
Authorization Yes Bearer access token
email No User email used to resolve which user’s notes to load. If omitted, the authenticated user’s email is used

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 notes for the contact and resolved user.

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
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)
origin string Source of the note (for example, note source type or embedded source label)
user_id integer Identifier of the resolved user used for the lookup
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 – Invalid/unknown email ("Invalid user email"), or an error while retrieving notes (for example, "Error while retriving the Notes").
  • 401 – Authentication failed or the access token is missing/expired.