# API ### API **Overview** 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. *** ### How it works 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 *** ### Access and authentication 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. *** ### API documentation Our full API reference is maintained separately and includes: * Available endpoints and methods * Request and response formats * Authentication details * Example payloads 👉 *** ### Important notes * 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 *** ### Need help? 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. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.ubiquity.co.nz/documentation/data-and-integrations/api.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.