Developer Resources / Developer Resources

OmniReach API Documentation

Modified on: Wed, 13 May, 2026 at 8:08 AM

OmniReach provides a comprehensive API platform that enables developers to build integrations, automations, and custom applications with the OmniReach CRM and Marketplace. Our API includes REST endpoints for contacts, messaging, workflows, calendars, payments, webhooks, and more.


IMPORTANT: V1 APIs has reached end-of-support as on 31-December-2025. Existing connections/integrations will continue to work, however no support or updates will be provided for V1 APIs. Want to migrate from V1 to V2? (with a ton of new functionalities and security features)
Check out - Private IntegrationsPlease Note: Older API documentation versions remain accessible for reference. This allows developers to continue supporting existing integrations while reviewing newer API versions when they are ready to upgrade.



Please Note: Going forward, the ability to generate new API keys will be removed from both Agency and Sub-account settings.This change applies to accounts that have not yet generated or are not currently using a API key.

TABLE OF CONTENTS

High-Level API Documentation


OmniReach API documentation is now available at https://marketplace.goomnireach.com/docs/. If you previously used the legacy Stoplight documentation, update your bookmarks. Stoplight documentation will be deprecated in the coming months.


OmniReach API documentation now supports versioned API references. Developers can use the version switcher inside the API documentation to view endpoints, schemas, parameters, and examples for a specific API version. This helps teams maintain stable integrations, reference older API versions when needed, and plan upgrades to newer versions with more confidence.


Please Note: OmniReach is also working toward the next API milestone, v3, which is expected to introduce enhanced capabilities, improved performance, and new endpoints for advanced use cases. Continue checking the official API documentation for the latest available versions.

How to Use Versioned API Documentation


Versioned API documentation helps developers build and maintain integrations against a specific API version. This reduces the risk of referencing the wrong endpoint structure, request schema, or response format when maintaining production systems or planning migrations.


  1. Open the official OmniReach API documentation.

  2. Use the version switcher in the documentation to select the API version you want to reference.



  3. Review the endpoints, request parameters, schemas, and response details for that selected version.

  4. Use older API versions when maintaining existing integrations.

  5. Review newer versions when planning upgrades or building new integrations.


Versioned documentation does not impact existing integrations. It is designed to make API references clearer and more stable for developers.

How to Get Help or Support for the OmniReach API


IMPORTANT: At this time, OmniReach Support does NOT provide setup code auditing or developer consultative services on API-Related topics. However, if your setup is complete and correct - yet an error persists, you may have encountered an API Bug we need to fix.

You can report this bug by filling out this form: https://developers.goomnireach.com/support


For any questions relating to the OmniReach API, join the developer Slack group to ask our community of talented customers here: https://developers.goomnireach.com/join-dev-community


OmniReach Devs host a monthly Developer Council Call on the second to last Friday, which you can find on the events calendar here: https://www.goomnireach.com/events


Check out our Developers Landing Page, where you can find the Developer Marketplace, Documentation, Slack Channel, and more! --> https://developers.goomnireach.com/


Please Note: Our API Docs list all available endpoints that are publicly available. If you don’t see an endpoint on either of the API developer sites listed below, we recommend visiting our GitHub Issues page to submit your request.

Differences Between API Access Across Plan Levels


Basic API access is included with our Starter and Unlimited plans, while Advanced API access is available on our Agency Pro plan.


In addition to the future endpoints that will be released in our OAuth 2.0 API (which is only available in our Advanced API access), this tier unlocks the use of Agency API Keys, where lower plan levels only access Location API Keys.


What are the Rate Limits for API 1.0 & API 2.0?


OmniReach has implemented rate limits on our public V2 APIs using OAuth to ensure optimal performance and stability. These limits have been adjusted to:


Burst limit: A maximum of 100 API requests per 10 seconds for each Marketplace app (i.e., client) per resource (i.e., Location or Company).


Daily limit: 200,000 API requests per day for each Marketplace app (i.e., client) per resource (i.e., Location or Company).


