The Outreach API is a powerful way to harness the power of Outreach, the leading platform for sales engagement and orchestration. With the Outreach API, you can unlock the full potential of Outreach, allowing you to build and integrate custom apps, automate workflows, and even extend your sales activities beyond the core platform. With Outreach, you'll have the ability to develop the exact tools that your organization needs to achieve the best results from your sales engagements.
Below are just a few of the examples of what you can do with the Outreach API:
import { axios } from "@pipedream/platform"
export default defineComponent({
props: {
outreach: {
type: "app",
app: "outreach",
}
},
async run({steps, $}) {
return await axios($, {
url: `https://api.outreach.io/api/v2/accounts`,
headers: {
Authorization: `Bearer ${this.outreach.$auth.oauth_access_token}`,
"Content-Type": `application/vnd.api+json`,
},
})
},
})
Outreach uses OAuth authentication. When you connect your Outreach account, Pipedream will open a popup window where you can sign into Outreach and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Outreach API.
Pipedream requests the following authorization scopes when you connect your account:
audits.all
audits.read
accounts.all
accounts.read
accounts.write
accounts.delete
callDispositions.all
callDispositions.read
callDispositions.write
callDispositions.delete
callPurposes.all
callPurposes.read
callPurposes.write
callPurposes.delete
calls.all
calls.read
calls.write
calls.delete
customDuties.all
customDuties.read
customDuties.write
customDuties.delete
contentCategories.all
complianceRequests.read
complianceRequests.write
complianceRequests.all
contentCategories.read
contentCategories.write
contentCategories.delete
contentCategoryMemberships.all
contentCategoryMemberships.read
contentCategoryMemberships.write
contentCategoryMemberships.delete
contentCategoryOwnerships.all
contentCategoryOwnerships.read
contentCategoryOwnerships.write
contentCategoryOwnerships.delete
duties.all
duties.read
duties.write
duties.delete
emailAddresses.all
emailAddresses.read
emailAddresses.write
emailAddresses.write
events.all
events.read
events.write
events.delete
favorites.all
favorites.read
favorites.write
favorites.delete
mailAliases.all
mailAliases.read
mailboxes.all
mailboxes.read
mailboxes.write
mailboxes.delete
mailings.all
mailings.read
mailings.write
mailings.delete
opportunities.all
opportunities.read
opportunities.write
opportunities.delete
opportunityProspectRoles.read
opportunityProspectRoles.write
opportunityProspectRoles.all
opportunityProspectRoles.delete
opportunityStages.all
opportunityStages.read
opportunityStages.write
opportunityStages.delete
personas.all
personas.read
personas.write
personas.delete
phoneNumbers.all
phoneNumbers.read
phoneNumbers.write
phoneNumbers.delete
profiles.all
profiles.read
profiles.write
profiles.delete
prospects.all
prospects.read
prospects.write
prospects.delete
recipients.all
recipients.all
recipients.read
recipients.write
recipients.delete
roles.all
roles.read
roles.write
roles.delete
rulesets.all
rulesets.read
rulesets.write
rulesets.delete
sequenceStates.all
sequenceStates.read
sequenceStates.write
sequenceStates.delete
sequenceSteps.all
sequenceSteps.read
sequenceSteps.write
sequenceSteps.delete
sequenceTemplates.all
sequenceTemplates.read
sequenceTemplates.write
sequenceTemplates.delete
sequences.all
sequences.read
sequences.write
sequences.delete
snippets.all
snippets.read
snippets.write
snippets.delete
stages.all
stages.read
stages.write
stages.delete
taskPriorities.all
taskPriorities.read
taskPriorities.write
taskPriorities.delete
tasks.all
tasks.read
tasks.write
tasks.delete
teams.all
teams.read
teams.write
teams.delete
templates.all
templates.read
templates.write
templates.delete
users.all
users.read
users.write
users.delete
webhooks.all
webhooks.read
webhooks.write
webhooks.delete
GET
https://api.outreach.io/oauth/authorize
?
client_id={{oauth.client_id}}
&
redirect_uri={{oauth.redirect_uri}}
&
state={{oauth.state}}
&
response_type=code
&
scope={{oauth.space_separated_scopes}}
POST
https://api.outreach.io/oauth/token
content-type: application/x-www-form-urlencoded
accept: application/json
client_id={{oauth.client_id}}
&
client_secret={{oauth.client_secret}}
&
redirect_uri={{oauth.redirect_uri}}
&
grant_type=authorization_code
&
code={{oauth.code}}
POST
https://api.outreach.io/oauth/token
content-type: application/x-www-form-urlencoded
accept: application/json
client_id={{oauth.client_id}}
&
client_secret={{oauth.client_secret}}
&
grant_type=refresh_token
&
refresh_token={{oauth.refresh_token}}