List Notes For Contacts
POST /notes/batch
POST
/notes/batch
The notes of many contacts in one read, grouped by contact. Writes nothing.
POST only because the id list is a body. Every contact is authorised first.
Authorizations
Parameters
Header Parameters
Request Body required
Mirrors BatchNotesRequest.
object
contact_ids
required
Contacts whose notes to read in one call.
Array<string>
Responses
200
Successful Response
object
data
required
An open envelope for one record, one dashboard or one job receipt.
Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.
object
key
additional properties
any
pagination
Any of:
object
has_next
required
Whether there are more pages
boolean
limit
required
Items per page
integer
notes
Any of:
Array<string>
null
page
required
Current page number (1-indexed)
integer
total
required
Total number of items
integer
null
422
Validation Error
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string