# Mintlify Starter Kit

- [ReachOwl API: Automate Your Social Outreach at Scale](https://reach-owl.mintlify.app/index.md): ReachOwl automates Facebook and Instagram outreach through campaigns, post scheduling, and profile growth. Explore the full API reference.
- [Get Started with ReachOwl API](https://reach-owl.mintlify.app/quickstart.md): Make your first ReachOwl API call in minutes. Authenticate, retrieve your team ID, and launch a Facebook outreach campaign.
- [Campaigns: How ReachOwl Automates Outreach](https://reach-owl.mintlify.app/concepts/campaigns.md): ReachOwl campaigns send friend requests, messages, or comments to audiences on Facebook. Learn how campaign status, scheduling, and limits work.
- [Executors: Connected Social Accounts in ReachOwl](https://reach-owl.mintlify.app/concepts/executors.md): Executors are connected browser sessions (app-states) that ReachOwl uses to perform campaign actions on Facebook or Instagram.
- [Contacts: Leads Generated by Your Campaigns](https://reach-owl.mintlify.app/concepts/contacts.md): Contacts are created automatically when campaigns interact with people. You can list, view, and annotate contacts but cannot create or update them directly.
- [Webhooks: Real-Time Campaign Event Notifications](https://reach-owl.mintlify.app/concepts/webhooks.md): ReachOwl sends HTTP POST requests to your endpoint when campaign events fire, such as friend requests sent or messages replied to.
- [API Errors and HTTP Status Codes](https://reach-owl.mintlify.app/concepts/errors.md): ReachOwl returns standard HTTP status codes. 401 means your token is missing or invalid. 422 means validation failed. 404 means the resource was not found.
- [Create and Manage Facebook Outreach Campaigns](https://reach-owl.mintlify.app/guides/create-campaign.md): Step-by-step guide to creating a Facebook group campaign in ReachOwl: set your audience, message sequence, schedule, and daily limit.
- [Schedule Recurring Posts to Facebook Groups](https://reach-owl.mintlify.app/guides/post-scheduler.md): Use ReachOwl post schedulers to automatically publish content to multiple Facebook groups on a recurring interval or fixed schedule.
- [Grow Instagram Profiles with Automated Engagement](https://reach-owl.mintlify.app/guides/profile-growth.md): Create ReachOwl profile growth tasks to automatically react to and repost Instagram content from hashtags, growing your follower base.
- [Manage Team Members and Permissions](https://reach-owl.mintlify.app/guides/manage-team.md): Invite agents to your ReachOwl team, update their roles, and remove members using the Team API endpoints.
- [GET /api/v1/campaigns,  List Campaigns](https://reach-owl.mintlify.app/api-reference/campaigns/list.md): Returns a paginated list of campaigns for the authenticated user team. Accepts optional team_id, page, and per_page query parameters.
- [GET /api/v1/campaigns/{id},  Get Campaign](https://reach-owl.mintlify.app/api-reference/campaigns/get.md): Returns full details of a single campaign by ID, including messages, schedule, executor IDs, and current status.
- [POST /api/v1/campaigns, Create or Clone a Campaign](https://reach-owl.mintlify.app/api-reference/campaigns/create.md): Create a new outreach campaign or clone an existing one. Pass clone_from with a campaign ID to duplicate. Omit to create fresh with full body.
- [PATCH/PUT /api/v1/campaigns/{id}, Update a Campaign](https://reach-owl.mintlify.app/api-reference/campaigns/update.md): Partially or fully update a campaign. Use status 0 to pause and status 1 to resume. Schedule, messages, limit, name, and executor IDs are all updatable.
- [DELETE /api/v1/campaigns/{id}, Delete a Campaign](https://reach-owl.mintlify.app/api-reference/campaigns/delete.md): Permanently deletes a campaign by ID. Returns 204 No Content on success. This action cannot be undone.
- [ReachOwl API Reference: Base URL, Auth, and Conventions](https://reach-owl.mintlify.app/api-reference/introduction.md): The ReachOwl API v1 base URL, authentication model, request/response conventions, pagination, and status codes used across all endpoints.
- [GET /api/v1/contacts — List Contacts](https://reach-owl.mintlify.app/api-reference/contacts/list.md): Returns a paginated list of contacts generated by your campaigns. Contacts are read-only and cannot be created directly via the API.
- [GET /api/v1/contacts/{id} — Get Contact](https://reach-owl.mintlify.app/api-reference/contacts/get.md): Returns full contact details including notes for the given contact ID. Use list contacts to find IDs.
- [Notes: Add and Delete Contact Notes](https://reach-owl.mintlify.app/api-reference/contacts/notes.md): Add a freeform note to a contact with POST /contacts/{id}/notes. Delete a note with DELETE /notes/{note_id}. Only write actions available for contacts.
- [GET /api/v1/post-scheduler — List Post Schedulers](https://reach-owl.mintlify.app/api-reference/post-scheduler/list.md): Returns a paginated list of post schedulers for your team. Each scheduler posts content to one or more Facebook groups on a schedule.
- [POST /api/v1/post-scheduler — Create or Clone a Post Scheduler](https://reach-owl.mintlify.app/api-reference/post-scheduler/create.md): Create a new post scheduler targeting Facebook group URLs, or clone an existing one using clone_from. Accepts interval or fixed schedule types.
- [PATCH/PUT/DELETE /api/v1/post-scheduler/{id} — Update Post Scheduler](https://reach-owl.mintlify.app/api-reference/post-scheduler/update.md): Pause, resume, update fields, delete pending queue rows, or delete the scheduler. No dedicated pause route — use PATCH with status: 0.
- [POST /api/v1/authenticate](https://reach-owl.mintlify.app/api-reference/authenticate.md): Exchange your email and password for a Bearer token. No Authorization header required. Returns a token string used on all subsequent requests.
- [GET /api/v1/user — Fetch Current User](https://reach-owl.mintlify.app/api-reference/user.md): Returns the authenticated user profile including team_id and teams array. Use the top-level team_id as the default for campaign and contact requests.
- [GET /api/v1/queues — Look Up Queue Entries](https://reach-owl.mintlify.app/api-reference/queues/lookup.md): Query the campaign action queue by audience_id, member_id, or profile_url. Always include campaign_id. Use before retrying a failed action.
- [PATCH/PUT /api/v1/queues — Retry or Edit Queue Entries](https://reach-owl.mintlify.app/api-reference/queues/retry.md): Retry a failed queue entry by queue id, or by campaign_id plus audience_id or member_id. PUT updates the message text on a queued entry.
- [GET /api/v1/analytics and Chart Data](https://reach-owl.mintlify.app/api-reference/analytics.md): Retrieve campaign analytics summaries and chart data for your team. Both endpoints accept an optional filter query parameter.
- [GET /api/v1/groups — List Synced Facebook Groups](https://reach-owl.mintlify.app/api-reference/groups.md): Returns the list of Facebook groups synced to your account. Groups are read-only. Use group_url values when creating campaigns or post schedulers.
- [GET /api/v1/profile-growth — List Profile Growth Tasks](https://reach-owl.mintlify.app/api-reference/profile-growth/list.md): Returns a paginated list of profile growth tasks for your team. Filter by platform type (instagram). Pass include_posts=1 on GET by ID to include post data.
- [POST /api/v1/profile-growth — Create a Profile Growth Task](https://reach-owl.mintlify.app/api-reference/profile-growth/create.md): Create an Instagram profile growth task that automatically engages with posts matching a hashtag or source. Set engage_react and engage_repost to control actions.
- [PATCH/PUT/DELETE /api/v1/profile-growth/{id} — Update Profile Growth](https://reach-owl.mintlify.app/api-reference/profile-growth/update.md): Update status, schedule, timezone, or any field on a profile growth task. Status is a string: running, paused, draft, or completed.
- [GET /api/v1/browsers — List Browser Sessions](https://reach-owl.mintlify.app/api-reference/browsers.md): Returns connected browser sessions. Browsers are read-only via the API. Use app-state IDs as executor_ids, not browser IDs directly.
- [GET /api/v1/app-states — List Connected Accounts](https://reach-owl.mintlify.app/api-reference/app-states.md): Returns app-states (connected social account sessions). App-state IDs are used as executor_ids when creating campaigns, post schedulers, and profile growth tasks.
- [GET /api/v1/mentions — List Keyword Monitors](https://reach-owl.mintlify.app/api-reference/mentions/list.md): Returns keyword mention monitors for your team. Each monitor watches Facebook groups for posts containing specified keywords.
- [POST /api/v1/mentions — Create or Update a Keyword Monitor](https://reach-owl.mintlify.app/api-reference/mentions/create.md): Create a new keyword mention monitor or update an existing one. Include id in the body to update. Use status 0 to disable a monitor.
- [DELETE /api/v1/mentions — Delete Monitors and Posts](https://reach-owl.mintlify.app/api-reference/mentions/delete.md): Delete a keyword mention monitor by ID or delete an individual mention post. Deletion is permanent and removes all associated post history.
- [Stages API: Create and Manage Pipeline Stages](https://reach-owl.mintlify.app/api-reference/stages.md): Stages represent steps in your ReachOwl outreach pipeline. Create, reorder, and delete stages to organize contact progress through your funnel.
- [Message Templates: Reusable Outreach Messages](https://reach-owl.mintlify.app/api-reference/message-templates.md): Create reusable message templates tied to pipeline stages. Templates support merge variables like first_name for personalization at send time.
- [GET /api/v1/teams — List Your Teams](https://reach-owl.mintlify.app/api-reference/team/list.md): Returns all teams accessible to the authenticated user. Use team ID values as team_id when creating campaigns, querying contacts, and listing post schedulers.
- [Team Members: Invite, Update, and Remove](https://reach-owl.mintlify.app/api-reference/team/members.md): Manage who has access to your ReachOwl team. List current members, add by email, update role and status, or remove members permanently.
- [PUT/DELETE /api/v1/webhooks/{id} — Update or Remove a Webhook](https://reach-owl.mintlify.app/api-reference/webhooks/update.md): Update the endpoint URL, event subscriptions, or campaign scope on a webhook. DELETE permanently removes the subscription and stops all future deliveries.
- [POST /api/v1/webhooks — Register a Webhook](https://reach-owl.mintlify.app/api-reference/webhooks/create.md): Register a URL to receive HTTP POST notifications for ReachOwl campaign events. Optionally scope deliveries to a single campaign with campaign_id.
- [Authenticate with the ReachOwl API](https://reach-owl.mintlify.app/authentication.md): Obtain a Bearer token from POST /api/v1/authenticate and pass it in the Authorization header on every subsequent ReachOwl API request.

## Optional

- [Documentation](https://mintlify.com/docs)
- [Blog](https://mintlify.com/blog)