> For the complete documentation index, see [llms.txt](https://docs.ubiquity.co.nz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference.md).

# API Reference

- [Database](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database.md)
- [Get the errors from a transactional database import.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-the-errors-from-a-transactional-database-import.md)
- [Get the status of a transactional database import.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-the-status-of-a-transactional-database-import.md)
- [Import transactions into a transactional database.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/import-transactions-into-a-transactional-database.md)
- [Upload a transactional database import file. File is scanned for viruses before being stored.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/upload-a-transactional-database-import-file-file-is-scanned-for-viruses-before-being-stored.md)
- [Get all transactions in a transactional database](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-all-transactions-in-a-transactional-database.md)
- [Query transactions in a transactional database using filter criteria.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/query-transactions-in-a-transactional-database-using-filter-criteria.md)
- [Gets your transactional database schema](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/gets-your-transactional-database-schema.md)
- [Get a list of your transactional databases](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-a-list-of-your-transactional-databases.md)
- [Get the errors from a contact database import.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-the-errors-from-a-contact-database-import.md)
- [Get the status of a contact database import.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-the-status-of-a-contact-database-import.md)
- [Import contacts into the database.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/import-contacts-into-the-database.md)
- [Upload a contact database import file. File is scanned for viruses before being stored.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/upload-a-contact-database-import-file-file-is-scanned-for-viruses-before-being-stored.md)
- [Download a file from a Contacts Transactional Database File Upload Field.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/download-a-file-from-a-contacts-transactional-database-file-upload-field.md)
- [Delete a file from a Contacts Transactional Database File Upload Field.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/delete-a-file-from-a-contacts-transactional-database-file-upload-field.md)
- [Get a list of Files in a File Upload Field.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-a-list-of-files-in-a-file-upload-field.md)
- [Upload a file into a Contact FileUpload Field](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/upload-a-file-into-a-contact-fileupload-field.md)
- [Create a new transaction](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/create-a-new-transaction.md)
- [Update an existing Transaction](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/update-an-existing-transaction.md)
- [Delete a transaction](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/delete-a-transaction.md)
- [Get transactions for the specified contact](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-transactions-for-the-specified-contact.md)
- [Create a new transaction](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/create-a-new-transaction-1.md)
- [Get a list of all email sent to a contact.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-a-list-of-all-email-sent-to-a-contact.md)
- [Get a list of events for a received message.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-a-list-of-events-for-a-received-message.md)
- [Resend a received email](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/resend-a-received-email.md)
- [Get a rendered copy of an recieved email.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-a-rendered-copy-of-an-recieved-email.md)
- [Get a complete list of all contact events to/by a contact.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-a-complete-list-of-all-contact-events-to-by-a-contact.md)
- [Download a file from a Contacts File Upload Field.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/download-a-file-from-a-contacts-file-upload-field.md)
- [Delete a file from a Contacts File Upload Field.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/delete-a-file-from-a-contacts-file-upload-field.md)
- [Get a list of Files in a File Upload Field.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-a-list-of-files-in-a-file-upload-field-1.md)
- [Upload a file into a Contact FileUpload Field](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/upload-a-file-into-a-contact-fileupload-field-1.md)
- [Query contacts using filter criteria.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/query-contacts-using-filter-criteria.md)
- [Gets up to a max of 150 contacts.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/gets-up-to-a-max-of-150-contacts.md)
- [Create a new contact.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/create-a-new-contact.md)
- [Get the specified contact.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-the-specified-contact.md)
- [Updates an existing contact.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/updates-an-existing-contact.md)
- [Deletes an existing contact](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/deletes-an-existing-contact.md)
- [Get a list filter by id.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-a-list-filter-by-id.md)
- [Get the list filters.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/get-the-list-filters.md)
- [Gets your database schema](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/database/gets-your-database-schema.md)
- [Forms](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/forms.md)
- [Validate a form submission without posting it.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/forms/validate-a-form-submission-without-posting-it.md)
- [Submit a form.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/forms/submit-a-form.md)
- [Get the Definition of the Form](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/forms/get-the-definition-of-the-form.md)
- [Mail](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail.md)
- [Run an automated mailout immediately.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/run-an-automated-mailout-immediately.md)
- [Get a list of automated mailouts with optional filtering.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/get-a-list-of-automated-mailouts-with-optional-filtering.md)
- [Get a list of automated mailout folders.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/get-a-list-of-automated-mailout-folders.md)
- [Get a list of recipients for an automated mailout.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/get-a-list-of-recipients-for-an-automated-mailout.md)
- [Get a list of events for an automated mailout.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/get-a-list-of-events-for-an-automated-mailout.md)
- [Get a summary of automated mailout statistics for specified IDs or tags.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/get-a-summary-of-automated-mailout-statistics-for-specified-ids-or-tags.md)
- [Get a list of mailouts with optional filtering.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/get-a-list-of-mailouts-with-optional-filtering.md)
- [Get a list of mailout folders.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/get-a-list-of-mailout-folders.md)
- [Get a list of recipients for a mailout.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/get-a-list-of-recipients-for-a-mailout.md)
- [Get a list of events for a mailout.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/get-a-list-of-events-for-a-mailout.md)
- [Render an email template for a list of contacts.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/render-an-email-template-for-a-list-of-contacts.md)
- [Get a rendered preview of an email template for a contact.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/get-a-rendered-preview-of-an-email-template-for-a-contact.md)
- [Get a list of all email templates.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/mail/get-a-list-of-all-email-templates.md)
- [Push](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/push.md)
- [Run an automated notification](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/push/run-an-automated-notification.md)
- [Gets the registration information for the specified device](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/push/gets-the-registration-information-for-the-specified-device.md)
- [Registers a new device to receive push notifications](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/push/registers-a-new-device-to-receive-push-notifications.md)
- [Unregisters a device](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/push/unregisters-a-device.md)
- [Gets the Information about the push message](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/push/gets-the-information-about-the-push-message.md)
- [Gets up to a maximum of 150 device registrations](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/push/gets-up-to-a-maximum-of-150-device-registrations.md)
- [Send a push notification to a device.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/push/send-a-push-notification-to-a-device.md)
- [Get a list of all the apps.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/push/get-a-list-of-all-the-apps.md)
- [Surveys](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/surveys.md)
- [Get the count of all responses.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/surveys/get-the-count-of-all-responses.md)
- [Get all responses for a survey.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/surveys/get-all-responses-for-a-survey.md)
- [Txt](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt.md)
- [Run an automated TXT](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt/run-an-automated-txt.md)
- [Gets the number of messages sent as part of a TXT programme. The message count is partitioned 
  into Inbound, Outbound, Api and TxtOut categories.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt/gets-the-number-of-messages-sent-as-part-of-a-txt-programme-the-message-count-is-partitioned-into-in.md)
- [Get a single TXT message by ID.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt/get-a-single-txt-message-by-id.md)
- [Gets TXT messages sent as part of a TXT programme.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt/gets-txt-messages-sent-as-part-of-a-txt-programme.md)
- [Gets TXT messages sent as part of a TXT programme.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt/gets-txt-messages-sent-as-part-of-a-txt-programme-1.md)
- [Send an SMS to a contact by reference ID.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt/send-an-sms-to-a-contact-by-reference-id.md)
- [Gets TXT messages sent as part of a TXT programme.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt/gets-txt-messages-sent-as-part-of-a-txt-programme-2.md)
- [Send an SMS to a contact by reference ID.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt/send-an-sms-to-a-contact-by-reference-id-1.md)
- [Send an SMS to a contact or mobile number.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt/send-an-sms-to-a-contact-or-mobile-number.md)
- [Get a list of all TXT programmes.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt/get-a-list-of-all-txt-programmes.md)
- [Get a TXT programme by ID.](https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference/txt/get-a-txt-programme-by-id.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.ubiquity.co.nz/documentation/data-and-integrations/api/api-reference.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.