> ## Documentation Index
> Fetch the complete documentation index at: https://reach-owl.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# ReachOwl API: Automate Your Social Outreach at Scale

> ReachOwl automates Facebook and Instagram outreach through campaigns, post scheduling, and profile growth. Explore the full API reference.

ReachOwl 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 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.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Make your first API call and launch a campaign in 15 minutes.
  </Card>

  <Card title="Authentication" icon="lock" href="/authentication">
    Obtain a Bearer token and secure your requests.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Browse endpoints for campaigns, contacts, queues, and more.
  </Card>

  <Card title="Core Concepts" icon="layers" href="/concepts/campaigns">
    Learn how campaigns, executors, contacts, and webhooks work.
  </Card>
</CardGroup>

## How to get started

Use the steps below to go from an API key to your first running campaign.

<Steps>
  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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`.
  </Step>
</Steps>

## Next steps

* Read the [Quickstart](/quickstart) for full curl examples at each step.
* Review [Core Concepts](/concepts/campaigns) to understand campaigns, executors, contacts, and webhooks.
* Jump to the [API Reference](/api-reference/introduction) for endpoint details.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/quickstart">
    Make your first API call and launch a campaign in 15 minutes.
  </Card>

  <Card title="Authentication" icon="lock" href="/authentication">
    Obtain a Bearer token and secure your requests.
  </Card>

  <Card title="API Reference" icon="code" href="/api-reference/introduction">
    Browse endpoints for campaigns, contacts, queues, and more.
  </Card>

  <Card title="Core Concepts" icon="layers" href="/concepts/campaigns">
    Learn how campaigns, executors, contacts, and webhooks work.
  </Card>
</CardGroup>

## How to get started

Use the steps below to go from an API key to your first running campaign.

<Steps>
  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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.
  </Step>

  <Step title="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`.
  </Step>
</Steps>

## Next steps

* Read the [Quickstart](/quickstart) for full curl examples at each step.
* Review [Core Concepts](/concepts/campaigns) to understand campaigns, executors, contacts, and webhooks.
* Jump to the [API Reference](/api-reference/introduction) for endpoint details.
