Skip to content
Last updated

Tool Responses

Every tool returns a structured JSON object. This page describes the common response shapes and field types you'll encounter.

Response Shapes

Search tools: {count, <resource>: [...]} — a count and a list of records

Get-by-id tools: {<resource>: {...}} — a single full record

Create tools: {<resource>: {id, ...}} — the new record's ID and shallow fields

Delete tools: {id: "<deleted_id>"} — confirmation

Batch tools (sequence_add_prospects, sequence_states_destroy): {batch: {state, total, failures, ...}} — async batch status

Schema tools: {standard_fields: [...], custom_fields: [...]} — field metadata

Common Field Types

FieldTypeNotes
idintegerOutreach internal ID
namestringDisplay name
emailstringEmail address
ownerobject{id, name, email}
created_at, updated_at, touched_atISO datetimeUTC
tagsarray of stringFree-form labels
custom_fieldsobjectOrg-specific extensions
account, opportunity, prospectobjectNested ref objects with id and a few key fields

Specific field shapes vary by tool. Use input_fields_fetch and filter_fields_fetch to discover the actual schema your org has.