HubSpot: Notetaker schemas

← Notetaker operations · All schemas

Retrieve conversation recap data — response body

Field	Type	Presence	Description and constraints
$	object	Root
actionItems	Model	Required within parent	Expand Retrieve conversation recap data — response body — action Items
callStats	Model	Required within parent	Expand Retrieve conversation recap data — response body — call Stats
notes	Model	Required within parent	Expand Retrieve conversation recap data — response body — notes
participants	Model	Required within parent	Expand Retrieve conversation recap data — response body — participants
questionsAsked	Model	Required within parent	Expand Retrieve conversation recap data — response body — questions Asked
recordingUrl	Model	Required within parent	Expand Retrieve conversation recap data — response body — recording Url
summary	Model	Optional	Expand Retrieve conversation recap data — response body — summary

Referenced models: Retrieve conversation recap data — response body — action Items, Retrieve conversation recap data — response body — call Stats, Retrieve conversation recap data — response body — notes, Retrieve conversation recap data — response body — participants, Retrieve conversation recap data — response body — questions Asked, Retrieve conversation recap data — response body — recording Url, Retrieve conversation recap data — response body — summary

Retrieve conversation recap data — response body — action Items

Field	Type	Presence	Description and constraints
$	object	Root
error	Model	Optional	Expand Retrieve conversation recap data — response body — notes error
items	array	Required within parent	The list of action items extracted from the conversation. Populated when status is SUCCEEDED; empty otherwise.
items[]	Model	Each item	Expand Retrieve conversation recap data — response body — action Items items item
status	string	Required within parent	The current state of action item generation. SUCCEEDED — action items are available. NOT_FOUND — no action items have been generated for this engagement. IN_PROGRESS — generation is currently underway. FAILED — an error occurred while retrieving action items. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED

Referenced models: Retrieve conversation recap data — response body — action Items items item, Retrieve conversation recap data — response body — notes error

Retrieve conversation recap data — response body — action Items items item

Field	Type	Presence	Description and constraints
$	object	Root
assignee	string	Optional	A string indicating the individual assigned to the action item. This property is optional.
assigneeObjectId	string	Optional	The id of the HubSpot user or contact assigned to this action item, if found. This property is optional.
id	string	Required within parent	The unique identifier for the action item, represented as a string.
title	string	Required within parent	A string representing the title or main description of the action item. This property is required.

Retrieve conversation recap data — response body — call Stats

