Allo

List person notes

Returns the notes on a person's CRM profile, paginated.

GET/v2/api/crm/people/{person_id}/notes

Returns the notes on a person's CRM profile, paginated. person_id is the per-* id from the People API.

Errors

StatusCodeWhen
400CONTACT_NOTES_UNAVAILABLEThe workspace is not on the v2 contact model yet
400INVALID_PAGE_SIZEsize is not between 1 and 100
404PERSON_NOT_FOUNDNo person with this ID (also returned for IDs without the per- prefix)

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

person_idstringrequired

Person ID (per-*) — the id field from the People API.

Query parameters

pageinteger

Page number (1-indexed)

sizeinteger

Results per page

Responses

200List of person notes
dataobject[]
7 fields
idstring

Note ID (cno-*)

person_idstring

Person ID (per-*)

contentstring

Note text, with mentions inline as @[Name](usr-...).

userobject

Author of a note or comment.

2 fields
idstring
namestring | null
mentionsobject[]
3 fields
user_idstring
namestring | null
deletedboolean

true if the mentioned user has since been removed from the team.

created_atstring<date-time>
updated_atstring<date-time>
paginationobject
5 fields
pageinteger
sizeinteger
total_countinteger
total_pagesinteger
has_moreboolean
400
401
404
429