{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Outreach REST API - Development Portal | 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":"welcome-to-the-outreach-api-documentation","__idx":0},"children":["Welcome to the Outreach API documentation"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Our platform API is built from the ground up to serve the complex needs of both our internal client applications and our"," ","customers and integration partners alike. Our API is based on REST principles and implements"," ","the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"http://jsonapi.org/format/1.0/","target":"_blank"},"children":["JSON API 1.0 specification"]},". All requests must be"," ","authenticated via the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://tools.ietf.org/html/rfc6749","target":"_blank"},"children":["OAuth 2.0"," ","protocol"]},","," ","and their authorization scope can be limited on a per-application, per-token basis. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/getting-started"},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Getting"," ","Started"]}]}," for more information."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Outreach API - via the JSON API specification - supports fetching, creating, updating and deleting resources,"," ","and in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/making-requests"},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Making Requests"]}]}," we describe the specific requirements for completing those requests. In"," ","addition, we describe how you can use complex query parameters to filter, sort and paginate collections of resources, as"," ","well as request included resources and sparse fieldsets."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/common-patterns"},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Common Patterns"]}]}," we outline important requests and the resources and relationships they"," ","require. Our API works great as a lightweight CRM, as an entry-point into our platform's advanced automation"," ","capabilities, and as a tool to collect platform statistics."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/custom-objects"},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["Custom Objects"]}]}," we describe how to interact with custom objects through the API. Even though they"," ","are similar to standard resources, some specificities are worth mentioning."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Finally, in the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api/reference/"},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["API Reference"]}]}," section we describe all of the resources that we support"," ","along with the request methods that they expose. Each resource section also contains detailed attribute and relationship"," ","information and an example request and response for each action."]}]},"headings":[{"value":"Welcome to the Outreach API documentation","id":"welcome-to-the-outreach-api-documentation","depth":1}],"frontmatter":{"seo":{"title":"Outreach REST API - Development Portal | Outreach"}},"lastModified":"2026-04-29T11:57:31.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/api","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}