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.
openapi: 3.2.0
info:
title: Bloomerang Groups 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: Groups
paths:
/groups:
get:
tags:
- Groups
summary: Gets a list of groups
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.
responses:
'200':
description: The list of all groups.
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
Name:
type: string
Description:
type: string
operationId: getGroups
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)