Omniotap

API Documentation

Back to Home

API Documentation

The OmnioTap API allows you to programmatically access and manage your CRM data. Easily integrate contacts, leads, and opportunities with your external systems.

Base URL
https://api.omniotap.com/api/v1

Authentication

The API uses API keys to authenticate requests. You can view and manage your API keys in the Developer Portal.

Authentication to the API is performed via the X-API-Key header.

curl https://api.omniotap.com/api/v1/contacts \
  -H "X-API-Key: YOUR_API_KEY"

Rate Limits

The API implements rate limiting to ensure fair usage and stability. The current limit is 60 requests per minute per tenant.

Rate limit information is included in the response headers of every API request:

  • X-RateLimit-Limit: The maximum number of requests allowed in the current window (60).
  • X-RateLimit-Remaining: The number of requests remaining in the current window.
  • X-RateLimit-Reset: The time at which the current window resets (in UTC epoch seconds).

If you exceed the rate limit, the API will return a 429 Too Many Requests response.

Contacts

Manage your CRM contacts.

GET/contacts

List all contacts with pagination and filtering.

Query Parameters

  • page - Page number (default: 1)
  • limit - Items per page (default: 50)
  • search - Search term
  • status - Filter by status
POST/contacts

Create a new contact.

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john@example.com",
  "phone": "+1234567890"
}

Customers

Manage your existing customers.

GET/customers

List all customers.

POST/customers

Create a new customer profile.

Leads

Track and manage potential sales leads.

GET/leads

List all leads. Filter by status, priority, or source.

GET /leads?status=new&priority=high
POST/leads

Create a new lead.

{
  "title": "Enterprise License Inquiry",
  "leadSource": "website",
  "status": "new",
  "priority": "high",
  "contactId": "uuid-string"
}

Opportunities

Manage sales opportunities and pipeline.

GET/opportunities

List opportunities. Filter by stage (e.g., qualification, negotiation).

Support Tickets

Manage customer support tickets.

GET/tickets

List support tickets.

POST/tickets

Create a support ticket.

Webhooks

Subscribe to real-time events from your CRM.

Webhooks allow your application to receive real-time notifications when data changes in OmnioTap. You can configure webhook URLs in the Tenant Settings via the UI.

Supported Events

You can subscribe to events for the following entities:

leadcontactopportunitycustomerticket

The following actions trigger a webhook event:

createdupdateddeletedstatus_changedassignment_changed

Payload Structure

Each webhook event is sent as a POST request with a JSON payload:

{
  "event_id": "550e8400-e29b-41d4-a716-446655440000",
  "tenant_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "entity_type": "contact",
  "action": "created",
  "occurred_at": "2024-03-20T10:00:00.000Z",
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane@example.com",
    "createdAt": "2024-03-20T10:00:00.000Z",
    "updatedAt": "2024-03-20T10:00:00.000Z"
  }
}