Authenticate each request with your API credentials and the required scope such as contacts.readonly to access read-only endpoints.
Within Bloomerang, set up an OAuth connection to obtain an access token and refresh token for API calls, following standard security practices.
GET /contacts/:contactId — fetch a single contact; GET /contacts/:contactId/tasks — fetch tasks for a contact; GET /contacts/:contactId/tasks/:taskId — fetch a specific task; GET /contacts/:contactId/notes — fetch notes for a contact; GET /contacts/:contactId/notes/:id — fetch a specific note; GET /contacts/:contactId/appointments — fetch appointments for a contact; GET /contacts/ — list contacts; GET /contacts/business/:businessId — fetch contacts by business; POST /contacts/ — create a contact; PUT /contacts/:contactId — update a contact; DELETE /contacts/:contactId — delete a contact; POST /contacts/:contactId/tasks — create a task; PUT /contacts/:contactId/tasks/:taskId — update a task; PUT /contacts/:contactId/tasks/:taskId/completed — mark task completed; DELETE /contacts/:contactId/tasks/:taskId — delete a task; POST /contacts/:contactId/tags — add tags to a contact
Trigger when a contact is created or updated in Bloomerang to synchronize changes via the API.
Create or update contact records; attach related tasks and notes as they change.
POST /contacts/ to create; PUT /contacts/:contactId to update existing records.
Key fields include contactId, name, email, phone, businessId, and relevant tags.
On contact update, automatically create or modify tasks.
Create tasks with POST /contacts/:contactId/tasks; update or complete tasks with PUT /contacts/:contactId/tasks/:taskId or DELETE as needed.
POST /contacts/:contactId/tasks; PUT /contacts/:contactId/tasks/:taskId; DELETE /contacts/:contactId/tasks/:taskId
Key fields include taskId, contactId, title, dueDate, status, and priority.
When notes are created or appointments are scheduled, sync to Bloomerang.
Create notes with POST /contacts/:contactId/notes; read or create appointments with GET /contacts/:contactId/appointments.
POST /contacts/:contactId/notes; GET /contacts/:contactId/appointments
Key fields include noteId, appointmentId, contactId, and timestamps.
Faster onboarding with pre-built workflows that map to common contact processes.
Automated, bidirectional data sync minimizes manual data entry and errors.
Scalable architecture with flexible endpoints and customization options.
This glossary defines core elements like endpoints, triggers, actions, and fields used when connecting the Bloomerang Contacts API to Bloomerang.
An application programming interface that allows programs to communicate with the Bloomerang Contacts API to read or modify data.
A specific URL path to access a particular API function, such as GET /contacts/:contactId.
An authorization framework used to obtain access tokens for API requests in a secure way.
A callback URL that the API calls to notify your app of events like changes to a contact.
Consolidate contact data from multiple sources into Bloomerang to present a complete history in a single view.
Automatically generate tasks based on contact events to keep teams proactive and organized.
Log notes and appointments to build a rich activity timeline you can reference in reports.
Obtain client credentials (client_id and client_secret) from Bloomerang to authorize your app.
Complete the OAuth flow to receive access and refresh tokens for API calls.
Test the connection in a sandbox and begin syncing contacts, tasks, notes, and appointments.
The Bloomerang Contacts API lets you read and retrieve data about contacts, their tasks, notes, and appointments. You can combine endpoints to build custom automations, sync records, and populate your own interfaces with Bloomerang data.
API access is generally available on the plans that include developer or integration features; enable it in Bloomerang settings or contact sales if needed. Ensure you have the proper permissions and the required scope (for example, contacts.readonly) for read operations.
Authentication uses OAuth 2.0. Obtain an access token and include it in the Authorization header for each request. Store tokens securely and refresh before they expire. Use the appropriate scope for your needs, such as contacts.readonly.
Yes, you can create and update resources such as contacts, tasks, and notes via endpoints like POST /contacts/ and POST /contacts/:contactId/tasks. You can also modify or delete existing data with PUT or DELETE requests. Link tasks and notes to their related contacts as needed.
There are rate limits per minute or per hour; if you exceed them you may receive 429 responses. Plan your calls, implement retries with exponential backoff, and consult the docs for guidance on limits.
Test endpoints using a sandbox or test credentials provided by Bloomerang to validate payloads and responses. Use sample data to verify field formats and error handling before production.
Documentation is available in the Bloomerang developer portal. Look for the Contacts API reference, authentication details, endpoint descriptions, and practical examples to guide your integration.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
