Bloomerang Notes API
Freeform notes attached to a constituent record.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/bloomerang:bloomerang-notes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Bloomerang Notes API
description: Private-key API for Bloomerang CRM
version: 2.0.0
contact:
name: Bloomerang
url: https://www.bloomerang.com/
email: support@bloomerang.com
servers:
- url: https://api.bloomerang.co/v2
security:
- ApiKeyAuth: []
- OAuth2: []
tags:
- name: Notes
paths:
/notes:
get:
tags:
- Notes
summary: Gets a list of notes
parameters:
- in: query
name: skip
schema:
type: integer
minimum: 0
default: 0
description: The number of items to skip before starting to collect the result set.
- in: query
name: take
schema:
type: integer
minimum: 1
maximum: 50
default: 50
description: The number of items to include in the result set.
- in: query
name: constituent
style: pipeDelimited
explode: false
schema:
type: array
items:
type: integer
format: int64
description: Filters results based on the Constituent ID for the note.
- in: query
name: id
style: pipeDelimited
explode: false
schema:
type: array
items:
type: integer
format: int64
description: Filters results based on the ID for the note.
- in: query
name: orderBy
schema:
type: string
enum:
- CreatedDate
- Date
- LastModifiedDate
description: Sorts by Date, CreatedDate, or LastModifiedDate (default Date).
- in: query
name: orderDirection
schema:
type: string
enum:
- Asc
- Desc
description: Sorts the orderBy in ascending or descending order.
responses:
'200':
description: The list of notes that met the specified filters.
content:
application/json:
schema:
allOf:
- properties:
Total:
type: integer
description: The total number of records in Bloomerang.
TotalFiltered:
type: integer
description: The total number of records that match the filters.
Start:
type: integer
description: The 0-based index of the first record.
ResultCount:
type: integer
description: The number of records included in the result set.
- type: object
properties:
Results:
type: array
items:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AttachmentIds:
type: array
items:
type: integer
format: int64
description: The IDs of the attachments on this note
- properties:
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Date:
type: string
format: date
Note:
type: string
- type: object
properties:
CustomValues:
type: array
items:
oneOf:
- properties:
FieldId:
type: integer
format: int64
FieldText:
type: string
description: The label/text of the custom field
Value:
properties:
Id:
type: integer
format: int64
Value:
type: string
- properties:
FieldId:
type: integer
format: int64
FieldText:
type: string
description: The label/text of the custom field
Values:
type: array
items:
properties:
Id:
type: integer
format: int64
Value:
type: string
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
operationId: getNotes
x-operation-id-source: derived
/note:
post:
tags:
- Notes
summary: Creates a note
requestBody:
required: true
content:
application/json:
schema:
allOf:
- allOf:
- properties:
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Date:
type: string
format: date
Note:
type: string
- type: object
properties:
CustomValues:
type: array
items:
oneOf:
- properties:
FieldId:
type: integer
format: int64
Value:
type: string
description: The value to assign; null clears the field
- properties:
FieldId:
type: integer
format: int64
ValueId:
type: integer
format: int64
description: The ID of the pick value to assign; null clears the field
- properties:
FieldId:
type: integer
format: int64
ValueIds:
type: array
items:
type: integer
format: int64
description: The ID of the pick value to assign; an empty array clears the field
Attachments:
type: array
items:
oneOf:
- allOf:
- properties:
Guid:
type: string
description: The GUID of the object uploaded to S3. This should be generated by the client that is uploading the file attachment.
- description: Validation notes - URL is required. If creating attachments directly via the attachments endpoint (as opposed to including them a nested objects within other models), ParentType and ParentId are required.
properties:
Name:
type: string
description: User-friendly file name without the extension.
Extension:
type: string
description: No dot needed (use "txt" instead of ".txt"). May be null if the attachment is just a URL.
- properties:
Url:
type: string
format: uri
description: If the file is stored in Bloomerang (not just a URL), this URL will only be good for 24 hours
- allOf:
- properties:
Id:
type: integer
format: int64
- description: Validation notes - URL is required. If creating attachments directly via the attachments endpoint (as opposed to including them a nested objects within other models), ParentType and ParentId are required.
properties:
Name:
type: string
description: User-friendly file name without the extension.
Extension:
type: string
description: No dot needed (use "txt" instead of ".txt"). May be null if the attachment is just a URL.
- properties:
Url:
type: string
format: uri
description: If the file is stored in Bloomerang (not just a URL), this URL will only be good for 24 hours
required:
- AccountId
- Date
- Note
responses:
'200':
description: The note was created successfully.
content:
application/json:
schema:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AttachmentIds:
type: array
items:
type: integer
format: int64
description: The IDs of the attachments on this note
- properties:
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Date:
type: string
format: date
Note:
type: string
- type: object
properties:
CustomValues:
type: array
items:
oneOf:
- properties:
FieldId:
type: integer
format: int64
FieldText:
type: string
description: The label/text of the custom field
Value:
properties:
Id:
type: integer
format: int64
Value:
type: string
- properties:
FieldId:
type: integer
format: int64
FieldText:
type: string
description: The label/text of the custom field
Values:
type: array
items:
properties:
Id:
type: integer
format: int64
Value:
type: string
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
operationId: postNote
x-operation-id-source: derived
/note/{id}:
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
description: The ID of the note to return.
get:
tags:
- Notes
summary: Gets a note by ID
responses:
'200':
description: The note with the given ID.
content:
application/json:
schema:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AttachmentIds:
type: array
items:
type: integer
format: int64
description: The IDs of the attachments on this note
- properties:
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Date:
type: string
format: date
Note:
type: string
- type: object
properties:
CustomValues:
type: array
items:
oneOf:
- properties:
FieldId:
type: integer
format: int64
FieldText:
type: string
description: The label/text of the custom field
Value:
properties:
Id:
type: integer
format: int64
Value:
type: string
- properties:
FieldId:
type: integer
format: int64
FieldText:
type: string
description: The label/text of the custom field
Values:
type: array
items:
properties:
Id:
type: integer
format: int64
Value:
type: string
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
operationId: getNoteById
x-operation-id-source: derived
put:
tags:
- Notes
summary: Updates a note
requestBody:
required: true
content:
application/json:
schema:
allOf:
- allOf:
- properties:
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Date:
type: string
format: date
Note:
type: string
- type: object
properties:
CustomValues:
type: array
items:
oneOf:
- properties:
FieldId:
type: integer
format: int64
Value:
type: string
description: The value to assign; null clears the field
- properties:
FieldId:
type: integer
format: int64
ValueId:
type: integer
format: int64
description: The ID of the pick value to assign; null clears the field
- properties:
FieldId:
type: integer
format: int64
ValueIds:
type: array
items:
type: integer
format: int64
description: The ID of the pick value to assign; an empty array clears the field
Attachments:
type: array
items:
oneOf:
- allOf:
- properties:
Guid:
type: string
description: The GUID of the object uploaded to S3. This should be generated by the client that is uploading the file attachment.
- description: Validation notes - URL is required. If creating attachments directly via the attachments endpoint (as opposed to including them a nested objects within other models), ParentType and ParentId are required.
properties:
Name:
type: string
description: User-friendly file name without the extension.
Extension:
type: string
description: No dot needed (use "txt" instead of ".txt"). May be null if the attachment is just a URL.
- properties:
Url:
type: string
format: uri
description: If the file is stored in Bloomerang (not just a URL), this URL will only be good for 24 hours
- allOf:
- properties:
Id:
type: integer
format: int64
- description: Validation notes - URL is required. If creating attachments directly via the attachments endpoint (as opposed to including them a nested objects within other models), ParentType and ParentId are required.
properties:
Name:
type: string
description: User-friendly file name without the extension.
Extension:
type: string
description: No dot needed (use "txt" instead of ".txt"). May be null if the attachment is just a URL.
- properties:
Url:
type: string
format: uri
description: If the file is stored in Bloomerang (not just a URL), this URL will only be good for 24 hours
responses:
'200':
description: The note was updated successfully.
content:
application/json:
schema:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AttachmentIds:
type: array
items:
type: integer
format: int64
description: The IDs of the attachments on this note
- properties:
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Date:
type: string
format: date
Note:
type: string
- type: object
properties:
CustomValues:
type: array
items:
oneOf:
- properties:
FieldId:
type: integer
format: int64
FieldText:
type: string
description: The label/text of the custom field
Value:
properties:
Id:
type: integer
format: int64
Value:
type: string
- properties:
FieldId:
type: integer
format: int64
FieldText:
type: string
description: The label/text of the custom field
Values:
type: array
items:
properties:
Id:
type: integer
format: int64
Value:
type: string
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
operationId: putNoteById
x-operation-id-source: derived
delete:
tags:
- Notes
summary: Deletes a note
responses:
'200':
description: The note was deleted successfully.
content:
application/json:
schema:
properties:
Id:
type: integer
description: The ID of the object that was deleted
format: int64
Type:
type: string
description: The type of object that was deleted
Deleted:
type: boolean
description: True if the object was deleted
operationId: deleteNoteById
x-operation-id-source: derived
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
OAuth2:
type: oauth2
description: OAuth 2 with the authorization code flow.
flows:
authorizationCode:
authorizationUrl: https://crm.bloomerang.com/authorize/
tokenUrl: https://api.bloomerang.co/v2/oauth/token
refreshUrl: https://api.bloomerang.co/v2/oauth/token
scopes:
ViewOnly: Base level view-only privileges
StandardEditFinancialData: Base level privileges and ability to edit financial data
Standard: Same privileges as a standard user (includes transaction edit)
OrgAdmin: Privileges of an Organization Administrator
externalDocs:
url: https://www.bloomerang.com/openapi_errorcodes.html
description: Error Codes
x-provenance:
method: harvested
publisher: Bloomerang
source: https://bloomerang-api-documentation.s3.us-west-2.amazonaws.com/public_crm_generated.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)