API
Use the API to integrate UbiQuity with other platforms and build custom workflows.
Last updated
Was this helpful?
Use the API to integrate UbiQuity with other platforms and build custom workflows.
The UbiQuity API allows you to securely connect your account with external systems, automate processes, and extend platform functionality beyond the standard UI.
Typical use cases include:
Syncing data between UbiQuity and external systems (e.g. CRM, data warehouse)
Triggering events or workflows from third-party platforms
Managing contacts, lists, and activity programmatically
Building custom integrations tailored to your organisation
The API is designed to be flexible and reliable, supporting both simple integrations and more advanced use cases.
The API is REST-based and uses standard HTTP methods for interacting with UbiQuity data.
Access is authenticated using API credentials, ensuring all requests are secure and scoped to your account.
Depending on your use case, you can:
Retrieve data from UbiQuity (e.g. contacts, lists, events)
Send data into UbiQuity (e.g. create or update contacts)
Trigger actions such as events or workflows
To use the API, you’ll need valid API credentials.
These credentials:
Authenticate your requests
Control access to your account data
Should be stored securely and never exposed publicly
If you don’t already have API access, contact your UbiQuity consultant or support team.
Our full API reference is maintained separately and includes:
Available endpoints and methods
Request and response formats
Authentication details
Example payloads
👉 https://resources.ubiquity.co.nz/Api
The API documentation is hosted separately and reflects the current supported endpoints
Some legacy behaviours may still exist for backwards compatibility
We recommend validating integrations in a test environment before going live
If you’re planning an integration or need guidance, our team can help you design and implement the right approach.
Contact your UbiQuity consultant or reach out to support for assistance.
Last updated
Was this helpful?
Was this helpful?