Custom Trades CRM
Custom Trades CRMAPI docs

Getting Access

To use the Developer API, you need an active Developer API add-on subscription for your Custom Trades CRM account.

Subscription Process

Step 1: Subscribe to Developer API Add-on

  1. Visit the pricing page
  2. Select your base plan (Power Crew or Power Scale)
  3. Add the Developer API Access add-on during signup, or add it later from your account settings
  4. Complete payment (14-day free trial applies to your subscription, including base plan and add-ons)

Step 2: Activate Your Subscription

After subscribing:

  • The Developer API add-on is activated immediately
  • You'll see the Developer API section in Settings
  • API access is enabled for your company

Step 3: Create API Keys

  1. Go to Settings → Developer API
  2. Click Create API key
  3. Enter a descriptive name (e.g., "Production API", "Webhook Integration")
  4. Copy your key immediately — it won't be shown again
  5. Store the key securely (environment variables, secret management)

Usage Limits

Included Usage

  • 50,000 requests per month included with Developer API add-on
  • Usage resets on the first day of each month
  • All API keys for your company share the same usage pool

Additional Usage

If you need more than 50,000 requests per month:

  1. Subscribe to Developer API Additional Usage add-on
  2. Purchase blocks of 1,000 requests per month
  3. Your total limit = 50,000 + (blocks × 1,000)

Example: If you purchase 5 blocks, your monthly limit is 55,000 requests.

Checking Usage

Usage information is included in every API response via headers:

  • X-Usage-Count: Current month's request count
  • X-Usage-Limit: Your monthly limit
  • X-Usage-Resets: ISO timestamp when usage resets

Mid-Month Changes

  • Adding Developer API mid-month: Full 50,000 requests available for the remainder of the month
  • Removing Developer API mid-month: API access stops immediately; existing usage remains in logs
  • Adding Additional Usage mid-month: Additional blocks apply immediately; usage resets first of next month

Access Requirements

  • Base plan required: You must have an active base plan (Power Crew or Power Scale) before adding Developer API
  • Active subscription: Developer API add-on must be in active or trialing status
  • Account activation: Your account must be activated (is_active = true)

Troubleshooting

"Developer API add-on required" error:

  • Verify your subscription is active in Settings
  • Check that your base plan is active
  • Contact support if subscription appears active but API access is denied

Usage limit exceeded:

  • Check your current usage via response headers
  • Subscribe to Additional Usage add-on if needed
  • Usage resets automatically on the first of next month