Skip to content
sheepCRM Docs

Overview

SheepCRM Console API (1.0.0)

Section titled “SheepCRM Console API (1.0.0)”

REST API for flock and pricing data management in SheepCRM Console.

Authentication

Two authentication methods are supported:

  1. API Key (recommended): Include X-API-Key header with your API key
  2. Session Cookie: Use session from web UI authentication

Security Note: API keys are only accepted via the X-API-Key header, never via query parameters. Query parameter API keys are a security risk because they appear in server logs, browser history, and Referrer headers.

Dry Run Mode

Most write operations support a dry_run parameter (default: true) that previews changes without applying them. Set dry_run: false to apply changes.

Response Format

All responses use a standard envelope:

  • Success: {"data": ...}
  • Error: {"error": {"code": "...", "message": "..."}}

Authentication

Section titled “ Authentication ”

ApiKeyAuth

Section titled “ApiKeyAuth ”

API key for authentication

Security scheme type: apiKey

Header parameter name: X-API-Key

SessionCookie

Section titled “SessionCookie ”

Session cookie from web UI authentication

Security scheme type: apiKey

Cookie parameter name: session_id