Public API

Welcome to the Public API documentation.

• Location Management is changing to explicit inclusion. Endpoints will soon be available allowing you to manage the locations you have access to. Watch for updates in the next few weeks.
• Webhooks: StreamAPI webhooks are fully supported and in Production. Notifications are delivered over Amazon SNS.
• SNS Domains List has been updated to the current list of domains supporting changes from the UI.
• RabbitMQ deprecation: RabbitMQ support ended on 9/27/2026.
• 1970-01-01: The use of lastModified date equal to or greater than 1970-01-01 results in a full table scan and if used in production will result in prod access being revoked due to perfromance implications.
• page=: page= in pagination related queries has been deprecated for over 6 months. It will be completely removed in Q2 2026.
• total: Total count in pagination queries has been documented to help with understanding edge cases. We witnessed multiple consumers incorrectly using total in pagination queries. total in pagination requests is deprecated in lieu of totalCount endpoints in each pagination based query.

For detailed explanations of any of these topics, please refer to the appropriate KB article.

Use the left navigation to browse:

• API Download: Download the Public API and StreamAPI webhooks OpenAPI specifications (YAML)
• Webhooks: StreamAPI data change notifications delivered over Amazon SNS
• API Endpoints: Organized by functional categories
• Knowledge Base: Implementation guides and best practices
• Release Notes: Latest updates and changes

This API is available in multiple environments:

• Mock
• Sandbox
• Production

Select your environment from the server dropdown above.