This endpoint is specifically designed for schools using Blackbaud CRM. Unlike the standard Contact Reports API, BBCRM Interactions combines Contact Reports and Tasks into a single unified "Interactions" data model that mirrors BBCRM's structure.
Use this endpoint when:
Use the Contact Reports API when:
When creating or updating interactions with a linked task, the linked_task.state value is mapped to internal GiveCampus task states:
| BBCRM State (Input) | GiveCampus Task State |
|---|---|
| canceled, cancelled | dismissed |
| completed | completed |
| declined | dismissed |
| dismissed | dismissed |
| pending | upcoming |
| planned | upcoming |
| postponed | postponed |
| upcoming | upcoming |
Notes:
linked_task.state is "completed" AND no solicitation_plan.external_id is provided, no task is createdlinked_task.state is "completed" WITH a solicitation_plan.external_id, a task IS created in completed stateAll requests require a bearer token via the Authorization header, generated by a school administrator in the GiveCampus UI.
All API responses are delivered over HTTPS and require TLS 1.2 or 1.3.
The API delivers data asynchronously using a request-and-poll pattern:
request_id and a status of in_progress./results/{request_id} every 2–5 seconds until status changes to completed (or error).download_url containing a JSON array of objects matching the model defined below.Most requests complete within a few seconds.
Use the "Try it out" button to test and inspect API behavior before integrating.
GiveCampus Proprietary and Confidential
basePath: "/api" securityDefinitions: Bearer: type: apiKey name: Authorization in: header description: Enter the token with the `Bearer ` prefix, e.g. "Bearer XXXXXXXXXXXXX". paths: "/bbcrm_interactions/search": post: tags: - BBCRM Interactions summary: Search BBCRM interactions description: 'Search for BBCRM interactions based on various criteria. Returns a list of matching interactions, including standalone tasks (tasks without linked interactions). ' operationId: searchBbcrmInteractions consumes: - application/json produces: - application/json parameters: - in: body name: search_request required: true schema: type: object "$ref": "#/definitions/SearchBbcrmInteraction" security: - Bearer: [] responses: '200': description: Submitted successfully. Returns a request ID. schema: "$ref": "#/definitions/ApiRequest" '400': description: Invalid request. Check required fields. "/bbcrm_interactions": post: tags: - BBCRM Interactions summary: Create BBCRM interactions description: Submit one or more BBCRM interactions. Each interaction must include required fields and can optionally include linked task or custom field information. The external_id must be unique - submitting an existing external_id will result in a "record_already_exists" error. operationId: createBbcrmInteractions consumes: - application/json produces: - application/json parameters: - in: body name: bbcrm_interactions required: true schema: type: array items: "$ref": "#/definitions/CreateBbcrmInteraction" security: - Bearer: [] responses: '200': description: Submitted successfully. Returns a request ID. schema: "$ref": "#/definitions/ApiRequest" '400': description: Invalid request. Check required fields. put: tags: - BBCRM Interactions summary: Update BBCRM interactions description: Update one or more existing BBCRM interactions. Each interaction must include required fields and reference an existing external_id. If the external_id does not exist, a "record_not_found" error will be returned. operationId: updateBbcrmInteractions consumes: - application/json produces: - application/json parameters: - in: body name: bbcrm_interactions required: true schema: type: array items: "$ref": "#/definitions/UpdateBbcrmInteraction" security: - Bearer: [] responses: '200': description: Submitted successfully. Returns a request ID. schema: "$ref": "#/definitions/ApiRequest" '400': description: Invalid request. Check required fields. "/results/{request_id}": get: tags: - Results summary: Get processing results description: Returns status and download URL once the submitted BBCRM interactions have been processed. operationId: getBbcrmInteractionResults produces: - application/json parameters: - in: path name: request_id type: string required: true description: Request ID returned from submission security: - Bearer: [] responses: '200': description: Status and download URL schema: "$ref": "#/definitions/ApiResults" '202': description: returns a status for your request schema: "$ref": "../shared/types/in_progress_api_results.yaml" '400': description: Invalid request definitions: SearchBbcrmInteraction: type: object properties: ids: type: array items: type: string description: Filter by BBCRM Interaction external IDs example: - INT-001 - INT-002 constituent_external_ids: type: array items: type: string description: Filter by constituent (person) external IDs example: - CONST-001 - CONST-002 gift_officer_external_ids: type: array items: type: string description: Filter by gift officer external IDs example: - GO-001 - GO-002 date_of_interaction: type: integer description: Filter by interactions on or after this date (Unix timestamp in seconds) example: 1704067200 created_at: type: integer description: Filter by interactions created on or after this date (Unix timestamp in seconds) example: 1704067200 last_updated_at: type: integer description: Filter by interactions last updated on or after this date (Unix timestamp in seconds) example: 1704067200 CreateBbcrmInteraction: type: object required: - external_id - date_of_interaction - gift_officer_contact_method - primary_person_external_id - primary_gift_officer properties: external_id: type: string description: Unique identifier for the interaction in BBCRM example: INT-2024-001 title: type: string description: Title of the interaction example: Phone call with donor content: type: string description: Detailed notes or content of the interaction example: Discussed upcoming campaign and potential major gift date_of_interaction: type: integer description: Date of the interaction (Unix timestamp in seconds) example: 1704067200 is_significant: type: boolean description: Whether this is a significant interaction example: true primary_person_external_id: type: string description: External ID of the primary constituent example: CONST-001 participant_people_external_ids: type: array items: type: string description: External IDs of additional participants example: - CONST-002 - CONST-003 gift_officer_contact_method: type: string description: Must match the name of one of the configured contact methods in GiveCampus example: Phone primary_gift_officer: type: object required: - external_id properties: external_id: type: string description: External ID of the primary gift officer example: GO-001 email: type: string description: Email of the gift officer (alternative lookup) example: giftofficer@school.edu team: type: string description: Gift officer role/team name example: Major Gifts secondary_gift_officers: type: array items: type: object properties: external_id: type: string example: GO-002 email: type: string example: assistant@school.edu team: type: string example: Annual Fund solicitation_plan: type: object description: Link this interaction to a solicitation plan properties: external_id: type: string description: External ID of the solicitation plan example: PLAN-001 linked_task: type: object description: Task information linked to this interaction. See STATE Mappings in the description for supported state values. properties: stage: type: string description: Gift officer stage name for the task example: Cultivation state: type: string description: 'Task state. Supported values: canceled, cancelled, completed, declined, dismissed, pending, planned, postponed, upcoming' example: pending custom_field_boolean_values: type: array items: type: object properties: custom_field_label: type: string example: Interested in volunteering value: type: boolean example: true custom_field_date_values: type: array items: type: object properties: custom_field_label: type: string example: Follow-up date value: type: integer example: 1735689600 description: Unix timestamp in seconds custom_field_float_values: type: array items: type: object properties: custom_field_label: type: string example: Estimated donation amount value: type: number format: float example: 100.5 custom_field_selected_list_values: type: array items: type: object properties: custom_field_label: type: string example: Preferred contact method value: type: string example: Email custom_field_string_values: type: array items: type: object properties: custom_field_label: type: string example: Notes value: type: string example: Discussed upcoming events and fundraising goals UpdateBbcrmInteraction: type: object required: - external_id - date_of_interaction - gift_officer_contact_method - primary_person_external_id - primary_gift_officer properties: external_id: type: string description: Must match an existing BBCRM interaction's external ID example: INT-2024-001 title: type: string description: Title of the interaction example: Phone call with donor content: type: string description: Detailed notes or content of the interaction example: Discussed upcoming campaign and potential major gift date_of_interaction: type: integer description: Date of the interaction (Unix timestamp in seconds) example: 1704067200 is_significant: type: boolean description: Whether this is a significant interaction example: true primary_person_external_id: type: string description: External ID of the primary constituent example: CONST-001 participant_people_external_ids: type: array items: type: string description: External IDs of additional participants example: - CONST-002 - CONST-003 gift_officer_contact_method: type: string description: Must match the name of one of the configured contact methods in GiveCampus example: Phone primary_gift_officer: type: object required: - external_id properties: external_id: type: string description: External ID of the primary gift officer example: GO-001 email: type: string description: Email of the gift officer (alternative lookup) example: giftofficer@school.edu team: type: string description: Gift officer role/team name example: Major Gifts secondary_gift_officers: type: array items: type: object properties: external_id: type: string example: GO-002 email: type: string example: assistant@school.edu team: type: string example: Annual Fund solicitation_plan: type: object description: Link this interaction to a solicitation plan properties: external_id: type: string description: External ID of the solicitation plan example: PLAN-001 linked_task: type: object description: Task information linked to this interaction. See STATE Mappings in the description for supported state values. properties: stage: type: string description: Gift officer stage name for the task example: Cultivation state: type: string description: 'Task state. Supported values: canceled, cancelled, completed, declined, dismissed, pending, planned, postponed, upcoming' example: pending custom_field_boolean_values: type: array items: type: object properties: custom_field_label: type: string example: Interested in volunteering value: type: boolean example: true custom_field_date_values: type: array items: type: object properties: custom_field_label: type: string example: Follow-up date value: type: integer example: 1735689600 description: Unix timestamp in seconds custom_field_float_values: type: array items: type: object properties: custom_field_label: type: string example: Estimated donation amount value: type: number format: float example: 100.5 custom_field_selected_list_values: type: array items: type: object properties: custom_field_label: type: string example: Preferred contact method value: type: string example: Email custom_field_string_values: type: array items: type: object properties: custom_field_label: type: string example: Notes value: type: string example: Discussed upcoming events and fundraising goals BbcrmInteraction: type: object description: Response object returned when retrieving BBCRM interactions via search results download properties: id: type: integer external_id: type: string title: type: string is_significant: type: string description: '"Yes", "No", or null (for standalone tasks)' content: type: string date_of_interaction: type: integer description: Unix timestamp in seconds. Null for standalone tasks. primary_person: type: object properties: id: type: integer constituent_id: type: string participant_people: type: array items: type: object properties: id: type: integer constituent_id: type: string primary_gift_officer: type: object properties: solicitor_type: type: string solicitor_id: type: string team: type: string secondary_gift_officers: type: array items: type: object properties: solicitor_type: type: string solicitor_id: type: string team: type: string contact_method: type: object properties: name: type: string selectable: type: string description: '"Yes" or "No"' created_at: type: integer description: Unix timestamp in seconds updated_at: type: integer description: Unix timestamp in seconds custom_fields: type: array items: type: object properties: name: type: string type: type: string value: type: string creation_source: type: string solicitation_plan: type: object properties: id: type: integer external_id: type: string linked_task: type: object properties: stage: type: string state: type: string due_date: type: integer description: Unix timestamp in seconds original_due_date: type: integer description: Unix timestamp in seconds finished_at: type: integer description: Unix timestamp in seconds task_type: type: string cadence: type: object properties: name: type: string step_name: type: string step_type: type: string trip: type: object properties: title: type: string visit_title: type: string created_at: type: integer description: Unix timestamp in seconds updated_at: type: integer description: Unix timestamp in seconds ApiRequest: type: object properties: request_id: type: string example: abc123 state: type: string example: processing ApiResults: type: object properties: request_id: type: string state: type: string enum: - pending - processing - completed - failed download_url: type: string example: https://givecampus.com/api/downloads/request_id.csv