{{baseUrl}}/api/v1 and uses Bearer token authentication. This documentation covers authentication, concepts, guides, and full endpoint reference so you can build outreach workflows programmaticallyReachOwl is a social media outreach automation platform that lets you run campaigns, schedule posts, and grow profiles on Facebook and Instagram. The REST API is hosted at {{baseUrl}}/api/v1 and uses Bearer token authentication. This documentation covers authentication, concepts, guides, and full endpoint reference so you can build outreach workflows programmatically.
Quickstart
Make your first API call and launch a campaign in 15 minutes.
Authentication
Obtain a Bearer token and secure your requests.
API Reference
Browse endpoints for campaigns, contacts, queues, and more.
Core Concepts
Learn how campaigns, executors, contacts, and webhooks work.
How to get started
Use the steps below to go from an API key to your first running campaign.1
Authenticate
POST your email and password to
/api/v1/authenticate to receive a Bearer token. All subsequent requests must include this token in the Authorization header.2
Get your team ID
Call
GET /api/v1/user to retrieve the team_id associated with your account. Campaigns and most resources are scoped to a team.3
List executors
Call
GET /api/v1/app-states to view connected social accounts. Each entry has an id you will use as executor_ids when creating a campaign.4
Create a campaign
POST to
/api/v1/campaigns with the campaign name, platform, action type, audience, team_id, and executor_ids. The campaign starts immediately when status is 1.Next steps
- Read the Quickstart for full curl examples at each step.
- Review Core Concepts to understand campaigns, executors, contacts, and webhooks.
- Jump to the API Reference for endpoint details.
Quickstart
Make your first API call and launch a campaign in 15 minutes.
Authentication
Obtain a Bearer token and secure your requests.
API Reference
Browse endpoints for campaigns, contacts, queues, and more.
Core Concepts
Learn how campaigns, executors, contacts, and webhooks work.
How to get started
Use the steps below to go from an API key to your first running campaign.1
Authenticate
POST your email and password to
/api/v1/authenticate to receive a Bearer token. All subsequent requests must include this token in the Authorization header.2
Get your team ID
Call
GET /api/v1/user to retrieve the team_id associated with your account. Campaigns and most resources are scoped to a team.3
List executors
Call
GET /api/v1/app-states to view connected social accounts. Each entry has an id you will use as executor_ids when creating a campaign.4
Create a campaign
POST to
/api/v1/campaigns with the campaign name, platform, action type, audience, team_id, and executor_ids. The campaign starts immediately when status is 1.Next steps
- Read the Quickstart for full curl examples at each step.
- Review Core Concepts to understand campaigns, executors, contacts, and webhooks.
- Jump to the API Reference for endpoint details.