Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
Contacts

List contact notes

Returns all notes for a contact, ordered by creation time descending. The {id} path parameter supports a contact ID, a phone number in E.164 format starting with +, or a Meta username without the leading @. Ambiguous numeric values are resolved as Meta usernames first and fall back to contact IDs only when no matching Meta username exists. Contact retrieve, list, and search responses do not include notes; use this endpoint to read contact notes.

get/contact/contacts/{id}/notes

Path parameters

idstring required
Example:alice_01

Identifier of the contact. Supports a contact ID, a phone number in E.164 format starting with + (for example, +16315551111), or a Meta username without the leading @. A Meta username must contain 3 to 35 letters, digits, periods, or underscores. If a numeric value can be interpreted as both a Meta username and a contact ID, it is resolved as a Meta username first. If no contact has that Meta username, the value is resolved as a contact ID.

Response

Successfully retrieved contact notes.

idstring required

Unique ID for the contact note.

contactIdstring required

Unique ID of the contact that owns this note.

contentstring required

Note content.

operatorIdstring

ID of the actor who created the note.

updateOperatorIdstring

ID of the actor who last updated the note.

createTimestring date-time

The time at which the note was created, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

updateTimestring date-time

The time at which the note was last updated, formatted in RFC 3339. e.g., 2022-06-01T12:00:00.000Z.

Example response

[
  {
    "id": "6a3de646e18f344f743aaa4d",
    "content": "Customer prefers follow-up in the morning.",
    "operatorId": "user_123",
    "updateOperatorId": "user_123",
    "createTime": "2022-06-01T12:00:00.000Z",
    "updateTime": "2022-06-01T12:00:00.000Z"
  }
]