Field	Type	Presence	Description and constraints
$	object	Root
durationMs	JSON	Optional
durationMs (anyOf 1)	integer	Alternative	The length of the recorded conversation in milliseconds. Format: int64
durationMs (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
error	Model	Optional	Expand Retrieve conversation recap data — response body — notes error
hasTranscript	boolean	Required within parent	Whether a transcript for a conversation is found.
ownerTalkTimePercentage	string	Optional	The percentage of talk-time attributed to the owner participant.
status	string	Required within parent	The status of fetching call stats. Either SUCCEEDED, NOT_FOUND, or FAILED. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED

Referenced models: Retrieve conversation recap data — response body — notes error

Retrieve conversation recap data — response body — notes

Field	Type	Presence	Description and constraints
$	object	Root
error	Model	Optional	Expand Retrieve conversation recap data — response body — notes error
status	string	Required within parent	The status of fetching the notes. Either SUCCEEDED, NOT_FOUND, or FAILED. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED
value	string	Optional	A string containing the notes from the conversation recap.

Referenced models: Retrieve conversation recap data — response body — notes error

Retrieve conversation recap data — response body — notes error

Field	Type	Presence	Description and constraints
$	object	Root	Ye olde error
category	string	Required within parent	A string representing the category of the error.
context	object	Required within parent	An object containing additional context about the error condition, where each key maps to an array of strings. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
errors	array	Required within parent	An array of ErrorDetail objects providing further information about the error.
errors[]	Model	Each item	Expand Retrieve conversation recap data — response body — notes error errors item
id	string	Optional	A string that serves as a unique identifier for the error instance.
links	object	Required within parent	An object mapping link names to associated URIs that contain documentation or recommended remediation steps related to the error. Additional keys: see wildcard field
links.*	string	Additional keys
message	string	Required within parent	A string containing a human-readable message describing the error.
status	string	Required within parent	A string representing the status of the error.
subCategory	object	Optional	An object providing more specific details about the error category.

Referenced models: Retrieve conversation recap data — response body — notes error errors item

Retrieve conversation recap data — response body — notes error errors item

Field	Type	Presence	Description and constraints
$	object	Root	Represents detailed information about an error that occurred in the API. This component is used to provide additional context and specifics about errors, typically as part of an error response.
code	string	Optional	The status code associated with the error detail. This helps identify the type of error that occurred.
context	object	Optional	An object providing context about the error condition. It contains additional properties that offer more details, such as missing scopes or other relevant information. Additional keys: see wildcard field
context.*	array	Additional keys
context.*[]	string	Each item
in	string	Optional	The name of the field or parameter in which the error was found. It provides context about the location of the error.
message	string	Required within parent	A human-readable message describing the error along with remediation steps where appropriate. This is a required field.
subCategory	string	Optional	A specific category that contains more specific detail about the error. It offers further classification of the error.

Retrieve conversation recap data — response body — participants

Field	Type	Presence	Description and constraints
$	object	Root
error	Model	Optional	Expand Retrieve conversation recap data — response body — notes error
items	array	Required within parent	An array of participant information objects, each containing details about a participant in the conversation.
items[]	Model	Each item	Expand Retrieve conversation recap data — response body — participants items item
status	string	Required within parent	The status of fetching participants. Either SUCCEEDED or FAILED. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED

Referenced models: Retrieve conversation recap data — response body — notes error, Retrieve conversation recap data — response body — participants items item

Retrieve conversation recap data — response body — participants items item

Field	Type	Presence	Description and constraints
$	object	Root
email	string	Optional	The email address of the participant. Only present when the participant is a HubSpot Contact.
isHost	boolean	Required within parent	Whether this participant was the host of the conversation.
name	string	Required within parent	The name of the participant.
phoneNumber	string	Optional	The phone number of the participant. Only present when the participant is a HubSpot Contact.

Retrieve conversation recap data — response body — questions Asked

Field	Type	Presence	Description and constraints
$	object	Root
error	Model	Optional	Expand Retrieve conversation recap data — response body — notes error
questionsAndAnswers	array	Required within parent	A list of question and answer pairs.
questionsAndAnswers[]	Model	Each item	Expand Retrieve conversation recap data — response body — questions Asked questions And Answers item
status	string	Required within parent	The status of fetching questions and answers. Either FAILED, NOT_FOUND, or SUCCEEDED. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED

Referenced models: Retrieve conversation recap data — response body — notes error, Retrieve conversation recap data — response body — questions Asked questions And Answers item

Retrieve conversation recap data — response body — questions Asked questions And Answers item

Field	Type	Presence	Description and constraints
$	object	Root
answer	Model	Optional	Expand Retrieve conversation recap data — response body — questions Asked questions And Answers item answer
question	Model	Required within parent	Expand Retrieve conversation recap data — response body — questions Asked questions And Answers item answer

Referenced models: Retrieve conversation recap data — response body — questions Asked questions And Answers item answer

Retrieve conversation recap data — response body — questions Asked questions And Answers item answer

Field	Type	Presence	Description and constraints
$	object	Root
speakerName	string	Optional	The speaker attributed to this statement.
text	string	Optional	The time at which this statement occurred.
timestampSeconds	JSON	Optional
timestampSeconds (anyOf 1)	number	Alternative	The time in a recorded conversation at which this statement occurred.
timestampSeconds (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve conversation recap data — response body — recording Url

Field	Type	Presence	Description and constraints
$	object	Root
error	Model	Optional	Expand Retrieve conversation recap data — response body — notes error
status	string	Required within parent	The status of creating a URL. Either FAILED, NOT_FOUND, or SUCCEEDED. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED
value	string	Optional	The URL of the recording as a string.

Referenced models: Retrieve conversation recap data — response body — notes error

Retrieve conversation recap data — response body — summary

Field	Type	Presence	Description and constraints
$	object	Root
error	Model	Optional	Expand Retrieve conversation recap data — response body — notes error
status	string	Required within parent	The current state of summary generation. SUCCEEDED — summary is available. NOT_FOUND — no summary has been generated for this engagement. FAILED — an error occurred while retrieving the summary. Known values: FAILED, IN_PROGRESS, NOT_FOUND, NOT_SUPPORTED, SUCCEEDED
value	string	Optional	The AI-generated summary text for the conversation. Present when status is SUCCEEDED; absent otherwise.

Referenced models: Retrieve conversation recap data — response body — notes error