API & Developers
3 min read

API Documentation Overview

Getting started with the OutReign API

API Documentation Overview

Build powerful integrations with the OutReign REST API.

Quick Links

  • Full API Documentation
  • API Status Page
  • Base URL

    https://api.outreign.io/v1

    Authentication

    All requests require an API key:

    curl -X GET "https://api.outreign.io/v1/leads" \
      -H "X-API-Key: sos_your_api_key"

    Getting Your API Key

  • Go to Settings → API Keys
  • Click "Generate New Key"
  • Name your key (e.g., "Production")
  • Copy and store securely
  • Available Endpoints

    EndpointMethodsDescription
    /leadsGET, POST, PUT, DELETEManage leads
    /dealsGET, POST, PUT, DELETEManage deals
    /activitiesGET, POSTTrack activities
    /searchPOSTAI-powered search

    Response Format

    All responses are JSON:

    {
      "success": true,
      "data": { ... },
      "meta": {
        "page": 1,
        "total": 100
      }
    }

    Error Handling

    Errors include helpful messages:

    {
      "success": false,
      "error": {
        "code": "INVALID_REQUEST",
        "message": "Email is required"
      }
    }

    Visit API Docs for complete documentation.

    Was this article helpful?

    Related Articles

    APIdocumentationgetting started