Bloomerang Relationships API
Relationships between two constituents.
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-relationships-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 Relationships 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: Relationships
paths:
/relationship:
post:
tags:
- Relationships
summary: Creates a Relationship between two non-household Constituents
requestBody:
required: true
content:
application/json:
schema:
allOf:
- allOf:
- properties:
Id:
type: integer
format: int64
AccountId1:
type: integer
format: int64
AccountId2:
type: integer
format: int64
Note:
type: string
properties:
RelationshipRoleId1:
type: integer
format: int64
RelationshipRoleId2:
type: integer
format: int64
required:
- AccountId1
- AccountId2
- RelationshipRoleId1
- RelationshipRoleId2
responses:
'200':
description: The relationship was created successfully.
content:
application/json:
schema:
allOf:
- properties:
Id:
type: integer
format: int64
AccountId1:
type: integer
format: int64
AccountId2:
type: integer
format: int64
Note:
type: string
properties:
RelationshipRole1:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
- allOf:
- type: object
properties:
SortIndex:
type: integer
format: int32
- properties:
Name:
type: string
IsDefault:
type: boolean
description: Is this the default?
IsActive:
type: boolean
description: Is this active?
RelationshipRole2:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
- allOf:
- type: object
properties:
SortIndex:
type: integer
format: int32
- properties:
Name:
type: string
IsDefault:
type: boolean
description: Is this the default?
IsActive:
type: boolean
description: Is this active?
operationId: postRelationship
x-operation-id-source: derived
/relationship/{id}:
parameters:
- in: path
name: id
required: true
schema:
type: integer
format: int64
description: The ID of the relationship
get:
tags:
- Relationships
summary: Gets a relationship
responses:
'200':
description: The Relationship that was found
content:
application/json:
schema:
allOf:
- properties:
Id:
type: integer
format: int64
AccountId1:
type: integer
format: int64
AccountId2:
type: integer
format: int64
Note:
type: string
properties:
RelationshipRole1:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
- allOf:
- type: object
properties:
SortIndex:
type: integer
format: int32
- properties:
Name:
type: string
IsDefault:
type: boolean
description: Is this the default?
IsActive:
type: boolean
description: Is this active?
RelationshipRole2:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
- allOf:
- type: object
properties:
SortIndex:
type: integer
format: int32
- properties:
Name:
type: string
IsDefault:
type: boolean
description: Is this the default?
IsActive:
type: boolean
description: Is this active?
operationId: getRelationshipById
x-operation-id-source: derived
put:
tags:
- Relationships
summary: Updates a relationship
requestBody:
required: true
content:
application/json:
schema:
allOf:
- allOf:
- properties:
Id:
type: integer
format: int64
AccountId1:
type: integer
format: int64
AccountId2:
type: integer
format: int64
Note:
type: string
properties:
RelationshipRoleId1:
type: integer
format: int64
RelationshipRoleId2:
type: integer
format: int64
required:
- Id
responses:
'200':
description: The Relationship was updated
content:
application/json:
schema:
allOf:
- properties:
Id:
type: integer
format: int64
AccountId1:
type: integer
format: int64
AccountId2:
type: integer
format: int64
Note:
type: string
properties:
RelationshipRole1:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
- allOf:
- type: object
properties:
SortIndex:
type: integer
format: int32
- properties:
Name:
type: string
IsDefault:
type: boolean
description: Is this the default?
IsActive:
type: boolean
description: Is this active?
RelationshipRole2:
allOf:
- type: object
properties:
Id:
type: integer
format: int64
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
- allOf:
- type: object
properties:
SortIndex:
type: integer
format: int32
- properties:
Name:
type: string
IsDefault:
type: boolean
description: Is this the default?
IsActive:
type: boolean
description: Is this active?
operationId: putRelationshipById
x-operation-id-source: derived
delete:
tags:
- Relationships
summary: Deletes a Relationship
responses:
'201':
description: The relationship 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: deleteRelationshipById
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)