{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Tool Responses - Outreach MCP | Outreach","description":"Outreach extensibility development and documentation portal","siteUrl":"https://developers.outreach.io","keywords":"outreach developer portal, api documentation, api reference docs, sdk documentation","lang":"en-US","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"tool-responses","__idx":0},"children":["Tool Responses"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every tool returns a structured JSON object. This page describes the common response shapes and field types you'll encounter."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"response-shapes","__idx":1},"children":["Response Shapes"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Search tools:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{count, <resource>: [...]}"]}," — a count and a list of records"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Get-by-id tools:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{<resource>: {...}}"]}," — a single full record"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Create tools:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{<resource>: {id, ...}}"]}," — the new record's ID and shallow fields"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Delete tools:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{id: \"<deleted_id>\"}"]}," — confirmation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Batch tools"]}," (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sequence_add_prospects"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sequence_states_destroy"]},"): ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{batch: {state, total, failures, ...}}"]}," — async batch status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Schema tools:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{standard_fields: [...], custom_fields: [...]}"]}," — field metadata"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-field-types","__idx":2},"children":["Common Field Types"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Field"},"children":["Field"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Notes"},"children":["Notes"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["integer"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Outreach internal ID"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Display name"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["email"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Email address"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["owner"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["{id, name, email}"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updated_at"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["touched_at"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["ISO datetime"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["UTC"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["array of string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Free-form labels"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["custom_fields"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Org-specific extensions"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["account"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["opportunity"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["prospect"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["object"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Nested ref objects with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}," and a few key fields"]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Specific field shapes vary by tool. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["input_fields_fetch"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["filter_fields_fetch"]}," to discover the actual schema your org has."]}]},"headings":[{"value":"Tool Responses","id":"tool-responses","depth":1},{"value":"Response Shapes","id":"response-shapes","depth":2},{"value":"Common Field Types","id":"common-field-types","depth":2}],"frontmatter":{"seo":{"title":"Tool Responses - Outreach MCP | Outreach"}},"lastModified":"2026-05-26T08:58:43.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/mcp-server/tool-responses","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}