Skip to main content

​
Base URL

All API requests should be made to: 
https://YOUR_DEPLOYMENT.lupitor.com/api/v1

​
Request Format

  • Content-Type: application/json
  • Authentication: Include x-api-key header
  • Date Format: ISO 8601 timestamps

​
Response Format

All API responses follow a consistent structure: 
{
  "success": boolean,
  "data": object | null,
  "error": string | null
}

​
Success Response

{
  "success": true,
  "data": {
    "leadId": "jh7abc123xyz"
  },
  "error": null
}

​
Error Response

{
  "success": false,
  "data": null,
  "error": "campaignId is required"
}

​
HTTP Status Codes

Status CodeMeaning
200OK - Request successful
201Created - Resource created successfully
400Bad Request - Invalid parameters
401Unauthorized - Missing or invalid API key
403Forbidden - Insufficient permissions
404Not Found - Resource doesn’t exist
429Too Many Requests - Rate limit exceeded
500Internal Server Error - Something went wrong

​
Rate Limits

Rate limits are applied per API key. Contact us if you need higher limits.
  • Default: 100 requests per minute
  • Bulk Operations: 10 requests per minute
Rate limit information is included in response headers: 
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1640000000

​
Available Endpoints

Create Lead

POST /leads

List Leads

GET /leads

Bulk Create Leads

POST /leads/bulk

​
Endpoint Aliases

/records is an alias for /leadsAll /api/v1/leads endpoints are also available at /api/v1/records. Use whichever naming convention fits your integration:
Primary EndpointAlias Endpoint
POST /api/v1/leadsPOST /api/v1/records
GET /api/v1/leadsGET /api/v1/records
POST /api/v1/leads/bulkPOST /api/v1/records/bulk
Both endpoints are functionally identical and share the same documentation.

​
Need More Endpoints?

We’re continuously expanding our API. If you need additional endpoints or features: