{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/blackbaud/main/json-schema/blackbaud-action-read-schema.json",
"title": "ActionRead",
"description": "Actions track the interactions and tasks that are required to secure gifts and cultivate relationships with constituents.",
"x-generated": "2026-10-14",
"x-method": "derived",
"x-generator": "derive-json-schema.py",
"x-source": "openapi/blackbaud-constituent-api-openapi.yml#/components/schemas/ActionRead",
"type": "object",
"properties": {
"id": {
"description": "The immutable system record ID of the action.",
"type": "string"
},
"category": {
"description": "The channel or intent of the constituent interaction. Available values are Phone Call, Meeting, Mailing, Email, and Task/Other.",
"type": "string"
},
"completed": {
"description": "Indicates whether the action is complete. If the system is configured to use custom action statuses, this value is based on the action status value. This property defaults to false if no value is provided.",
"type": "boolean"
},
"completed_date": {
"format": "date-time",
"description": "The date when the action was completed. Uses ISO-8601 format: 1969-11-21T10:29:43.",
"type": "string",
"x-supports-datetime-offset": false
},
"computed_status": {
"description": "The computed action status. If the system is not configured to use custom action statuses, this field computes the status based on the completed and date properties. If not, the field calculates the status based on the action's date property and whether action's Action Status property is configured as completed.",
"enum": [
"Open",
"Completed",
"PastDue"
],
"type": "string"
},
"constituent_id": {
"description": "The immutable system record ID of the constituent associated with the action.",
"type": "string"
},
"date": {
"format": "date-time",
"description": "The action date. Uses ISO-8601 format: 1969-11-21T10:29:43.",
"type": "string",
"x-supports-datetime-offset": false
},
"date_added": {
"format": "date-time",
"description": "The date when the action was created. Includes an offset from UTC in ISO-8601 format: 1969-11-21T10:29:43-04:00.",
"type": "string",
"x-supports-datetime-offset": true
},
"date_modified": {
"format": "date-time",
"description": "The date when the action was last modified. Includes an offset from UTC in ISO-8601 format: 1969-11-21T10:29:43-04:00.",
"type": "string",
"x-supports-datetime-offset": true
},
"description": {
"description": "The detailed explanation that elaborates on the action summary.",
"type": "string"
},
"direction": {
"description": "The direction of the action. Available values are Inbound and Outbound.",
"enum": [
"Inbound",
"Outbound"
],
"type": "string"
},
"end_time": {
"description": "The end time of the action. Uses 24-hour time in the HH:mm format. For example, 17:30 represents 5:30 p.m.",
"type": "string"
},
"fundraisers": {
"description": "The set of immutable constituent system record IDs for the fundraisers associated with the action.",
"type": "array",
"items": {
"type": "string"
}
},
"location": {
"description": "The location of the action. Available values are the entries in the Action Locations table.",
"type": "string"
},
"opportunity_id": {
"description": "The immutable system record ID of the opportunity associated with the action.",
"type": "string"
},
"outcome": {
"description": "The outcome of the action. Available values are Successful and Unsuccessful.",
"enum": [
"Successful",
"Unsuccessful"
],
"type": "string"
},
"priority": {
"description": "The priority of the action. Available values are Normal, High, and Low. The default is Normal.",
"enum": [
"Normal",
"High",
"Low"
],
"type": "string"
},
"start_time": {
"description": "The start time of the action. Uses 24-hour time in the HH:mm format. For example, 17:30 represents 5:30 p.m.",
"type": "string"
},
"status": {
"description": "The action status. If the system is configured to use custom action statuses, available values are the entries in the Action Status table. If not, this field computes the status based on the completed and date properties: If an action is not completed and has a current or future date, the status is Open; if an action is not completed and has a past date, the status is Past due; and if an action is completed, the status is Completed.",
"type": "string"
},
"status_code": {
"description": "The action status code. Available values are in the Action Status table. This property is only returned when the system is configured to use custom action statuses.",
"type": "string"
},
"summary": {
"description": "The short description of the action that appears at the top of the record.",
"type": "string"
},
"type": {
"description": "Additional description of the action to complement the category. Available values are the entries in the Actions table.",
"type": "string"
},
"campaign_id": {
"description": "The immutable system record ID of the campaign associated with the action. For a list of valid campaigns, see the Fundraising (Campaign) API.",
"type": "string"
},
"fund_id": {
"description": "The immutable system record ID of the fund associated with the action. For a list of valid funds, see the Fundraising (Fund) API.",
"type": "string"
},
"appeal_id": {
"description": "The immutable system record ID of the appeal associated with the action. For a list of valid appeals, see the Fundraising (Appeal) API.",
"type": "string"
},
"issue": {
"description": "The issue associated with the action. Available values are the entries in the Action Issues code table.",
"type": "string"
},
"letter_code": {
"description": "The letter code associated with the action. Available values are the entries in the Action Letter Codes code table.",
"type": "string"
}
},
"x-display-name": "Action",
"x-display-id": "Action"
}