Bloomerang Custom Fields API
Account-specific custom field definitions by object type.
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-custom-fields-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 Custom Fields 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: Custom Fields
paths:
/customFieldCategories/{type}/:
get:
tags:
- Custom Fields
summary: Gets a list of custom field categories
parameters:
- in: path
name: type
required: true
schema:
type: string
enum:
- Constituent
- Transaction
- Interaction
- Note
- Benevon
description: Filters categories for the given object type.
responses:
'200':
description: The list of custom field categories that met the specified filters.
content:
application/json:
schema:
type: array
items:
properties:
Id:
type: integer
format: int64
Name:
type: string
SortIndex:
type: integer
format: int32
operationId: getCustomFieldCategoriesByType
x-operation-id-source: derived
/customFields/{type}/:
get:
tags:
- Custom Fields
summary: Gets a list of custom fields
parameters:
- in: path
name: type
required: true
schema:
type: string
enum:
- Constituent
- Transaction
- Interaction
- Note
- Benevon
description: Filters fields for the given object type.
- in: query
name: isActive
schema:
type: boolean
default: true
description: Filters to only fields that are active (or inactive)
- in: query
name: lastModified
schema:
type: string
format: date-time
description: Filters to custom fields last modified after the specified date
responses:
'200':
description: The list of custom fields that met the specified filters.
content:
application/json:
schema:
type: array
items:
properties:
Id:
type: integer
format: int64
CategoryId:
type: integer
format: int64
Name:
type: string
IsRequired:
type: boolean
IsActive:
type: boolean
DataType:
type: string
enum:
- Currency
- Date
- Decimal
- Text
- Year
PickType:
type: string
enum:
- Freeform
- PickMultiple
- PickOne
SortIndex:
type: integer
format: int32
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
operationId: getCustomFieldsByType
x-operation-id-source: derived
/customValues/{type}:
get:
tags:
- Custom Fields
summary: Gets a list of custom values for all pick fields of the given object type
parameters:
- in: path
name: type
required: true
schema:
type: string
enum:
- Constituent
- Transaction
- Interaction
- Note
- Benevon
description: Filters fields for the given object type.
- in: query
name: isActive
schema:
type: boolean
default: true
description: Filters to only values that are active (or inactive)
- in: query
name: lastModified
schema:
type: string
format: date-time
description: Filters to custom field values last modified after the specified date
responses:
'200':
description: The list of custom values that met the specified filters.
content:
application/json:
schema:
type: array
items:
properties:
Id:
type: integer
format: int64
FieldId:
type: integer
format: int64
Value:
type: string
IsActive:
type: boolean
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
operationId: getCustomValuesByType
x-operation-id-source: derived
/customValues/{type}/{fieldId}:
get:
tags:
- Custom Fields
summary: Gets a list of custom values for the given field
parameters:
- in: path
name: type
required: true
schema:
type: string
enum:
- Constituent
- Transaction
- Interaction
- Note
- Benevon
description: Filters fields for the given object type.
- in: path
name: fieldId
required: true
schema:
type: integer
format: int64
description: The custom field ID the values belong to
- in: query
name: isActive
schema:
type: boolean
default: true
description: Filters to only values that are active (or inactive)
- in: query
name: lastModified
schema:
type: string
format: date-time
description: Filters to custom field values last modified after the specified date
responses:
'200':
description: The list of custom values that met the specified filters.
content:
application/json:
schema:
type: array
items:
properties:
Id:
type: integer
format: int64
FieldId:
type: integer
format: int64
Value:
type: string
IsActive:
type: boolean
AuditTrail:
properties:
CreatedDate:
type: string
format: date-time
CreatedName:
type: string
LastModifiedDate:
type: string
format: date-time
LastModifiedName:
type: string
operationId: getCustomValuesByTypeByFieldId
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)