These new limits contribute to better overall performance and stability of our system.



To monitor your limited usage, refer to the following API response headers:


  • 'X-RateLimit-Limit-Daily': Your daily limit

  • 'X-RateLimit-Daily-Remaining': The remaining number of requests for the day

  • 'X-RateLimit-Interval-Milliseconds': The time interval for burst requests

  • 'X-RateLimit-Max': The maximum request limit in the specified time interval

  • 'X-RateLimit-Remaining': The remaining number of requests in the current time interval.

Frequently Asked Questions


Q. What is the OmniReach API used for?

The OmniReach API allows developers to build custom integrations, automate workflows, and connect external applications with the OmniReach platform. It provides REST endpoints for contacts, conversations, calendars, workflows, payments, and more.


Q. Does OmniReach still support API V1?

No. OmniReach API V1 has reached end-of-support. While existing integrations may continue to function, no updates or technical support are provided. Developers should migrate to API V2 for ongoing support and new features.



Q. What authentication methods does the OmniReach API support?

OmniReach supports:


  • Private Integration Tokens for internal or single-location integrations

  • OAuth 2.0 for public integrations and Marketplace apps requiring user authorization



Q. When should I use OAuth 2.0 instead of a Private Integration Token?

Use OAuth 2.0 when:


  • Building a public or Marketplace app

  • Accessing multiple locations or accounts

  • Requiring secure, user-approved access

Private Integration Tokens are best for internal tools or single-account use cases.



Q. What are the API rate limits in OmniReach?

OmniReach enforces:


  • 100 requests per 10 seconds (per resource)

  • 200,000 requests per day (per resource)

Rate limit headers are included in API responses to help track usage.


Q. Can OmniReach Support help me build or debug my API integration?

No. OmniReach Support does not provide hands-on API development or debugging assistance. For help, developers should:

  • Review the official API documentation

  • Join the OmniReach Developer Community

  • Report bugs via the Developer Support portal



Q. Where can I find the official OmniReach API documentation?

The official API documentation is available on the OmniReach Developer Marketplace: https://marketplace.goomnireach.com/docs/



Q. Is API access available on all OmniReach plans?

API access varies by plan:

  • Starter & Unlimited: Basic API access

  • Agency Pro: Advanced API access, including OAuth and agency-level tokens

Some endpoints may only be available on higher plans.



Q. How do I request a new API feature or endpoint?

You can submit API feature requests or report documentation issues by creating an issue in the official GitHub repository for OmniReach API docs.




Q. Does OmniReach provide SDKs or webhooks?

Yes. OmniReach offers webhooks for real-time event updates, and SDKs are available or supported for certain integrations. Refer to the API documentation for supported webhook events and SDK details.



Q. Can I view documentation for different API versions?
Yes. OmniReach API documentation now includes versioned references, allowing developers to select the API version they want to view from the version switcher.



Q. Does API documentation versioning affect my existing integrations?
No. Versioned documentation does not impact existing integrations. It helps developers reference the correct API version and maintain stable integrations.



Q. Why should I select a specific API version in the documentation?
Selecting a specific API version helps ensure you are reviewing the correct endpoints, schemas, request parameters, and response details for the version your integration uses.



Q. Are older API versions still documented?
Yes. Older API versions remain accessible and documented so developers can maintain existing integrations and plan migrations more easily.



Q. Is API v3 available now?
Not yet, based on the release note. OmniReach is working on v3 as the next API milestone. Users should refer to the official API documentation for current availability.

Help & Support


OmniReach Support does not provide hands-on API coding help or setup auditing. If you encounter issues:


1. For API Bugs

Report a bug directly here: https://developers.goomnireach.com/support


2. Developer Community

Join the OmniReach Dev Slack to collaborate with other developers: https://developers.goomnireach.com/join-dev-community

For hands-on help, email info@omnireach.co or chat with us directly!

Need help getting unstuck?

Email Support