Custom Trades CRM
Custom Trades CRMAPI docs

Introduction

The Custom Trades CRM Developer API allows you to integrate your existing software with Custom Trades CRM. Use the API to access company data, manage resources, and build custom integrations.

Base URL

All API requests should be made to:

https://customtradescrm.com/api/v1

REST API

The Developer API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Getting Started

  1. Get Access: Subscribe to the Developer API add-on via the pricing page or your account settings
  2. Create API Keys: Go to Settings → Developer API section and create an API key
  3. Authenticate: Include your API key in requests using the Authorization: Bearer <api_key> header
  4. Make Requests: Start making API calls to access your company data

Authentication

All requests to the Developer API require authentication using an API key. See the Authentication section for details on how to authenticate your requests.

Dates and timestamps

All date and time values use ISO 8601 format and are in UTC (Coordinated Universal Time).

  • Stored in UTC: Timestamps such as created_at, updated_at, deleted_at, and resource-specific fields (e.g. scheduled_start_at, responded_at) are stored in the database in UTC.
  • Returned in UTC: The API returns these values as ISO 8601 strings with a Z suffix (e.g. 2025-02-18T14:30:00.000Z), indicating UTC. Convert to the user's local timezone in your application when displaying.
  • Sending dates in requests: When sending date or date-time values in request bodies (e.g. for filtering or creating/updating resources), use ISO 8601 format. Prefer UTC with a Z suffix (e.g. 2025-02-18T14:30:00.000Z) to avoid ambiguity. Date-only fields (e.g. issue_date) may be sent as YYYY-MM-DD.

Response Format

All API responses follow a consistent format:

Success Response:

{
  "success": true,
  "data": { ... }
}

Error Response:

{
  "success": false,
  "error": "Error message"
}

Rate Limits

The Developer API includes 50,000 requests per month with your subscription. Additional usage can be purchased via the "Developer API Additional Usage" add-on. See Usage and Rate Limits for more details.

Idempotent Requests

The Developer API supports idempotent requests for safe retries. Include an Idempotency-Key header in your requests to prevent duplicate operations. See Idempotent Requests for details.

Available Resources

The Developer API provides access to the following resources:

All resources support CRUD operations (Create, Read, Update, Delete) with soft delete for data preservation.

Next Steps