API Documentation

Introduction

The Axiom API allows you to programmatically access and manipulate your data, automate workflows, and integrate Axiom with other systems. Our RESTful API provides secure access to leads, properties, campaigns, and analytics data.

Authentication

To authenticate API requests, you need to include your API key in the request headers. You can generate API keys in your Axiom account under Account Settings > API > API Keys.

Example Request

curl -X GET "https://api.axiom-console.com/v1/leads" \
     -H "X-Axiom-API-Key: your_api_key_here" \
     -H "Content-Type: application/json"

const axios = require('axios');

const getContacts = async () => {
  try {
    const response = await axios.get('https://api.axiom-console.com/v1/leads', {
      headers: {
        'X-Axiom-API-Key': 'your_api_key_here',
        'Content-Type': 'application/json'
      }
    });
    console.log(response.data);
    return response.data;
  } catch (error) {
    console.error('Error fetching leads:', error);
  }
};

import requests

def get_contacts():
    url = "https://api.axiom-console.com/v1/leads"
    headers = {
        "X-Axiom-API-Key": "your_api_key_here",
        "Content-Type": "application/json"
    }
    
    response = requests.get(url, headers=headers)
    
    if response.status_code == 200:
        return response.json()
    else:
        print(f"Error: {response.status_code}")
        print(response.text)

function getContacts() {
    $url = 'https://api.axiom-console.com/v1/leads';
    $headers = [
        'X-Axiom-API-Key: your_api_key_here',
        'Content-Type: application/json'
    ];
    
    $ch = curl_init();
    curl_setopt($ch, CURLOPT_URL, $url);
    curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
    curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
    
    $response = curl_exec($ch);
    $httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
    
    curl_close($ch);
    
    if ($httpCode == 200) {
        return json_decode($response, true);
    } else {
        echo "Error: " . $httpCode . "\n";
        echo $response;
    }
}

Rate Limits

To ensure optimal performance for all users, the Axiom API implements rate limiting. Rate limits vary based on your plan.

Each response includes rate limit information in the headers:

If you exceed the rate limit, you'll receive a 429 "Too Many Requests" response. The response will include a Retry-After header indicating how long to wait before making another request.

Error Handling

The Axiom API uses standard HTTP status codes to indicate success or failure of API requests. In case of an error, additional information is provided in the response body.

HTTP Status Codes

Error Response Format

When an error occurs, the response body contains detailed information:

{
  error: {
    code: "invalid_parameter",
    message: "The parameter 'email' is invalid",  
    documentation_url: "https://api.axiom-console.com/docs/errors#invalid_parameter"
  }
}

Leads API

The Leads API allows you to manage your leads database, including creating, retrieving, updating, and deleting lead records.

Endpoints

List Leads

Retrieve a paginated list of leads in your account.

{
  "data": [
    {
      "id": "cnt_12345",
      "name": "John Smith",
      "email": "john.smith@example.com",
      "phone": "+11234567890",
      "company": "Acme Real Estate",
      "type": "client",
      "status": "active",
      "tags": ["buyer", "residential"],
      "custom_fields": {
        "preferred_location": "Downtown",
        "budget": "$500k-$750k"
      },
      "created_at": "2025-01-15T10:30:45Z",
      "updated_at": "2025-03-10T15:22:18Z"
    },
    // More leads...
  ],
  length: n
}

Create Lead

Add a new lead to your account. Name and Email are required fields.

{
  "name": "Jane Doe",
  "email": "jane.doe@example.com",
  "phone": "+11235550199",
  "type": "lead",
  "source": "API",
  "notes": ["seller", "commercial"],
  "custom_fields": {
    "property_type": "Office Space",
    "property_size": "2000-5000 sqft"
  }
}

{
  "data": {
    "id": "cnt_67890",
    "name": "Jane Doe",
    "email": "jane.doe@example.com",
    "phone": "+11235550199",
    "status": "lead",
    "source": "API",
    "notes": ["seller", "commercial"],
    "created_at": "2025-04-01T08:15:30Z",
    "updated_at": "2025-04-01T08:15:30Z"
  }
}

Template API

The Template API allows you to create, manage, and view email marketing templates.

Endpoints

Create Template

Add a new lead to your account. Name and Email are required fields.

{
    "name": "From API",
    "subject": "Test from API",
    "content": "html content for email body"

}

{
    "data": {
        "message": "Template created successfully",
        "template": "from-api-1612d101" 
    }
}

Campaign API

The Campaign API allows you to create, manage, and track email marketing campaigns.

Endpoints

API Changelog

Stay updated on the latest API changes and improvements.

Contact Support

If you're having trouble with our API, feel free to reach out to our support team through your Axiom dashboard "Help" > "Send us a message".