Skip to main content
The ReachOwl API lets you automate social media outreach at scale. This page explains the base URL, how authentication works, and the conventions you will see on every endpoint so you can integrate quickly and predictably.

​
Base URL

All API requests are prefixed with the following base URL:

​
Authentication

Every request (except POST /api/v1/authenticate) must include a Bearer token in the Authorization header.
  1. Call POST /api/v1/authenticate with your email and password to receive a token.
  2. Include that token on every subsequent request:
Expired or invalid tokens return 401 Unauthorized.

​
Request and Response Format

  • Requests that send a body must set Content-Type: application/json.
  • The API returns JSON on success. Set Accept: application/json or rely on the default.
  • Use GET for reads, POST for creates, PUT/PATCH for updates, and DELETE for removals.

​
Pagination

List endpoints support pagination via query parameters:
  • page — the page number to fetch (default: 1)
  • per_page — items per page (default: 15)
Example:
Pagination metadata is typically included in the response body or headers depending on the endpoint.

​
Status Codes

​
Design Rules

  • ReachOwl does not expose /pause, /resume, /clone, or /schedule routes. Instead, you control these behaviors by setting fields in the request body when creating or updating a resource.
  • To clone a campaign or post-scheduler, pass clone_from in the POST body with the ID of the source resource.
  • Browsers and app-states endpoints are read-only. You cannot create or update them through the API.

​
Typical Integration Flow

A common first-time flow looks like this:
  1. Authenticate — POST /api/v1/authenticate to get a token.
  2. Get user — GET /api/v1/user to read your profile and default team_id.
  3. Read app state — GET /api/v1/app-states to inspect available states and settings.
  4. Create resources — Use the token and team_id to create campaigns, contacts, or other resources.

Authenticate

Exchange credentials for a Bearer token.

User Profile

Fetch your profile and default team.

Campaigns

List, create, update, and manage campaigns.

Contacts

List contacts and view notes.