Docs/API Reference/Full API Reference
API Reference

Full API Reference

Complete reference documentation for all ShadowPhone API endpoints.

Base URL

All API endpoints are relative to: https://api.shadowphone.com/v1

GET /accounts

List all connected Instagram accounts. Returns an array of account objects with id, username, follower_count, status, and paired_device information.

POST /workflows

Create a new automation workflow. Required fields: name (string), type (string), steps (array of step objects). Optional: schedule (object), enabled (boolean).

GET /analytics

Retrieve analytics data. Query parameters: account_id (required), start_date, end_date, metrics (comma-separated list). Returns time-series data for requested metrics.

POST /actions

Queue a new automation action for immediate execution. Required fields: account_id, action_type (follow/like/comment/dm), target. Returns a job_id for tracking.

GET /phones

List all connected phones and their current status. Returns device info including model, status, active_account, and uptime.

DELETE /workflows/:id

Delete a workflow by its ID. Returns 204 No Content on success. Active workflows are stopped before deletion.

Webhooks

Configure webhooks at Settings > Webhooks to receive real-time notifications for events like workflow_completed, action_blocked, device_disconnected, and more.

Need more help?

Join our Discord community or contact support for personalized assistance.

Full API Reference | ShadowPhone Docs | ShadowPhone