Bloomerang Addresses API
The Addresses API from Bloomerang — 3 operation(s) for addresses.
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-addresses-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 Addresses 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: Addresses
paths:
/addresses:
get:
tags:
- Addresses
summary: Gets a list of addresses
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: lastModified
schema:
type: string
format: date-time
description: Filters to addresses last modified after the specified date
- 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 address.
- 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 address.
responses:
'200':
description: The list of addresses 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
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Type:
type: string
enum:
- Home
- Vacation
- Work
Street:
type: string
City:
type: string
State:
type: string
description: Must match a state in the Bloomerang CRM
PostalCode:
type: string
Country:
type: string
description: Must match a state in the Bloomerang CRM
IsPrimary:
type: boolean
IsBad:
type: boolean
- type: object
properties:
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
- type: object
properties:
StateAbbreviation:
type: string
description: The 2-3 letter abbreviation for the state/province
CountryCode:
type: string
description: The 2 letter ISO code for the country
operationId: getAddresses
x-operation-id-source: derived
/address:
post:
tags:
- Addresses
summary: Creates an address
requestBody:
required: true
content:
application/json:
schema:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Type:
type: string
enum:
- Home
- Vacation
- Work
Street:
type: string
City:
type: string
State:
type: string
description: Must match a state in the Bloomerang CRM
PostalCode:
type: string
Country:
type: string
description: Must match a state in the Bloomerang CRM
IsPrimary:
type: boolean
IsBad:
type: boolean
required:
- Type
- Country
responses:
'200':
description: The address was created successfully.
content:
application/json:
schema:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Type:
type: string
enum:
- Home
- Vacation
- Work
Street:
type: string
City:
type: string
State:
type: string
description: Must match a state in the Bloomerang CRM
PostalCode:
type: string
Country:
type: string
description: Must match a state in the Bloomerang CRM
IsPrimary:
type: boolean
IsBad:
type: boolean
- type: object
properties:
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
- type: object
properties:
StateAbbreviation:
type: string
description: The 2-3 letter abbreviation for the state/province
CountryCode:
type: string
description: The 2 letter ISO code for the country
operationId: postAddress
x-operation-id-source: derived
/address/{id}:
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
description: The ID of the address to return.
get:
tags:
- Addresses
summary: Gets an address by ID
responses:
'200':
description: The address with the given ID.
content:
application/json:
schema:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Type:
type: string
enum:
- Home
- Vacation
- Work
Street:
type: string
City:
type: string
State:
type: string
description: Must match a state in the Bloomerang CRM
PostalCode:
type: string
Country:
type: string
description: Must match a state in the Bloomerang CRM
IsPrimary:
type: boolean
IsBad:
type: boolean
- type: object
properties:
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
- type: object
properties:
StateAbbreviation:
type: string
description: The 2-3 letter abbreviation for the state/province
CountryCode:
type: string
description: The 2 letter ISO code for the country
operationId: getAddressById
x-operation-id-source: derived
put:
tags:
- Addresses
summary: Updates an address
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
Id:
type: integer
format: int64
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Type:
type: string
enum:
- Home
- Vacation
- Work
Street:
type: string
City:
type: string
State:
type: string
description: Must match a state in the Bloomerang CRM
PostalCode:
type: string
Country:
type: string
description: Must match a state in the Bloomerang CRM
IsPrimary:
type: boolean
IsBad:
type: boolean
responses:
'200':
description: The address was updated successfully.
content:
application/json:
schema:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AccountId:
type: integer
format: int64
description: The ID of the constituent used in the API (not to be confused with accountNumber)
Type:
type: string
enum:
- Home
- Vacation
- Work
Street:
type: string
City:
type: string
State:
type: string
description: Must match a state in the Bloomerang CRM
PostalCode:
type: string
Country:
type: string
description: Must match a state in the Bloomerang CRM
IsPrimary:
type: boolean
IsBad:
type: boolean
- type: object
properties:
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
- type: object
properties:
StateAbbreviation:
type: string
description: The 2-3 letter abbreviation for the state/province
CountryCode:
type: string
description: The 2 letter ISO code for the country
operationId: putAddressById
x-operation-id-source: derived
delete:
tags:
- Addresses
summary: Deletes an address
responses:
'200':
description: The address 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: deleteAddressById
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)