Blackbaud integration: operations for AI agents
Blackbaud connects to Type.com as an integration. This page lists the 2014 operations documented for Claude and Codex in Type.com: 1128 read, 674 write, 212 destructive.
About Blackbaud
Blackbaud offers cloud-based software for nonprofits, schools, and healthcare institutions, supporting fundraising, financial management, and donor engagement in mission-driven organizations
Categories: Sales & CRM, Commerce & Payments
How to connect Blackbaud to Type.com
- Access
- Organization connection: one shared account for the workspace.
- MCP
- Selected payment-processing operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.
To add the connection, follow the steps in Space connections.
Documented operations
2014 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
2014 operations listed.
Constituent
- Read
Action (Get)
Returns information about an action.
GET /constituent/v1/actions/{action_id} - Read
Action attachment list (Single action)
Returns a list of attachments for an action.
GET /constituent/v1/actions/{action_id}/attachments - Read
Action custom field categories
Returns a list of custom field categories. This endpoint is deprecated. For more detailed custom field category information, use the Custom field category details endpoint instead.
GET /constituent/v1/actions/customfields/categories - Read
Action custom field category details
Returns a list of custom field category details.
GET /constituent/v1/actions/customfields/categories/details - Read
Action custom field category values
Returns a list of custom field values for code table categories.
GET /constituent/v1/actions/customfields/categories/values - Read
Action custom field list (Single action)
Returns a list of custom fields for an action.
GET /constituent/v1/actions/{action_id}/customfields - Read
Action list (All constituents)
Returns a paginated list of actions. The default sorting behavior is to list actions in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list actions in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that actions are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list actions based on when they were last modified.
GET /constituent/v1/actions - Read
Action list (Single constituent)
Returns a list of actions for a constituent sorted by action date in descending order.
GET /constituent/v1/constituents/{constituent_id}/actions - Read
Action locations
Returns a list of active action locations.
GET /constituent/v1/actionlocations - Read
Action note (Get)
Returns information about an action note.
GET /constituent/v1/actions/notes/{note_id} - Read
Action note list (Single action)
Returns a list of notes for an action.
GET /constituent/v1/actions/{action_id}/notes - Read
Action status types
Returns a list of active action status types.
GET /constituent/v1/actionstatustypes - Read
Action types
Returns a list of active action types.
GET /constituent/v1/actiontypes - Read
Address
Returns a constituent address.
GET /constituent/v1/constituents/addresses/{address_id} - Read
Address list (All constituents)
Returns a paginated list of addresses. The default sorting behavior is to list addresses in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list addresses in ascending order based on when they were last modified. The last_modified and date_added parameters also add the sort_token parameter to the next_link URL to ensure that addresses are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list addresses based on when they were last modified. Note: This endpoint returns data with an average latency of about 30 minutes.
GET /constituent/v1/addresses - Read
Address list (Single constituent)
Returns a list of addresses for a constituent.
GET /constituent/v1/constituents/{constituent_id}/addresses - Read
Address types
Returns a list of active address types.
GET /constituent/v1/addresstypes - Read
Alias list (Single constituent)
Returns a list of aliases for a constituent.
GET /constituent/v1/constituents/{constituent_id}/aliases - Read
Alias types
Returns a list of active alias types.
GET /constituent/v1/aliastypes - Read
Attachment tags
Returns a list of available attachment tags.
GET /constituent/v1/attachmenttags - Read
Communication preference list (Single constituent)
Returns a list of communication preferences for a constituent. This endpoint will be deprecated in a future version of the Constituent API. Please reference the equivalent endpoint, Constituent solicit code list (Single constituent) , in the Communication Preference API instead.
GET /constituent/v1/constituents/{constituent_id}/communicationpreferences - Read
Communication preferences
Returns a list of available communication preference types. This endpoint will be deprecated in a future version of the Constituent API. Please reference the equivalent endpoint, Solicit codes (Get) , in the Communication Preference API instead.
GET /constituent/v1/communicationpreferences - Read
Constituent (Duplicate search)
Returns possible duplicate records. Searches individual, organization, and related contact records and ranks results based on search filters. Records that match multiple filters rank higher as potential duplicates.
GET /constituent/v1/constituents/duplicatesearch?last_org_name={last_org_name} - Read
Constituent (Get)
Returns information about a constituent.
GET /constituent/v1/constituents/{constituent_id} - Read
Constituent (Search)
Performs a constituent search based on the provided search text. Supports first name, last name, preferred name, former name, alias, email address, phone number, address, or lookup ID. Name combinations, such as first name and last name or preferred name and last name, are valid, but otherwise search only supports one parameter at a time. By default, searches include results that sound similar to your criteria. For example, searches for "Smith" include matches for "Smyth" and other alternative spellings. Searching by phone number requires a minimum of 7 digits with no spaces or special characters. This search does not support wildcard characters — such as * or ? — used to search in the database view. If searching on a lookup id, the search_field property should be set to 'lookup_id'. This will allow the search results to be returned quicker. If searching on an email address, the search_field property should be set to 'email_address'. This will allow the search results to be returned quicker. By default, the results include non-constituents. Search results are limited to 500 records.
GET /constituent/v1/constituents/search?search_text={search_text} - Read
Constituent appeal list (Single constituent)
Returns a list of appeals for a constituent.
GET /constituent/v1/constituents/{constituent_id}/appeals - Read
Constituent attachment list (Single constituent)
Returns a list of attachments for a constituent.
GET /constituent/v1/constituents/{constituent_id}/attachments - Read
Constituent code (Get)
Returns a constituent code.
GET /constituent/v1/constituents/constituentcodes/{constituent_code_id} - Read
Constituent code list (All constituents)
Returns a paginated list of constituent codes. The default sorting behavior is to list constituent codes in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list constituent codes in ascending order based on when they were last modified. The last_modified and date_added parameters also add the sort_token parameter to the next_link URL to ensure that constituent codes are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list constituent codes based on when they were last modified. Note: This endpoint returns data with an average latency of about 30 minutes. In addition, historic records have a default date_added timestamp of 1600-01-01 00:00:00.000 +00:00. The timestamp for newer records reflects when the records were added.
GET /constituent/v1/constituents/constituentcodes - Read
Constituent code list (Single constituent)
Returns a list of constituent codes for a constituent.
GET /constituent/v1/constituents/{constituent_id}/constituentcodes - Read
Constituent code types
Returns a list of all constituent code types.
GET /constituent/v1/constituentcodetypes - Read
Constituent custom field categories
Returns a list of custom field categories. This endpoint is deprecated. For more detailed custom field category information, use the Custom field category details endpoint instead.
GET /constituent/v1/constituents/customfields/categories - Read
Constituent custom field category details
Returns a list of custom field category details.
GET /constituent/v1/constituents/customfields/categories/details - Read
Constituent custom field category values
Returns a list of custom field category values.
GET /constituent/v1/constituents/customfields/categories/values - Read
Constituent custom field list (All constituents)
Returns a paginated list of constituent custom fields. The default sorting behavior is to list constituent custom fields in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list constituent custom fields in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that constituent custom fields are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list constituent custom fields based on when they were last modified. Note: This endpoint returns data with an average latency of about 30 minutes. In addition, historic records have a default date_added timestamp of 1600-01-01 00:00:00.000 +00:00. The timestamp for newer records reflects when the records were added.
GET /constituent/v1/constituents/customfields - Read
Constituent custom field list (Single constituent)
Returns a list of custom fields for a constituent.
GET /constituent/v1/constituents/{constituent_id}/customfields - Read
Constituent list
Returns a paginated list of constituents. The default sorting behavior is to list constituents in ascending alphabetical order based on the full name of organizations and the last name of individuals. However, some parameters override the default sorting behavior. The sort parameter sorts based on the fields that it specifies, and the sort_token parameter sorts based on the next stable-sorted list of results. (These parameters cannot be provided together.) If the sort and sort_token parameters are not provided, then the last_modified parameter sorts constituents in ascending order based on when they were last modified and the date_added parameter sorts constituents in ascending order based on when they were created. (If the last_modified and date_added parameters are both specified, sorting is based on the last-modified date.) Some parameters also add the sort_token parameter to the next_link URL to ensure that constituents are stably sorted and that the order persists even if changes occur while working through a paginated list. The last_modified , date_added , and sort parameters all add the sort_token parameter to the next_link URL, although the sort parameter only adds the sort_token parameter when it sorts by just the date_added field or just the date_modified field. Note: This endpoint returns data with an average latency of about 30 minutes.
GET /constituent/v1/constituents - Read
Countries
Returns the list of available countries.
GET /constituent/v1/countries - Read
Currency configuration (Get)
Returns the currency configuration settings for the tenant's default country.
GET /constituent/v1/currencyconfiguration - Read
Education (Get)
Returns an education record.
GET /constituent/v1/constituents/educations/{education_id} - Read
Education custom field category details
Returns a list of education custom field category details.
GET /constituent/v1/educations/customfields/categories/details - Read
Education custom field code table category values
Returns a list of values for the specified code table category.
GET /constituent/v1/educations/customfields/categories/values - Read
Education custom field list (Single education)
Returns a list of custom fields on an education record.
GET /constituent/v1/educations/{education_id}/customfields - Read
Education degree classes
Returns a list of available degree classes. This endpoint only applies to databases that are formatted for the UK.
GET /constituent/v1/educations/degreeclasses - Read
Education degrees
Returns a list of available degrees.
GET /constituent/v1/educations/degrees - Read
Education departments
Returns a list of available departments. This endpoint only applies to databases that are formatted for the UK.
GET /constituent/v1/educations/departments - Read
Education faculties
Returns a list of available facilities. This endpoint only applies to databases that are formatted for the UK.
GET /constituent/v1/educations/faculties - Read
Education list (All constituents)
Returns a paginated list of education items. The default sorting behavior is to list education items in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list education items in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that education items are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list education items based on when they were last modified. Note: This endpoint returns data with an average latency of about 30 minutes. In addition, historic records have a default date_added timestamp of 1600-01-01 00:00:00.000 +00:00. The timestamp for newer records reflects when the records were added.
GET /constituent/v1/educations - Read
Education list (Single constituent)
Returns a list of education items for a constituent.
GET /constituent/v1/constituents/{constituent_id}/educations - Read
Education schools
Returns a list of available schools.
GET /constituent/v1/educations/schools - Read
Education statuses
Returns a list of available education statuses.
GET /constituent/v1/educations/statuses - Read
Education subjects
Returns a list of available subjects.
GET /constituent/v1/educations/subjects - Read
Education types
Returns a list of available school types.
GET /constituent/v1/educations/types - Read
Email address list (All constituents)
Returns a paginated list of email addresses. The default sorting behavior is to list email addresses in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list email addresses in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that email addresses are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list email addresses based on when they were last modified. Note: This endpoint returns data with an average latency of about 30 minutes. In addition, historic records have a default date_added timestamp of 1600-01-01 00:00:00.000 +00:00. The timestamp for newer records reflects when the records were added.
GET /constituent/v1/emailaddresses - Read
Email address list (Single constituent)
Returns a list of email addresses for the constituent with the specified ID.
GET /constituent/v1/constituents/{constituent_id}/emailaddresses - Read
Email address types
Returns a list of active email address types.
GET /constituent/v1/emailaddresstypes - Read
First gift (Get)
Returns the first gift recorded for a constituent.
GET /constituent/v1/constituents/{constituent_id}/givingsummary/first - Read
Fundraiser assignment list (Single constituent)
Returns a list of fundraiser assignments for a constituent.
GET /constituent/v1/constituents/{constituent_id}/fundraiserassignments - Read
Fundraiser list (Single constituent)
Returns a list of fundraisers for a constituent. This endpoint is deprecated. Use the new Fundraiser assignment list (Single constituent) endpoint instead.
GET /constituent/v1/constituents/{constituent_id}/fundraisers - Read
Genders
Returns a list of available constituent genders.
GET /constituent/v1/genders - Read
Greatest gift (Get)
Returns the greatest gift recorded for a constituent.
GET /constituent/v1/constituents/{constituent_id}/givingsummary/greatest - Read
Latest gift (Get)
Returns the latest gift recorded for a constituent.
GET /constituent/v1/constituents/{constituent_id}/givingsummary/latest - Read
Lifetime giving (Get)
Returns the lifetime giving information for a constituent.
GET /constituent/v1/constituents/{constituent_id}/givingsummary/lifetimegiving - Read
Marital statuses
Returns a list of available constituent marital status types.
GET /constituent/v1/maritalstatuses - Read
Membership list (All constituents)
Returns a paginated list of memberships. The default sorting behavior is to list memberships in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list memberships in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that memberships are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list memberships based on when they were last modified.
GET /constituent/v1/memberships - Read
Membership list (Single constituent)
Returns a list of memberships for a constituent.
GET /constituent/v1/constituents/{constituent_id}/memberships - Read
Name format (Get)
Returns the name format.
GET /constituent/v1/constituents/nameformats/{name_format_id} - Read
Name format configuration list
Returns a list of all available name format configurations.
GET /constituent/v1/nameformatconfigurations - Read
Name format summary (Get)
Returns the name format summary for a constituent.
GET /constituent/v1/constituents/{constituent_id}/nameformats/summary - Read
Name format types
Returns a list of active name format types.
GET /constituent/v1/nameformattypes - Read
Note (Get)
Returns information about a note.
GET /constituent/v1/notes/{note_id} - Read
Note list (All constituents)
Returns a paginated list of notes, excluding RE NXT Summary notes. The default sorting behavior is to list notes in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list notes in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that notes are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list notes based on when they were last modified.
GET /constituent/v1/notes - Read
Note list (Single constituent)
Returns a list of notes for a constituent, excluding RE NXT Summary notes.
GET /constituent/v1/constituents/{constituent_id}/notes - Read
Note types
Returns a list of active note types.
GET /constituent/v1/notetypes - Read
Online presence list (All constituents)
Returns a paginated list of online presences. The default sorting behavior is to list online presences in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list online presences in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that online presences are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list online presences based on when they were last modified. Note: This endpoint returns data with an average latency of about 30 minutes. In addition, historic records have a default date_added timestamp of 1600-01-01 00:00:00.000 +00:00. The timestamp for newer records reflects when the records were added.
GET /constituent/v1/onlinepresences - Read
Online presence list (Single constituent)
Returns a list of online presences for a constituent.
GET /constituent/v1/constituents/{constituent_id}/onlinepresences - Read
Online presence types
Returns a list of active online presence types.
GET /constituent/v1/onlinepresencetypes - Read
Organization contact types
Returns a list of organization contact types.
GET /constituent/v1/organizationcontacttypes - Read
Organization matching gift setup (Get)
Returns the matching gift setup for an organization constituent.
GET /constituent/v1/constituents/{constituent_id}/matchinggift - Read
Phone (Get)
Returns a single phone.
GET /constituent/v1/constituents/phones/{phone_id} - Read
Phone list (All constituents)
Returns a paginated list of phones. The default sorting behavior is to list phones in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list phones in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that phones are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list phones based on when they were last modified. Note: This endpoint returns data with an average latency of about 30 minutes. In addition, historic records have a default date_added timestamp of 1600-01-01 00:00:00.000 +00:00. The timestamp for newer records reflects when the records were added.
GET /constituent/v1/phones - Read
Phone list (Single constituent)
Returns a list of phones for a constituent.
GET /constituent/v1/constituents/{constituent_id}/phones - Read
Phone types
Returns a list of active phone types.
GET /constituent/v1/phonetypes - Read
Profile picture (Get)
Returns the current profile picture for a constituent.
GET /constituent/v1/constituents/{constituent_id}/profilepicture - Read
Prospect status (Get)
Returns the current prospect status of a constituent.
GET /constituent/v1/constituents/{constituent_id}/prospectstatus - Read
Prospect status history (Get)
Returns a constituent's prospect status history.
GET /constituent/v1/constituents/{constituent_id}/prospectstatushistories - Read
Rating categories
Returns a list of all available rating categories.
GET /constituent/v1/ratings/categories - Read
Rating category values
Returns a list of rating values for code table categories.
GET /constituent/v1/ratings/categories/values - Read
Rating list (Single constituent)
Returns a list of ratings for a constituent.
GET /constituent/v1/constituents/{constituent_id}/ratings - Read
Rating sources
Returns a list of all available rating sources.
GET /constituent/v1/ratings/sources - Read
Relationship (Get)
Returns a relationship.
GET /constituent/v1/constituents/relationships/{relationship_id} - Read
Relationship list (All constituents)
Returns a paginated list of relationships. The default sorting behavior is to list relationships in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list relationships in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that relationships are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list relationships based on when they were last modified.
GET /constituent/v1/relationships - Read
Relationship list (Single constituent)
Returns a list of relationships for a constituent. If no limit parameter is provided, the endpoint returns 500 relationships by default.
GET /constituent/v1/constituents/{constituent_id}/relationships - Read
Relationship matching gift plan (Get)
Returns the matching gift plan carried by a constituent relationship.
GET /constituent/v1/constituents/relationships/{relationship_id}/matchinggift - Read
Relationship types
Returns a list of relationship types.
GET /constituent/v1/relationshiptypes - Read
Suffixes
Returns a list of available constituent suffix types.
GET /constituent/v1/suffixes - Read
Titles
Returns a list of available constituent title types.
GET /constituent/v1/titles - Write
Action (Create)
Creates a constituent action.
POST /constituent/v1/actions - Write
Action (Edit)
Edits a constituent action.
PATCH /constituent/v1/actions/{action_id} - Write
Action attachment (Create)
Creates an action attachment.
POST /constituent/v1/actions/attachments - Write
Action attachment (Edit)
Edits an action attachment.
PATCH /constituent/v1/actions/attachments/{attachment_id} - Write
Action custom field (Create)
Creates an action custom field.
POST /constituent/v1/actions/customfields - Write
Action custom field (Edit)
Edits an action custom field.
PATCH /constituent/v1/actions/customfields/{custom_field_id} - Write
Action note (Create)
Creates an action note.
POST /constituent/v1/actions/notes - Write
Action note (Edit)
Edits an action note.
PATCH /constituent/v1/actions/notes/{note_id} - Write
Address (Create)
Creates a constituent address.
POST /constituent/v1/addresses - Write
Address (Edit)
Edits a constituent address.
PATCH /constituent/v1/addresses/{address_id} - Write
Alias (Create)
Creates an alias.
POST /constituent/v1/aliases - Write
Alias (Edit)
Edits an alias for a constituent.
PATCH /constituent/v1/aliases/{alias_id} - Write
Alias collection (Create)
Creates aliases.
POST /constituent/v1/constituents/{constituent_id}/aliascollection - Write
Communication preference (Create)
Creates a constituent communication preference. This endpoint will be deprecated in a future version of the Constituent API. Please reference the equivalent endpoint, Constituent solicit code (Post) , in the Communication Preference API instead.
POST /constituent/v1/communicationpreferences - Write
Communication preference (Edit)
Edits a constituent communication preference. This endpoint will be deprecated in a future version of the Constituent API. Please reference the equivalent endpoint, Constituent solicit code (Patch) , in the Communication Preference API instead.
PATCH /constituent/v1/communicationpreferences/{communication_preference_id} - Write
Constituent (Convert)
Converts a non-constituent to a constituent.
POST /constituent/v1/constituents/convert/{non_constituent_id} - Write
Constituent (Create)
Creates a constituent.
POST /constituent/v1/constituents - Write
Constituent (Edit)
Edits a constituent.
PATCH /constituent/v1/constituents/{constituent_id} - Write
Constituent attachment (Create)
Creates a constituent attachment.
POST /constituent/v1/constituents/attachments - Write
Constituent attachment (Edit)
Edits a constituent attachment.
PATCH /constituent/v1/constituents/attachments/{attachment_id} - Write
Constituent code (Create)
Creates a constituent code for a constituent.
POST /constituent/v1/constituentcodes - Write
Constituent code (Edit)
Edits a constituent code.
PATCH /constituent/v1/constituentcodes/{constituent_code_id} - Write
Constituent custom field (Create)
Creates a constituent custom field.
POST /constituent/v1/constituents/customfields - Write
Constituent custom field (Edit)
Edits a constituent custom field.
PATCH /constituent/v1/constituents/customfields/{custom_field_id} - Write
Constituent custom field collection (Create)
Creates a collection of constituent custom fields.
POST /constituent/v1/constituents/{constituent_id}/customfieldcollection - Write
Document (Create)
Creates a document upload location and unique document identifier for physical attachments. Maximum file size is 100MB.
POST /constituent/v1/documents - Write
Education (Create)
Creates a constituent education.
POST /constituent/v1/educations - Write
Education (Edit)
Edits a constituent education.
PATCH /constituent/v1/educations/{education_id} - Write
Education custom field (Create)
Creates an education custom field.
POST /constituent/v1/educations/customfields - Write
Education custom field (Edit)
Edits an education custom field.
PATCH /constituent/v1/educations/customfields/{custom_field_id} - Write
Email address (Create)
Creates a constituent email address.
POST /constituent/v1/emailaddresses - Write
Email address (Edit)
Edits a constituent email address.
PATCH /constituent/v1/emailaddresses/{email_address_id} - Write
Name format (Create)
Creates a name format.
POST /constituent/v1/nameformats - Write
Name format (Edit)
Edits a name format for a constituent.
PATCH /constituent/v1/nameformats/{name_format_id} - Write
Note (Create)
Creates a constituent note.
POST /constituent/v1/notes - Write
Note (Edit)
Edits a constituent note.
PATCH /constituent/v1/notes/{note_id} - Write
Online presence (Create)
Creates a constituent online presence.
POST /constituent/v1/onlinepresences - Write
Online presence (Edit)
Edits a constituent online presence.
PATCH /constituent/v1/onlinepresences/{online_presence_id} - Write
Organization matching gift setup (Edit)
Edits the matching gift setup for an organization constituent. Omitted fields keep their stored value; an explicit null clears the field. The 'organization_matches_gifts' field is the one exception: it is a plain boolean toggle with no cleared state, so an explicit null for it is rejected as a bad request.
PATCH /constituent/v1/constituents/{constituent_id}/matchinggift - Write
Phone (Create)
Creates a constituent phone.
POST /constituent/v1/phones - Write
Phone (Edit)
Edits a constituent phone.
PATCH /constituent/v1/phones/{phone_id} - Write
Phone Collection (Create)
Creates a collection of constituent phones.
POST /constituent/v1/phonescollection - Write
Primary name format (Create)
Creates a primary name format.
POST /constituent/v1/primarynameformats - Write
Primary name format (Edit)
Edits a primary name format for a constituent.
PATCH /constituent/v1/primarynameformats/{primary_name_format_id} - Write
Profile picture
Updates the current profile picture for a constituent.
PATCH /constituent/v1/constituents/{constituent_id}/profilepicture - Write
Rating (Create)
Creates a constituent rating.
POST /constituent/v1/ratings - Write
Rating (Edit)
Edits a constituent rating.
PATCH /constituent/v1/ratings/{rating_id} - Write
Relationship (Create)
Creates a relationship for a constituent. If the relationship is with another constituent, a reciprocal relationship is created for that constituent. The identifier of the reciprocal relationship is in the `reciprocal_relationship_id` property.
POST /constituent/v1/relationships - Write
Relationship (Edit)
Edits a relationship for a constituent. If a reciprocal relationship exists, it is also modified to reflect the changes. This does not include changes to the `comments` property, which is specific to each record and can be modified independently on each record.
PATCH /constituent/v1/relationships/{relationship_id} - Write
Relationship matching gift plan (Edit)
Edits the matching gift plan carried by a constituent relationship. Omitted fields keep their stored value; an explicit null clears the field.
PATCH /constituent/v1/constituents/relationships/{relationship_id}/matchinggift - Destructive
Action (Delete)
Deletes a constituent action.
DELETE /constituent/v1/actions/{action_id} - Destructive
Action attachment (Delete)
Deletes an action attachment.
DELETE /constituent/v1/actions/attachments/{attachment_id} - Destructive
Action custom field (Delete)
Deletes an action custom field.
DELETE /constituent/v1/actions/customfields/{custom_field_id} - Destructive
Action note (Delete)
Deletes an action note.
DELETE /constituent/v1/actions/notes/{note_id} - Destructive
Address (Delete)
Deletes a constituent address.
DELETE /constituent/v1/addresses/{address_id} - Destructive
Alias (Delete)
Deletes an alias.
DELETE /constituent/v1/aliases/{alias_id} - Destructive
Communication preference (Delete)
Deletes a constituent communication preference. This endpoint will be deprecated in a future version of the Constituent API. Please reference the equivalent endpoint, Constituent solicit code (Delete) , in the Communication Preference API instead.
DELETE /constituent/v1/communicationpreferences/{communication_preference_id} - Destructive
Constituent (Delete)
Deletes a constituent.
DELETE /constituent/v1/constituents/{constituent_id} - Destructive
Constituent attachment (Delete)
Deletes a constituent attachment.
DELETE /constituent/v1/constituents/attachments/{attachment_id} - Destructive
Constituent code (Delete)
Deletes a constituent code.
DELETE /constituent/v1/constituentcodes/{constituent_code_id} - Destructive
Constituent custom field (Delete)
Deletes a constituent custom field.
DELETE /constituent/v1/constituents/customfields/{custom_field_id} - Destructive
Education (Delete)
Deletes a constituent education.
DELETE /constituent/v1/educations/{education_id} - Destructive
Education custom field (Delete)
Deletes an education custom field.
DELETE /constituent/v1/educations/customfields/{custom_field_id} - Destructive
Email address (Delete)
Deletes a constituent email address.
DELETE /constituent/v1/emailaddresses/{email_address_id} - Destructive
Name format (Delete)
Deletes a constituent name format.
DELETE /constituent/v1/nameformats/{name_format_id} - Destructive
Note (Delete)
Deletes a constituent note.
DELETE /constituent/v1/notes/{note_id} - Destructive
Online presence (Delete)
Deletes a constituent online presence.
DELETE /constituent/v1/onlinepresences/{online_presence_id} - Destructive
Phone (Delete)
Deletes a constituent phone.
DELETE /constituent/v1/phones/{phone_id} - Destructive
Primary name format (Delete)
Deletes a constituent primary name format.
DELETE /constituent/v1/primarynameformats/{primary_name_format_id} - Destructive
Rating (Delete)
Deletes a constituent rating.
DELETE /constituent/v1/ratings/{rating_id} - Destructive
Relationship (Delete)
Deletes a relationship from a constituent.
DELETE /constituent/v1/relationships/{relationship_id}
General Ledger
- Read
Account (Get)
Returns the specified account record.
GET /generalledger/v1/accounts/{account_id} - Read
Account (Search)
Returns a list of accounts.
GET /generalledger/v1/accounts - Read
Account cashflows (List)
Returns the list of available cashflow values
GET /generalledger/v1/accounts/cashflows - Read
Account code (List)
Returns the account codes.
GET /generalledger/v1/accounts/codes - Read
Account custom fields (List)
Returns a list of custom field options.
GET /generalledger/v1/accounts/customfields - Read
Account fund (List)
Returns the account funds.
GET /generalledger/v1/accounts/funds - Read
Account segment value
Returns the specified account segment value.
GET /generalledger/v1/accounts/segments/{segment_id} - Read
Account structure (List)
Returns a list of account structures.
GET /generalledger/v1/accounts/structure - Read
Account working capitals (List)
Returns the list of available working capital values
GET /generalledger/v1/accounts/workingcapitals - Read
Background process result (Get)
This returns the record ID as result of the registered process. Use this with the "Journal entry batch process (Create)" and "Background process status (Get)" endpoints to enhance journal entry processing.
GET /generalledger/v1/backgroundProcess/{process_id}/result - Read
Background process status (Get)
This returns the background process status of the process identifier. Use this with the "Journal entry batch process (Create)" and "Background process result (Get)" endpoints to enhance journal entry processing.
GET /generalledger/v1/backgroundProcess/{process_id}/status - Read
Budget (Get)
Returns details for every fiscal period in a budget scenario.
GET /generalledger/v1/budgets/{scenario_id} - Read
Budget (List)
Returns a top level overview of every budget scenario.
GET /generalledger/v1/budgets - Read
Budget account (List)
Returns details for every fiscal period and account in scenario.
GET /generalledger/v1/budgets/{scenario_id}/accounts - Read
Budget detail (Get)
Returns the specified budget details.
GET /generalledger/v1/budgets/{scenario_id}/details - Read
Budget detail lines (List)
Returns the specified budget lines.
GET /generalledger/v1/budgets/{scenario_id}/details/lines - Read
Budget grant (List)
Returns details for every fiscal period and grant in scenario.
GET /generalledger/v1/budgets/{scenario_id}/grants - Read
Budget project (List)
Returns details for every fiscal period and project in scenario.
GET /generalledger/v1/budgets/{scenario_id}/projects - Read
Budget scenario (List)
Returns details for every scenario ID.
GET /generalledger/v1/budgets/scenarios - Read
Cash management distribution set (Get)
Returns the cash management distribution set details.
GET /generalledger/v1/distributionsets/cashmanagement/{set_id} - Read
Cash management distribution set (List)
Returns the list of cash management distribution sets.
GET /generalledger/v1/distributionsets/cashmanagement - Read
Class (List)
The list of classes
GET /generalledger/v1/classes - Read
Client names (List)
Returns the client type names.
GET /generalledger/v1/configuration/client_names - Read
Contact suffixes (List)
Returns a list of contact suffixes for contact information in projects and vendors.
GET /generalledger/v1/configuration/contactsuffixes - Read
Contact titles (List)
Returns a list of contact titles for contact information in projects and vendors.
GET /generalledger/v1/configuration/contacttitles - Read
Contact types (List)
Returns a list of contact types for contact information in projects and vendors.
GET /generalledger/v1/configuration/contacttypes - Read
Fiscal year (List)
Returns the list of fiscal year details.
GET /generalledger/v1/fiscalyears - Read
Fund (Get)
Returns the specified fund.
GET /generalledger/v1/funds/{fund_id} - Read
General Ledger (settings)
Returns General ledger configuration including country and currency information.
GET /generalledger/v1/configuration/settings - Read
General Ledger Media Type (List)
Returns a list of media type options.
GET /generalledger/v1/mediaTypes - Read
Grant
Returns a specified grant.
GET /generalledger/v1/grants/{grant_id} - Read
Grant contacts (List)
Returns a list of contacts for a specified grant.
GET /generalledger/v1/grants/{grant_id}/contacts - Read
Grant custom field (List)
Returns the list of grant custom field options.
GET /generalledger/v1/grants/customfields - Read
Grant projects (List)
Returns a list of projects funded by a specified grant.
GET /generalledger/v1/grants/{grant_id}/projects - Read
Grant status (List)
Returns the list of grant statuses.
GET /generalledger/v1/grants/statuses - Read
Grant type (List)
Returns the list of grant types.
GET /generalledger/v1/grants/types - Read
Grants (List)
Returns the list of grant summaries.
GET /generalledger/v1/grants - Read
Journal code (List)
Returns the list of all available journal codes.
GET /generalledger/v1/journalcodes - Read
Journal entries (List)
Returns a list of journal entries for a specified journal entry batch.
GET /generalledger/v1/journalentrybatches/{batch_id}/journalentries - Read
Journal entry batch (Get)
Returns the journal entry batch details. This endpoint is deprecated and is only suitable for batches with a low volume of journal entries. For more options getting journal entry batch information use the Journal entry batch summary (Get) and Journal entries (List) endpoints instead.
GET /generalledger/v1/journalentrybatches/{batch_id} - Read
Journal entry batch (List)
Returned when the operation is successful. The response body contains a list of journal entry batch summaries. However, journal_entries values are always empty.
GET /generalledger/v1/journalentrybatches - Read
Journal entry batch (Validate)
Returns the results of batch validation.
GET /generalledger/v1/journalentrybatches/{batch_id}/validate - Read
Journal entry batch summary (Get)
Returns the journal entry batch summary.
GET /generalledger/v1/journalentrybatches/{batch_id}/summary - Read
Journal entry custom field (List)
Returns a list of custom field options.
GET /generalledger/v1/journalentrybatches/customfields - Read
Ledger summary (List)
Lists general ledger summaries for the specified fiscal year and criteria. Note that summary records only exist for closed or optimized fiscal years. If any activity occurs in a fiscal period that has not since been closed or optimized, it will not be included in the GL summary record(s).
GET /generalledger/v1/summary/{fiscal_year_id} - Read
Period summary (List)
Once the summarization process is complete, this is the endpoint you use to get data returned.
GET /generalledger/v1/periodsummary/summaries - Read
Period summary process (Get)
This endpoint reports on the current status of the summarize request, whether it is completed, still running, or failed.
GET /generalledger/v1/periodsummary/processinginfo - Read
Project (Get)
Returns the specified project.
GET /generalledger/v1/projects/{project_id} - Read
Project (Search)
Returns the projects matching the search.
GET /generalledger/v1/projects - Read
Project attachment (List)
Returns the specified project's attachments.
GET /generalledger/v1/projects/{project_id}/attachments - Read
Project custom field (List)
Returns a list of custom field options.
GET /generalledger/v1/projects/customfields - Read
Project department (List)
Returns the list of project departments.
GET /generalledger/v1/projects/departments - Read
Project division (List)
Returns the list of project divisions.
GET /generalledger/v1/projects/divisions - Read
Project location (List)
Returns the list of project locations.
GET /generalledger/v1/projects/locations - Read
Project notes (Get)
Returns a collection of notes for a specified project.
GET /generalledger/v1/projects/{project_id}/notes - Read
Project status (List)
Returns the list of project statuses.
GET /generalledger/v1/projects/statuses - Read
Project type (List)
Returns the list of project types.
GET /generalledger/v1/projects/types - Read
Transaction code (List)
Returns the list of all available transaction codes.
GET /generalledger/v1/transactioncodes - Read
Transaction code value (List)
Returns the list of all values for the specified transaction code.
GET /generalledger/v1/transactioncodes/{transaction_code_id}/values - Read
Transaction distribution (List)
Returns a list of transactions matching the search criteria
GET /generalledger/v1/transactiondistributions - Read
Transaction distribution set (Get)
Returns the transaction distribution set details.
GET /generalledger/v1/distributionsets/transaction/{set_id} - Read
Transaction distribution set (List)
Returns the list of transaction distribution sets.
GET /generalledger/v1/distributionsets/transaction - Write
Budget (Create)
Returns the identifier for the newly created budget scenario.
POST /generalledger/v1/budgets - Write
Budget (Edit)
Returns the identifier for the newly edited budget scenario.
PATCH /generalledger/v1/budgets/{scenario_id} - Write
Budget lines (Add)
Adds new rows to an existing budget. Existing rows with an identical account number, project ID, and grant description display in a single, merged row that calculates totals for amounts and distributions.
POST /generalledger/v1/budgets/{scenario_id}/lines - Write
Budget scenario (Create)
Returns the identifier for the newly created scenario id.
POST /generalledger/v1/budgets/scenarios - Write
Cash management distribution set (Create)
Returns the identifier of the new created cash management distribution set.
POST /generalledger/v1/distributionsets/cashmanagement - Write
Cash management distribution set (Edit)
Returns the identifier of the edited cash management distribution set.
PATCH /generalledger/v1/distributionsets/cashmanagement/{set_id} - Write
Journal entry (Create) (Deprecated)
This endpoint has been deprecated. While it remains available for existing integrations, it is no longer supported and will not receive updates or enhancements. To improve performance and reliability, this endpoint has been replaced by CreateJournalEntriesProcess .
POST /generalledger/v1/journalentrybatches/{batch_id}/journalentries - Write
Journal entry (Edit)
Journal entry (Edit)
PATCH /generalledger/v1/journalentrybatches/{batch_id}/journalentries/{journal_entry_id} - Write
Journal entry batch (Create) (Deprecated)
This endpoint has been deprecated. While it remains available for existing integrations, it is no longer supported and will not receive updates or enhancements. To improve performance and reliability, this endpoint has been replaced by CreateJournalEntryBatchProcess .
POST /generalledger/v1/journalentrybatches - Write
Journal entry batch (Edit)
Returns the identifier of the edited batch
PATCH /generalledger/v1/journalentrybatches/{batch_id} - Write
Journal entry batch (Post)
Returns the results of batch validation.
POST /generalledger/v1/journalentrybatches/{batch_id}/post - Write
Journal entry batch attachment (Create)
Journal entry batch attachment (Create)
POST /generalledger/v1/journalentrybatches/attachments - Write
Journal entry batch process (Create)
Returns the process id of the request to create a new journal entry batch.
POST /generalledger/v1/journalentrybatches/process - Write
Journal entry process (Create)
Returns the process ID of the request to add journal entries to a batch.
POST /generalledger/v1/journalentrybatches/{batch_id}/journalentries/process - Write
Period summary process (Start)
This endpoint must be called first, with the appropriate switches to select what year/period ID you wish to summarize. The summarization process may take several minutes, but will continue processing even if you are making other API calls right after it. Not providing a period ID or providing a period ID of 0 will summarize all open and unoptimized periods.
POST /generalledger/v1/periodsummary/summarize - Write
Project (Create)
Returns the identifier for the newly created project.
POST /generalledger/v1/projects - Write
Project (Edit)
Edits an existing project.
PATCH /generalledger/v1/projects/{project_id} - Write
Project attachment (Create)
Project attachment (Create)
POST /generalledger/v1/projects/attachments - Write
Project Contact (Create)
Returns the identifier for the newly created contact.
POST /generalledger/v1/projects/{project_id}/contacts - Write
Project note (Create)
Adds a note to a project. Returns the created identifier of the note.
POST /generalledger/v1/projects/{project_id}/notes - Write
Transaction distribution set (Create)
Returns the identifier of the new created transaction distribution set.
POST /generalledger/v1/distributionsets/transaction - Write
Transaction distribution set (Edit)
Returns the identifier of the edited transaction distribution set.
PATCH /generalledger/v1/distributionsets/transaction/{set_id} - Destructive
Cash management distribution set (Delete)
Removes the cash management distribution set.
DELETE /generalledger/v1/distributionsets/cashmanagement/{set_id} - Destructive
Journal entry (Clear) (Deprecated)
This endpoint has been deprecated. While it remains available for existing integrations, it is no longer supported and will not receive updates or enhancements. To improve performance and reliability, this endpoint has been replaced by ClearJournalEntriesProcess .
DELETE /generalledger/v1/journalentrybatches/{batch_id}/journalentries - Destructive
Journal entry batch (Delete)
Removes a journal entry batch.
DELETE /generalledger/v1/journalentrybatches/{batch_id} - Destructive
Journal entry process (Clear)
Returns the process ID of the request to clear journal entries from a batch.
DELETE /generalledger/v1/journalentrybatches/{batch_id}/journalentries/process - Destructive
Project attachment (Delete)
Removes the project attachment.
DELETE /generalledger/v1/projects/{project_id}/attachments/{attachment_id} - Destructive
Transaction distribution set (Delete)
Removes the transaction distribution set.
DELETE /generalledger/v1/distributionsets/transaction/{set_id}
Accounts Payable
- Read
Accounts payable department (List)
Returns a list of accounts payable departments.
GET /accountspayable/v1/departments - Read
Accounts payable interfund set (List)
Returns a list of interfund sets for accounts payable.
GET /accountspayable/v1/interfundsets - Read
Accounts Payable Media Type (List)
Returns a list of media type options.
GET /accountspayable/v1/mediaTypes - Read
Accounts payable product (List)
Returns a list of products.
GET /accountspayable/v1/products - Read
Activity types (List)
Returns a list of activity types.
GET /accountspayable/v1/activitytypes - Read
Address (List)
Returns a list of the addresses of the vendor requested.
GET /accountspayable/v1/vendors/{vendor_id}/addresses - Read
Background process result (Get)
Returns the record ID as result of the registered process. Use this with the "Invoice process (Create)" and "Background process status (Get)" endpoints to enhance invoice processing.
GET /accountspayable/v1/backgroundProcess/{process_id}/result - Read
Background process status (Get)
Returns the background process status of the process identifier. Use this with the "Invoice process (Create)" and "Background process result (Get)" endpoints to enhance invoice processing.
GET /accountspayable/v1/backgroundProcess/{process_id}/status - Read
Box number value (List)
Returns a list of 1099 box number values.
GET /accountspayable/v1/boxnumbers - Read
Buyer (List)
Returns a list of buyers.
GET /accountspayable/v1/buyers - Read
Contact method (List)
Returns the contact methods of the vendor address requested.
GET /accountspayable/v1/vendors/{vendor_id}/addresses/{address_id}/contactmethods - Read
Credit memo
Returns detailed credit memo information.
GET /accountspayable/v1/creditmemos/{credit_memo_id} - Read
Credit memo custom field (List)
Returns a list of custom field options.
GET /accountspayable/v1/creditmemos/customfields - Read
Credit memos (List)
Returns a list of credit memos.
GET /accountspayable/v1/creditmemos - Read
FOB (List)
Returns a list of freight on board options.
GET /accountspayable/v1/fobs - Read
Invoice (Get)
Returns the specified invoice.
GET /accountspayable/v1/invoices/{invoice_id} - Read
Invoice (List)
Returns a list of invoices fitting the given criteria.
GET /accountspayable/v1/invoices - Read
Invoice 1099 amount (Get)
Returns the specified invoice 1099 information.
GET /accountspayable/v1/invoices/{invoice_id}/1099amount - Read
Invoice 1099 box numbers (List)
Returns the specified invoice 1099 box number information.
GET /accountspayable/v1/invoices/{invoice_id}/1099boxnumber - Read
Invoice adjustment (Get)
Returns invoice adjustment information for a specific adjustment. Contains distribution information.
GET /accountspayable/v1/invoices/{invoice_id}/adjustments/{adjustment_id} - Read
Invoice adjustment summary (List)
Returns a collection of adjustment summaries for a specific invoice.
GET /accountspayable/v1/invoices/{invoice_id}/adjustments - Read
Invoice custom field (List)
Returns a list of custom field options.
GET /accountspayable/v1/invoices/customfields - Read
Invoice import results (Get)
Returns per-invoice success/failure results for a completed bulk invoice import job. Each result indicates whether the invoice was created and, on failure, the error message.
GET /accountspayable/v1/invoices/import/{process_id}/results - Read
Invoice import status (Get)
Returns the current progress of a bulk invoice import job. Recommended polling interval: 5–10 seconds. Stop polling when status is Completed, Failed, or Cancelled, then fetch results.
GET /accountspayable/v1/invoices/import/{process_id}/status - Read
Line item (Get)
Returns the specified line item with distribution information.
GET /accountspayable/v1/purchaseorders/{purchase_order_id}/lineitems/{line_item_id} - Read
Line Items (List)
Returns a list of line items.
GET /accountspayable/v1/purchaseorders/{purchase_order_id}/lineitems - Read
Organization address (List)
Returns a list of organization addresses.
GET /accountspayable/v1/orgaddresses - Read
Payment term (List)
Returns a list of payment terms.
GET /accountspayable/v1/paymentterms - Read
Purchase Order (Get)
Returns the specified purchase order.
GET /accountspayable/v1/purchaseorders/{purchase_order_id} - Read
Purchase order (List)
Returns a list of purchase order summaries.
GET /accountspayable/v1/purchaseorders - Read
Purchase Order custom field options (List)
Returns a list of custom field options.
GET /accountspayable/v1/purchaseorders/customfields - Read
Receipt (Get)
Returns the details of a receipt.
GET /accountspayable/v1/receipts/{receipt_id} - Read
Receipt (List)
Returns a list of receipt summaries.
GET /accountspayable/v1/receipts - Read
Sales tax items (List)
Returns a list of sales tax items.
GET /accountspayable/v1/salestaxitems - Read
Ship via (List)
Returns a list of shipping codes.
GET /accountspayable/v1/shipvia - Read
Staff (List)
Returns a list of staff members.
GET /accountspayable/v1/staff - Read
State 1099 (List)
Returns a list of states for 1099.
GET /accountspayable/v1/states1099 - Read
Tax entities (List)
Returns the tax entity list.
GET /accountspayable/v1/taxentities - Read
Transaction code (List)
Returns the list of all available transaction codes.
GET /accountspayable/v1/transactioncodes - Read
Transaction code value (List)
Returns the list of all values for the specified transaction code.
GET /accountspayable/v1/transactioncodes/{transaction_code_id}/values - Read
Unit of measure (List)
Returns a list of units of measure.
GET /accountspayable/v1/unitsofmeasure - Read
Vendor (Get)
Returns the vendor requested.
GET /accountspayable/v1/vendors/{vendor_id} - Read
Vendor (List)
Returns the list of vendors.
GET /accountspayable/v1/vendors - Read
Vendor 1099 info
Returns the default box numbers for a specified vendor.
GET /accountspayable/v1/vendors/{vendor_id}/1099info - Read
Vendor attachment (List)
Returns the specified vendor's attachments.
GET /accountspayable/v1/vendors/{vendor_id}/attachments - Read
Vendor contact (List)
Returns a list of vendor contacts for a specified vendor.
GET /accountspayable/v1/vendors/{vendor_id}/contacts - Read
Vendor credit memos (List)
Returns a collection of credit memos for a specified vendor.
GET /accountspayable/v1/vendors/{vendor_id}/creditmemos - Read
Vendor custom field (List)
Returns a list of custom field options.
GET /accountspayable/v1/vendors/customfields - Read
Vendor default distributions (List)
Returns a collection of default distributions for a specified vendor.
GET /accountspayable/v1/vendors/{vendor_id}/defaultdistributions - Read
Vendor notes (List)
Returns the notes and actions of the vendor requested.
GET /accountspayable/v1/vendors/{vendor_id}/notes - Write
Address (Create)
Returns the identifier of the created vendor address.
POST /accountspayable/v1/vendors/{vendor_id}/addresses - Write
Address (Edit)
Returns the identifier of the edited invoice.
PATCH /accountspayable/v1/vendors/{vendor_id}/addresses/{address_id} - Write
Contact method (Create)
Returns the identifier of the new contact method.
POST /accountspayable/v1/vendors/{vendor_id}/addresses/{address_id}/contactmethods - Write
Credit memo (Create)
Creates a credit memo, and returns the id of the created credit memo.
POST /accountspayable/v1/creditmemos - Write
Credit memo (Edit)
Edits an existing credit memo.
PATCH /accountspayable/v1/creditmemos/{credit_memo_id} - Write
Invoice (Create) (Deprecated)
This endpoint has been deprecated. While it remains available for existing integrations, it is no longer supported and will not receive updates or enhancements. To improve performance and reliability, this endpoint has been replaced by CreateInvoiceProcess .
POST /accountspayable/v1/invoices - Write
Invoice (Edit)
Returns the identifier of the edited invoice.
PATCH /accountspayable/v1/invoices/{invoice_id} - Write
Invoice adjustment (Create)
Applies adjustments to posted and unpaid invoices. Returns the identifier for the created invoice adjustment.
POST /accountspayable/v1/invoices/{invoice_id}/adjustments - Write
Invoice attachment (Create)
Returns the id saved attachment. Physical attachments require the request to be a multipart/form-data request and are limited to 25 MB or smaller. Physical attachment request must provide "ParentId" and "MediaType" fields instead of "parent_id" and "media_type".
POST /accountspayable/v1/invoices/attachments - Write
Invoice import batch (Upload)
Uploads a batch of invoices to an existing import job and triggers async processing. Returns a batch process ID. Poll the job status endpoint to track overall progress.
POST /accountspayable/v1/invoices/import/{process_id} - Write
Invoice import job (Create)
Creates a bulk invoice import job and returns a process ID. Use the process ID to upload invoice batches via "Invoice import batch (Upload)" and to poll status via "Invoice import status (Get)". Requires the InvoiceSaveV2 entitlement. US tenants only.
POST /accountspayable/v1/invoices/import - Write
Invoice process (Create)
Returns the process ID of the request to create a new invoice. Use this with the "Background process result (Get)" and "Background process status (Get)" endpoints to enhance invoice processing.
POST /accountspayable/v1/invoices/process - Write
Line item (Create)
Adds line items to an existing purchase order.
POST /accountspayable/v1/purchaseorders/{purchase_order_id}/lineitems - Write
Purchase Order (Create)
Creates a new purchasee order.
POST /accountspayable/v1/purchaseorders - Write
Vendor (Create)
Returns the identifier of the created vendor.
POST /accountspayable/v1/vendors - Write
Vendor (Edit)
Edits a specified vendor.
PATCH /accountspayable/v1/vendors/{vendor_id} - Write
Vendor attachment (Create)
Returns the id saved attachment. Physical attachments require the request to be a multipart/form-data request and are limited to 25 MB or smaller. Physical attachment request must provide "ParentId" and "MediaType" fields instead of "parent_id" and "media_type".
POST /accountspayable/v1/vendors/attachments - Write
Vendor note (Create)
Returns the identifier of the new note.
POST /accountspayable/v1/vendors/{vendor_id}/notes - Destructive
Address (Delete)
Removes the address from the vendor.
DELETE /accountspayable/v1/vendors/{vendor_id}/addresses/{address_id} - Destructive
Credit memo (Delete)
Delete a credit memo if applicable.
DELETE /accountspayable/v1/creditmemos/{credit_memo_id} - Destructive
Invoice adjustment (Delete)
Removes unposted invoice adjustments from an invoice.
DELETE /accountspayable/v1/invoices/{invoice_id}/adjustments/{adjustment_id} - Destructive
Vendor attachment (Delete)
Removes the vendor attachment.
DELETE /accountspayable/v1/vendors/{vendor_id}/attachments/{attachment_id}
Gift
- Read
Attachment tags
Returns a list of available attachment tags.
GET /gift/v1/attachmenttags - Read
Gift (Get)
Returns information about a gift.
GET /gift/v1/gifts/{gift_id} - Read
Gift attachment list (Single gift)
Returns a list of attachments for a gift.
GET /gift/v1/gifts/{gift_id}/attachments - Read
Gift custom field categories
Returns a list of custom field categories.
GET /gift/v1/gifts/customfields/categories - Read
Gift custom field category values
Returns the list of custom field category values.
GET /gift/v1/gifts/customfields/categories/values - Read
Gift custom field list (All gifts)
Returns a paginated list of gift custom fields. The default sorting behavior is to list gift custom fields in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list gift custom fields in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that gift custom fields are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list gift custom fields based on when they were last modified. Note: This endpoint returns data with an average latency of about 30 minutes. In addition, historic records have a default date_added timestamp of 1600-01-01 00:00:00.000 +00:00. The timestamp for newer records reflects when the records were added.
GET /gift/v1/gifts/customfields - Read
Gift custom field list (Single gift)
Returns a list of custom fields for a gift.
GET /gift/v1/gifts/{gift_id}/customfields - Read
Gift list
Returns a paginated list of gifts. The default sorting behavior is to list gifts in ascending order based on the id . However, the last_modified parameter overrides the default sorting behavior to list gifts in ascending order based on when they were last modified, and the date_added parameter overrides the default sorting behavior to list gifts in ascending order based on when they were created. The last_modified and date_added parameters also add the sort_token parameter to the next_link URL to ensure that gifts are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list gifts based on when they were last modified. Note: This endpoint returns data with an average latency of about 30 minutes.
GET /gift/v1/gifts - Read
Gift subtypes
Returns a list of gift subtypes.
GET /gift/v1/giftsubtypes - Read
Recurring gift eligibility for automated processing
Returns whether the recurring gift can be converted to an automated gift in the web view.
GET /gift/v1/recurringgifts/{gift_id}/canbeconverted - Write
Adds custom field Category (GetOrCreate)
Creates a gift custom field category if it doesn't exist or retrieves the id of the existing category.
POST /gift/v1/gifts/customfields/categories - Write
Automate recurring gift
Converts a manual recurring gift to an automated recurring gift in the web view.
POST /gift/v1/recurringgifts/{gift_id}/converttoautomatic - Write
Document (Create)
Creates a document upload location and unique document identifier for physical attachments.
POST /gift/v1/documents - Write
Gift (Batch)
Adds one or more gifts to a specified gift batch in the web view.
POST /gift/v1/giftbatches/{batch_id}/gifts - Write
Gift (Create)
Creates a gift.
POST /gift/v1/gifts - Write
Gift (Edit)
Edits a gift. Posted gifts cannot be modified.
PATCH /gift/v1/gifts/{gift_id} - Write
Gift acknowledgement (Edit)
Edits a gift acknowledgement.
PATCH /gift/v1/giftacknowledgements/{acknowledgement_id} - Write
Gift attachment (Create)
Creates a gift attachment.
POST /gift/v1/gifts/attachments - Write
Gift attachment (Edit)
Edits a gift attachment.
PATCH /gift/v1/gifts/attachments/{attachment_id} - Write
Gift custom field (Create)
Creates a gift custom field.
POST /gift/v1/gifts/customfields - Write
Gift custom field (Edit)
Edits a gift custom field.
PATCH /gift/v1/gifts/customfields/{custom_field_id} - Write
Gift custom field collection (Create)
Creates a gift custom field.
POST /gift/v1/gifts/{gift_id}/customfieldcollection - Write
Gift list
Returns a paginated list of gifts. The default sorting behavior is to list gifts in ascending order based on the id . However, the last_modified parameter overrides the default sorting behavior to list gifts in ascending order based on when they were last modified, and the date_added parameter overrides the default sorting behavior to list gifts in ascending order based on when they were created. The last_modified and date_added parameters also add the sort_token parameter to the next_link URL to ensure that gifts are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list gifts based on when they were last modified. Note: This endpoint returns data with an average latency of about 30 minutes.
POST /gift/v1/gifts/list - Write
Gift receipt (Edit)
Edits a gift receipt.
PATCH /gift/v1/giftreceipts/{receipt_id} - Write
Gift status (Edit)
Edit the status of a recurring gift.
PUT /gift/v1/recurringgifts/{gift_id}/status - Destructive
Gift (Delete)
Deletes a gift. If a gift was added in database view or added through the API with the is_manual flag set to true, you can only delete it if it is a recurring gift, recurring gift payment, or pledge. You can delete gifts added via web view except for any recurring gift payment. Recurring gifts added via web view cannot be deleted if their current status is Active or Held. Pledge gifts added via web view or added through the API with the is_manual flag set to false cannot be deleted if their payment method is Credit card or Direct debit. Regardless of type, you can’t delete a gift if it has: claimed Gift Aid a payment with a live transaction ID a GL distribution record an adjustment a matching gift a pledge payment record or an uncommitted pledge payment in a batch a recurring gift payment record or an uncommitted recurring gift payment in a batch a write-off receipt history a receipt status of Receipted
DELETE /gift/v1/gifts/{gift_id} - Destructive
Gift attachment (Delete)
Deletes a gift attachment.
DELETE /gift/v1/gifts/attachments/{attachment_id} - Destructive
Gift custom field (Delete)
Deletes a gift custom field.
DELETE /gift/v1/gifts/customfields/{custom_field_id}
Fundraising
- Read
Appeal (Get)
Returns information about the appeal with the specified ID.
GET /fundraising/v1/appeals/{appeal_id} - Read
Appeal attachment list (Single appeal)
Returns a list of attachments for an appeal.
GET /fundraising/v1/appeals/{appeal_id}/attachments - Read
Appeal categories
Returns a list of appeal categories.
GET /fundraising/v1/appeals/categories - Read
Appeal custom field categories
Gets the list of custom field categories.
GET /fundraising/v1/appeals/customfields/categories - Read
Appeal custom field category values
Gets the list of custom field category values.
GET /fundraising/v1/appeals/customfields/categories/values - Read
Appeal custom field list (Single appeal)
Returns a list of custom fields for the appeal with the specified ID.
GET /fundraising/v1/appeals/{appeal_id}/customfields - Read
Appeal list
Returns a paginated list of appeals. The default sorting behavior is to list appeals in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list appeals in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that appeals are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list appeals based on when they were last modified.
GET /fundraising/v1/appeals - Read
Attachment tags
Returns a list of available attachment tags.
GET /fundraising/v1/attachmenttags - Read
Campaign (Get)
Returns information about the campaign with the specified ID.
GET /fundraising/v1/campaigns/{campaign_id} - Read
Campaign attachment list (Single campaign)
Returns a list of attachments for a campaign.
GET /fundraising/v1/campaigns/{campaign_id}/attachments - Read
Campaign categories
Returns a list of campaign categories.
GET /fundraising/v1/campaigns/categories - Read
Campaign custom field categories
Gets the list of custom field categories.
GET /fundraising/v1/campaigns/customfields/categories - Read
Campaign custom field category values
Gets the list of custom field category values.
GET /fundraising/v1/campaigns/customfields/categories/values - Read
Campaign custom field list (Single campaign)
Returns a list of custom fields for the campaign with the specified ID.
GET /fundraising/v1/campaigns/{campaign_id}/customfields - Read
Campaign list
Returns a paginated list of campaigns. The default sorting behavior is to list campaigns in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list campaigns in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that campaigns are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list campaigns based on when they were last modified.
GET /fundraising/v1/campaigns - Read
Fund (Get)
Returns information about the fund with the specified ID.
GET /fundraising/v1/funds/{fund_id} - Read
Fund attachment list (Single fund)
Returns a list of attachments for a fund.
GET /fundraising/v1/funds/{fund_id}/attachments - Read
Fund categories
Returns a list of fund categories.
GET /fundraising/v1/funds/categories - Read
Fund custom field categories
Gets the list of custom field categories.
GET /fundraising/v1/funds/customfields/categories - Read
Fund custom field category values
Gets the list of custom field category values.
GET /fundraising/v1/funds/customfields/categories/values - Read
Fund custom field list (Single fund)
Returns a list of custom fields for the fund with the specified ID.
GET /fundraising/v1/funds/{fund_id}/customfields - Read
Fund list
Returns a paginated list of funds. The default sorting behavior is to list funds in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list funds in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that funds are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list funds based on when they were last modified.
GET /fundraising/v1/funds - Read
Fundraiser assignment list (Single fundraiser)
Returns a list of fundraiser assignments for a fundraiser.
GET /fundraising/v1/fundraisers/{fundraiser_id}/assignments - Read
Fundraiser goal categories
Returns a list of active fundraiser goal categories.
GET /fundraising/v1/fundraisers/goals/categories - Read
Fundraiser goal list (Single fundraiser)
Returns a list of fundraiser goals for a fundraiser.
GET /fundraising/v1/fundraisers/{fundraiser_id}/goals - Read
Fundraiser types
Gets the list of active fundraiser types.
GET /fundraising/v1/fundraisers/types - Read
Package (Get)
Returns information about the package with the specified ID.
GET /fundraising/v1/packages/{package_id} - Read
Package list
Returns a paginated list of packages. The default sorting behavior is to list packages in ascending order based on when they were created. However, the last_modified parameter overrides the default sorting behavior to list packages in ascending order based on when they were last modified. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that packages are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list packages based on when they were last modified.
GET /fundraising/v1/packages - Write
Appeal attachment (Create)
Creates an appeal attachment.
POST /fundraising/v1/appeals/attachments - Write
Appeal attachment (Edit)
Edits an appeal attachment.
PATCH /fundraising/v1/appeals/attachments/{attachment_id} - Write
Appeal custom field (Create)
Adds a new custom field.
POST /fundraising/v1/appeals/customfields - Write
Appeal custom field (Edit)
Edits an existing custom field.
PATCH /fundraising/v1/appeals/customfields/{custom_field_id} - Write
Campaign attachment (Create)
Creates a campaign attachment.
POST /fundraising/v1/campaigns/attachments - Write
Campaign attachment (Edit)
Edits a campaign attachment.
PATCH /fundraising/v1/campaigns/attachments/{attachment_id} - Write
Campaign custom field (Create)
Adds a new custom field.
POST /fundraising/v1/campaigns/customfields - Write
Campaign custom field (Edit)
Edits an existing custom field.
PATCH /fundraising/v1/campaigns/customfields/{custom_field_id} - Write
Document (Create)
Creates a document upload location and unique document identifier for physical attachments.
POST /fundraising/v1/documents - Write
Fund attachment (Create)
Creates a fund attachment.
POST /fundraising/v1/funds/attachments - Write
Fund attachment (Edit)
Edits a fund attachment.
PATCH /fundraising/v1/funds/attachments/{attachment_id} - Write
Fund custom field (Create)
Adds a new custom field.
POST /fundraising/v1/funds/customfields - Write
Fund custom field (Edit)
Edits an existing custom field.
PATCH /fundraising/v1/funds/customfields/{custom_field_id} - Write
Fundraiser assignment (Create)
Creates a fundraiser assignment.
POST /fundraising/v1/fundraisers/assignments - Write
Fundraiser assignment (Edit)
Edits a fundraiser assignment.
PATCH /fundraising/v1/fundraisers/assignments/{assignment_id} - Write
Fundraiser goal (Create)
Creates a fundraiser goal.
POST /fundraising/v1/fundraisers/goals - Write
Fundraiser goal (Edit)
Edits a fundraiser goal.
PATCH /fundraising/v1/fundraisers/goals/{goal_id} - Destructive
Appeal attachment (Delete)
Deletes an appeal attachment.
DELETE /fundraising/v1/appeals/attachments/{attachment_id} - Destructive
Appeal custom field (Delete)
Deletes the custom field with the specified ID.
DELETE /fundraising/v1/appeals/customfields/{custom_field_id} - Destructive
Campaign attachment (Delete)
Deletes a campaign attachment.
DELETE /fundraising/v1/campaigns/attachments/{attachment_id} - Destructive
Campaign custom field (Delete)
Deletes the custom field with the specified ID.
DELETE /fundraising/v1/campaigns/customfields/{custom_field_id} - Destructive
Fund attachment (Delete)
Deletes a fund attachment.
DELETE /fundraising/v1/funds/attachments/{attachment_id} - Destructive
Fund custom field (Delete)
Deletes the custom field with the specified ID.
DELETE /fundraising/v1/funds/customfields/{custom_field_id} - Destructive
Fundraiser assignment (Delete)
Deletes a fundraiser assignment.
DELETE /fundraising/v1/fundraisers/assignments/{assignment_id} - Destructive
Fundraiser goal (Delete)
Deletes a fundraiser goal.
DELETE /fundraising/v1/fundraisers/goals/{goal_id}
Opportunity
- Read
Attachment tags
Returns a list of available attachment tags.
GET /opportunity/v1/attachmenttags - Read
Opportunity (Get)
Returns information about an opportunity. Note: This endpoint returns the status property with a latency of about 10 minutes.
GET /opportunity/v1/opportunities/{opportunity_id} - Read
Opportunity attachment list (Single opportunity)
Returns a list of attachments for an opportunity.
GET /opportunity/v1/opportunities/{opportunity_id}/attachments - Read
Opportunity custom field categories
Returns the list of custom field categories.
GET /opportunity/v1/opportunities/customfields/categories - Read
Opportunity custom field category values
Returns the list of custom field category values.
GET /opportunity/v1/opportunities/customfields/categories/values - Read
Opportunity custom field list (Single opportunity)
Returns a list of custom fields for an opportunity.
GET /opportunity/v1/opportunities/{opportunity_id}/customfields - Read
Opportunity list
Returns a paginated list of opportunities. The default sorting behavior is to list opportunities in ascending order based on the id . However, the last_modified parameter overrides the default sorting behavior to list opportunities in ascending order based on when they were last modified, and the date_added parameter overrides the default sorting behavior to list opportunities in ascending order based on when they were created. The last_modified parameter also adds the sort_token parameter to the next_link URL to ensure that opportunities are stably sorted and that order persists when changes occur while working through a paginated list. If the last_modified and date_added parameters are both specified, the sorting behavior is to list opportunities based on when they were last modified.
GET /opportunity/v1/opportunities - Read
Opportunity note
Returns information about an opportunity note.
GET /opportunity/v1/opportunities/{opportunity_id}/notes/{note_id} - Read
Opportunity notes
Returns a list of notes for an opportunity.
GET /opportunity/v1/opportunities/{opportunity_id}/notes - Read
Opportunity purposes
Returns the list of opportunity purposes.
GET /opportunity/v1/opportunitypurposes - Read
Opportunity Status History (Get)
Returns an opportunity's status history. Note: This endpoint returns the status with a latency of about 10 minutes.
GET /opportunity/v1/opportunities/{opportunity_id}/statushistories - Read
Opportunity statuses
Returns the list of opportunity statuses.
GET /opportunity/v1/opportunitystatuses - Write
Document (Create)
Creates a document upload location and unique document identifier for physical attachments.
POST /opportunity/v1/documents - Write
Opportunity (Create)
Creates an opportunity.
POST /opportunity/v1/opportunities - Write
Opportunity (Edit)
Edits an opportunity.
PATCH /opportunity/v1/opportunities/{opportunity_id} - Write
Opportunity attachment (Create)
Creates an opportunity attachment.
POST /opportunity/v1/opportunities/attachments - Write
Opportunity attachment (Edit)
Edits an opportunity attachment.
PATCH /opportunity/v1/opportunities/attachments/{attachment_id} - Write
Opportunity custom field (Create)
Creates an opportunity custom field.
POST /opportunity/v1/opportunities/customfields - Write
Opportunity custom field (Edit)
Edits an opportunity custom field.
PATCH /opportunity/v1/opportunities/customfields/{custom_field_id} - Write
Opportunity note (Create)
Creates an opportunity note.
POST /opportunity/v1/opportunities/{opportunity_id}/notes - Write
Opportunity note (Edit)
Edits an opportunity note.
PATCH /opportunity/v1/opportunities/{opportunity_id}/notes/{note_id} - Destructive
Opportunity (Delete)
Deletes an opportunity.
DELETE /opportunity/v1/opportunities/{opportunity_id} - Destructive
Opportunity attachment (Delete)
Deletes an opportunity attachment.
DELETE /opportunity/v1/opportunities/attachments/{attachment_id} - Destructive
Opportunity custom field (Delete)
Deletes a custom field.
DELETE /opportunity/v1/opportunities/customfields/{custom_field_id}
Treasury
- Read
Adjustment (Get)
Retrieves information about a given adjustment.
GET /treasury/v1/adjustments/{adjustment_id} - Read
Adjustment categories (List)
Returns a list of adjustment categories for a given bank account.
GET /treasury/v1/bankaccounts/{bank_account_id}/adjustmentcategories - Read
Adjustments (List)
Returns a list of adjustments.
GET /treasury/v1/bankaccounts/{bank_account_id}/adjustments - Read
Bank account (Get)
Retrieves information about a given bank account.
GET /treasury/v1/bankaccounts/{bank_account_id} - Read
Bank account (List)
Returns a list of bank accounts.
GET /treasury/v1/bankaccounts - Read
Bank account register (List)
Returns a list of bank account register transactions.
GET /treasury/v1/bankaccounts/{bank_account_id}/register - Read
Cash receipt (Get)
Retrieves information about a given cash receipt.
GET /treasury/v1/cashreceipts/{cash_receipt_id} - Read
Cash receipt custom field (List)
Get custom field options for cash receipts.
GET /treasury/v1/cashreceipts/customfields - Read
Cash receipts (List)
Returns a list of cash receipts from a given deposit.
GET /treasury/v1/deposits/{deposit_id}/cashreceipts - Read
Checks (List)
Returns a list of bank account checks.
GET /treasury/v1/bankaccounts/{bank_account_id}/checks - Read
Credit card accounts (List)
Returns a list of credit card accounts.
GET /treasury/v1/creditcardaccounts - Read
Credit cards (List)
Returns a list of credit card summaries for a given credit card account.
GET /treasury/v1/creditcardaccounts/{credit_card_account_id}/creditcards - Read
Deposit (Get)
Retrieves information about a given deposit.
GET /treasury/v1/deposits/{deposit_id} - Read
Deposits (List)
Returns a list of deposits.
GET /treasury/v1/bankaccounts/{bank_account_id}/deposits - Read
Payment
Returns an individual payment with distribution information.
GET /treasury/v1/payments/{payment_id} - Read
Payment transactions (List)
Returns a list of paid transactions for a given payment. Accounts Payable Invoices and Credit Memos.
GET /treasury/v1/payments/{payment_id}/transactions - Read
Subledger settings
Returns a list of subledger settings.
GET /treasury/v1/bankaccounts/{bank_account_id}/subledgersettings - Read
Transaction code (List)
Returns the list of all available transaction codes.
GET /treasury/v1/transactioncodes - Read
Transaction code value (List)
Returns the list of all values for the specified transaction code.
GET /treasury/v1/transactioncodes/{transaction_code_id}/values - Read
Treasury Media Type (List)
Returns a list of media type options.
GET /treasury/v1/mediaTypes - Write
Adjustment (Create)
Creates a new adjustment.
POST /treasury/v1/bankaccounts/{bank_account_id}/adjustments - Write
Cash receipt (Create)
Adds a new cash receipt.
POST /treasury/v1/deposits/{deposit_id}/cashreceipts - Write
Cash receipt attachment (Create)
Returns the id saved attachment.
POST /treasury/v1/cashreceipts/attachments - Write
Deposit (Create)
Adds a new deposit.
POST /treasury/v1/bankaccounts/{bank_account_id}/deposits - Write
Payment (Create)
Creates a new payment.
POST /treasury/v1/payments/createpayment
Academics
- Read
Assignment grade list (Get) (PREVIEW)
Returns a collection of student assignment grades. Requires the following role in the Education Management system: Grade Book Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edaca/v1/assignments/grades - Read
Conduct occurrence (Get) (PREVIEW)
Returns a single conduct occurrence for a student Requires the Conduct Manager role for all students, the Faculty role limited to current students, the Student role limited to self, or the Parent role limited to their own students. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edaca/v1/conduct/occurrences/{student_id}/{student_occurrence_id} - Read
Conduct occurrence list - single student (Get) (PREVIEW)
Returns the collection of conduct occurrences for a student within the specified date range Requires the All School role in the Education Management system. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edaca/v1/conduct/occurrences/{student_id} - Read
Conduct occurrence list (Get) (PREVIEW)
Returns the collection of conduct occurrences within the specified date range, not limited to a student Requires the Conduct Manager role in the Education Management system. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edaca/v1/conduct/occurrences - Read
Consequence type list (Get) (PREVIEW)
Returns the collection of conduct consequence types defined in the system Requires the All School role in the Education Management system. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edaca/v1/conduct/consequencetypes - Read
Grade translations list (Get)
Returns a collection of grade translations. Requires the following role in the Education Management system: Grading Manager
GET /afe-edaca/v1/grading/gradetranslations - Read
Learning profile form list (Get) (PREVIEW)
Returns the list of learning profile forms. Requires the following role in the Education Management system: Learning Profile Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edaca/v1/learningprofiles/forms - Read
Learning profile list – single student (Get) (PREVIEW)
Returns the list of learning profiles for a student. Requires the following role in the Education Management system: Learning Profile Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edaca/v1/learningprofiles/{student_id} - Read
Occurrence type list (Get) (PREVIEW)
Returns the collection of conduct occurrence types defined in the system Requires the All School role in the Education Management system. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edaca/v1/conduct/occurrencetypes - Write
Learning profile (Create) (PREVIEW)
Add a student learning profile. Requires the following role in the Education Management system: Learning Profile Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /afe-edaca/v1/learningprofiles - Write
Learning profile (Edit) (PREVIEW)
Update a student’s learning profile. Requires the following role in the Education Management system: Learning Profile Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /afe-edaca/v1/learningprofiles/{student_id}/{learning_profile_id}
Education Core
- Read
Attachment (Upload) (PREVIEW)
Provisions a temporary file location to upload attachments to Education Management. This is a two-step process. This Get call’s response includes a unique URL and token combination you will use in a separate Post call to upload the file data. That upload call will return a temporary filename that will be used with the appropriate Post or Patch endpoint - e.g. Test score (Create) in the Enrollment Management API and UserRecord in the User Create/Update API's. See Creating physical attachments for more information. Requires at least one of the following roles in the Education Management system: Any user can provision a file ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edcor/v1/attachments?type={type} - Read
List execution job (Get) (PREVIEW)
Returns the status of a list job and the SAS URI location for accessing the results for completed jobs. Only the user that started the job can access its status and results. The SAS URI for the file location expires after 15 minutes. Requires at least one of the following roles in the Education Management system: Only the user that created the job can can access a job’s status ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edcor/v1/lists/jobs/{jobId} - Read
List execution job list (Get) (PREVIEW)
Returns the jobs executed by the user over the last 7 days. Requires at least one of the following roles in the Education Management system: Any role – only jobs created by the user are returned ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edcor/v1/lists/jobs - Read
List type list (Get) (PREVIEW)
Returns the list of saved lists, including basic, advanced, and SKY lists. Requires at least one of the following roles in the Education Management system: Any role ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edcor/v1/lists - Read
Organization list (Get) (PREVIEW)
Returns a collection of organizations and schools. Requires "All School" permission. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edcor/v1/organizations - Write
List execution job (Create) (PREVIEW)
Returns the Job ID of the created job. Accepts Basic, Advanced, and Sky list types. `list_id` is required for Basic and Advanced lists, optional for Sky lists. `category` is required for Sky lists when `list_id` is not specified. When both `list_id` and `category` are supplied for a Sky list, `list_id` takes precedence. Requires at least one of the following roles in the Education Management system: Only the user that created the job can can access a job's status ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /afe-edcor/v1/lists/jobs - Write
User (Search) (PREVIEW)
Returns a list of users that meet specified criteria Requires at least one of the following roles in the Education Management system: Platform Manager Admissions Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /afe-edcor/v1/users/search - Write
User BBID (Connect) (PREVIEW)
Connects a set of user records to BBID accounts and can send login invite emails. Requires at least one of the following roles in the Education Management system: Platform Manager Admissions Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /afe-edcor/v1/users/bbid/connect - Write
User BBID (Disconnect) (PREVIEW)
Disconnects a set of BBID accounts Requires at least one of the following roles in the Education Management system: Platform Manager Admissions Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /afe-edcor/v1/users/bbid/disconnect
Enrollment Management
- Read
Candidate (Get)
Returns a candidate's information for a specific year. Defaults to the current admissions year. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/candidates/{candidate_id} - Read
Candidate checklist (Get)
Returns a candidate's checklist for a specified year. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/checklists/{candidate_id} - Read
Candidate checklist status type list (Get)
Returns a collection of admissions checklist statuses. Requires the following role in the Education Management system: Admissions Manager Admissions Staff Platform Manager SKY API Data Sync
GET /afe-edems/v1/types/checkliststatuses - Read
Candidate checklist type (Get)
Returns a checklist and the steps defined for the checklist. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/types/checklistTypes/{checklist_type_id} - Read
Candidate checklist type list (Get)
Returns a collection of checklist types. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/types/checklistTypes - Read
Candidate list (Get)
Returns a collection of admission candidates. Requires the following role in the Education Management system: Admissions Manager Admissions Staff Platform Manager SKY API Data Sync
GET /afe-edems/v1/candidates - Read
Candidate status change list - single candidate (Get)
Returns the status history for a candidate. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/candidatestatuses/{candidate_id} - Read
Candidate status change list (Get)
Returns the candidate status changes for a year. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/candidatestatuses - Read
Candidate status type list (Get)
Returns a collection of admission statuses. Requires one of the following roles in the Education Management system: Admissions Manager Admissions Staff Platform Manager SKY API Data Sync
GET /afe-edems/v1/types/candidatestatuses - Read
Contract (Get) (PREVIEW)
Return information about a contract. Requires the following role in the Education Management system: Admissions Manager Admissions Staff Parent, Parent of incoming student, Parent of candidate Candidate, Incoming student, Student ReEnrollment Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edems/v1/contracts/{user_id}/{contract_id} - Read
Contract list - single student (Get) (PREVIEW)
Return the list of contracts for a candidate or student. Requires the following role in the Education Management system: Admissions Manager Admissions Staff Parent, Parent of incoming student, Parent of candidate Candidate, Incoming student, Student ReEnrollment Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /afe-edems/v1/contracts/{user_id} - Read
Inquiry (Get)
Returns an inquiry and its data. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/inquiries/{inquiry_id} - Read
Inquiry list (Get)
Returns list of inquiry and its data. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/inquiries - Read
Interest type list (Get)
Returns the types of interests defined for use.
GET /afe-edems/v1/types/interesttypes - Read
Student checklist list - single student (Get)
Returns a student's checklists and their steps for a specified year. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/studentchecklists/{student_id} - Read
Student checklist list (Get)
Returns list of student checklists for a school year. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/studentchecklists - Read
Student checklist type (Get)
Returns a student checklist for the checklist. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/types/studentchecklisttypes/{student_checklist_type_id} - Read
Student checklist type list (Get)
Returns the student checklists defined in the system. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/types/studentchecklisttypes - Read
Test list (Get)
Returns tests scores for candidates. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
GET /afe-edems/v1/tests - Write
Candidate (Create)
Creates a candidate record for the user for a specified school year. Requires the following role in the Education Management system: Admissions Manager Admissions Staff Platform Manager SKY API Data Sync
POST /afe-edems/v1/candidates - Write
Candidate (Edit)
Updates candidate information for the specified entering year. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
PATCH /afe-edems/v1/candidates/{candidate_id} - Write
Candidate checklist step (Edit)
Updates a checklist step on a candidate's checklist Requires the following role in the Education Management system: Admissions Manager Admissions Staff
PATCH /afe-edems/v1/checklists/{candidate_id}/steps - Write
Contract (Edit) (PREVIEW)
Update contract tuition insurance information for a candidate or student contract. Requires the following role in the Education Management system: Admissions Manager Admissions Staff ReEnrollment Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /afe-edems/v1/contracts/{user_id}/{contract_id} - Write
Contract insurance (Edit) (PREVIEW)
Update insurance information for a specific payment plan of a contract. Requires the following role in the Education Management system: Admissions Manager Admissions Staff ReEnrollment Manager ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /afe-edems/v1/contracts/{user_id}/{contract_id}/paymentplans/{signer_id}/insurance - Write
Inquiry (Create)
Create an inquiry. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
POST /afe-edems/v1/inquiries - Write
Student checklist step (Edit)
Updates a step on a student checklist. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
PATCH /afe-edems/v1/studentchecklists/{student_id}/{student_checklist_id}/steps/{step_id} - Write
Test (Create)
Add test for candidate. Requires one of the following roles in the Education Management system: Admissions Manager Admissions Staff
POST /afe-edems/v1/tests/{candidate_id} - Destructive
Inquiry (Delete)
Deletes an inquiry. Requires the following role in the Education Management system: Admissions Manager Admissions Staff
DELETE /afe-edems/v1/inquiries/{inquiry_id}
OneRoster
- Read
AcademicSession by id
Returns a specific academic session.
GET /afe-rostr/ims/oneroster/academicSessions/{id} - Read
AcademicSessions all
Returns a collection of academic sessions.
GET /afe-rostr/ims/oneroster/academicSessions - Read
Categories all
Returns a collection of categories.
GET /afe-rostr/ims/oneroster/categories - Read
Categories for a class
Returns a collection of categories for a specified ```class_id```.
GET /afe-rostr/ims/oneroster/classes/{class_id}/categories - Read
Category by id
Returns a specific category.
GET /afe-rostr/ims/oneroster/categories/{id} - Read
Class by id
Returns a specific class.
GET /afe-rostr/ims/oneroster/classes/{id} - Read
Classes all
Returns a collection of classes.
GET /afe-rostr/ims/oneroster/classes - Read
Classes for a school
Returns a collection of classes for the specified ```school_id```.
GET /afe-rostr/ims/oneroster/schools/{school_id}/classes - Read
Classes for a teacher
Returns a collection of classes for the specified ```teacher_id```.
GET /afe-rostr/ims/oneroster/teachers/{teacher_id}/classes - Read
Course by id
Returns a specific course.
GET /afe-rostr/ims/oneroster/courses/{id} - Read
Courses all
Returns a collection of courses.
GET /afe-rostr/ims/oneroster/courses - Read
Courses for school
Returns a collection of courses for the specified ```school_id```.
GET /afe-rostr/ims/oneroster/schools/{school_id}/courses - Read
Demographics all
Returns a collection of user's demographic data.
GET /afe-rostr/ims/oneroster/demographics - Read
Demographics by id
Returns a single user's demographic data for the specified ```id```..
GET /afe-rostr/ims/oneroster/demographics/{id} - Read
Enrollment by id
Returns a specific enrollment.
GET /afe-rostr/ims/oneroster/enrollments/{id} - Read
Enrollments all
Returns a collection of enrollments.
GET /afe-rostr/ims/oneroster/enrollments - Read
Enrollments for a class in a school
Returns a collection of enrollments for the specified ```class_id``` in the ```school_id```.
GET /afe-rostr/ims/oneroster/schools/{school_id}/classes/{class_id}/enrollments - Read
Enrollments for a school
Returns a collection of enrollments for the specified ```school_id```.
GET /afe-rostr/ims/oneroster/schools/{school_id}/enrollments - Read
GradingPeriod by id
Returns a specific grading period.
GET /afe-rostr/ims/oneroster/gradingPeriods/{id} - Read
GradingPeriods all
Returns a collection of grading periods.
GET /afe-rostr/ims/oneroster/gradingPeriods - Read
GradingPeriods for term
Returns a collection of grading periods for the specified ```term_id```
GET /afe-rostr/ims/oneroster/terms/{term_id}/gradingPeriods - Read
LineItem by id
Returns a specific lineItem.
GET /afe-rostr/ims/oneroster/lineItems/{id} - Read
LineItems all
Returns a collection of lineItems.
GET /afe-rostr/ims/oneroster/lineItems - Read
LineItems for a class
Returns a collection of lineItems for the specified ```class_id```.
GET /afe-rostr/ims/oneroster/classes/{class_id}/lineItems - Read
Org by id
Returns a specific org.
GET /afe-rostr/ims/oneroster/orgs/{id} - Read
Orgs all
Returns a collection of organizations.
GET /afe-rostr/ims/oneroster/orgs - Read
Result by id
Returns a specific result.
GET /afe-rostr/ims/oneroster/results/{id} - Read
Results all
Returns a collection of results.
GET /afe-rostr/ims/oneroster/results - Read
Results for a class
Returns a collection of results for a specified ```class_id```.
GET /afe-rostr/ims/oneroster/classes/{class_id}/results - Read
Results for a lineItem for a class
Returns a collection of results for the specified ```class_id``` and ```li_id```.
GET /afe-rostr/ims/oneroster/classes/{class_id}/lineItems/{li_id}/results - Read
Results for a student for a class
Returns a collection of results for a specified ```class_id``` and ```student_id```.
GET /afe-rostr/ims/oneroster/classes/{class_id}/students/{student_id}/results - Read
School by id
Returns a specific school.
GET /afe-rostr/ims/oneroster/schools/{id} - Read
Schools all
Returns a collection of schools.
GET /afe-rostr/ims/oneroster/schools - Read
Student by id
Returns a single student user for the specified ```id```.
GET /afe-rostr/ims/oneroster/students/{id} - Read
Students all
Returns a collection of student user data.
GET /afe-rostr/ims/oneroster/students - Read
Students for class
Returns a collection of student user data for the specified ```class_id```.
GET /afe-rostr/ims/oneroster/classes/{class_id}/students - Read
Students for school
Returns a collection of student user data for the specified ```school_id```.
GET /afe-rostr/ims/oneroster/schools/{school_id}/students - Read
Teacher by id
Returns a single teacher user for the specified ```id```. Roles returned include: Teacher Pending Teacher
GET /afe-rostr/ims/oneroster/teachers/{id} - Read
Teachers all
Returns a collection of teacher user data. Roles returned include: Teacher Pending Teacher
GET /afe-rostr/ims/oneroster/teachers - Read
Teachers for class
Returns a collection of teacher user data for the specified ```class_id```. Roles returned include: Teacher Pending Teacher
GET /afe-rostr/ims/oneroster/classes/{class_id}/teachers - Read
Teachers for school
Returns a collection of teacher user data for the specified ```school_id```. Roles returned include: Teacher Pending Teacher
GET /afe-rostr/ims/oneroster/schools/{school_id}/teachers - Read
Term by id
Returns a specific term.
GET /afe-rostr/ims/oneroster/terms/{id} - Read
Terms all
Returns a collection of terms.
GET /afe-rostr/ims/oneroster/terms - Read
Terms for school
Returns a collection of terms for the specified ```school_id```.
GET /afe-rostr/ims/oneroster/schools/{school_id}/terms - Read
User by id
Returns a single user for the specified ```id```.
GET /afe-rostr/ims/oneroster/users/{id} - Read
Users all
Returns a collection of user data.
GET /afe-rostr/ims/oneroster/users - Write
Category create/update
Returns the category object that was created or updated.
PUT /afe-rostr/ims/oneroster/categories/{id} - Write
LineItem create/update
Returns the lineItem object that was created or updated.
PUT /afe-rostr/ims/oneroster/lineItems/{id} - Write
Result create/update
Returns the result object that was created or updated.
PUT /afe-rostr/ims/oneroster/results/{id} - Destructive
LineItem delete (PREVIEW)
Deletes the specified line item sourcedId. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /afe-rostr/ims/oneroster/lineItems/{id} - Destructive
Result delete
Deletes the specified result sourcedId.
DELETE /afe-rostr/ims/oneroster/results/{id}
Altru Administration
- Read
Get a batch instance
Edit operation for editing a batch header. replaced by batch properties edit operation.
GET /alt-adnmg/batchinstances/{batch_instance_id} - Read
Get a batch template
Edit dataoperation design for adding batch instances
GET /alt-adnmg/batchtemplates/{batch_template_id} - Read
Get a code table entry description by Id
Gets a code table entry description by ID.
GET /alt-adnmg/codetables/{code_table_name}/entryid/{entry_id} - Read
Get a code table sort method
Allows changing the sort method for a code table (alpha or user-defined).
GET /alt-adnmg/codetablesortmethods/{code_table_id} - Read
Get a data form record
Loads an existing record through the Infinity data form identified by form_id. The values map is keyed by the form's field IDs. The returned ts_long is an optimistic-concurrency token to send back on a subsequent update.
GET /alt-adnmg/dataforms/{form_id}/records/{record_id} - Read
Get an application user
Data form used to edit an application user with CMS fields
GET /alt-adnmg/applicationusers/{application_user_id} - Read
Get batch template metadata by batch template ID
Gets batch template metadata by batch template ID.
GET /alt-adnmg/batchtemplatemetadata/{batch_template_id} - Read
Get code table entry Id by description
Gets a code table entry ID by description.
GET /alt-adnmg/codetables/{code_table_name}/entrydescription/{entry_description} - Read
Get data form defaults
Loads the default field values for a new record on the Infinity add data form identified by form_id, without creating a record. Use context_record_id to resolve defaults that depend on a parent record for child forms. The returned values map is keyed by the form's field IDs.
GET /alt-adnmg/dataforms/{form_id}/defaults - Read
Get information about application and SQL CLR versions
Returns the current product version.
GET /alt-adnmg/information - Read
List batch templates
Returns a list of all batch templates
GET /alt-adnmg/batchtemplates/list - Read
List Business Process Statuses
Returns a status list for all business processes. the best practice for calling this endpoint is to include a parameter to ensure that the call can complete and results are returned. note that a parameter is not required but highly recommended. not using a parameter could cause a call to this endpoint not to complete.
GET /alt-adnmg/businessprocessstatus/list - Read
List Business Processes
Returns a list of business process instances.
GET /alt-adnmg/businessprocessinstances/list - Read
List code table entries
Returns table entries for the specified code table.
GET /alt-adnmg/codetables/{code_table_name}/entries - Read
List code tables
List of entries defined for a given code table
GET /alt-adnmg/codetables/{code_table_id}/list - Read
List currencies
Lists all currencies in the system.
GET /alt-adnmg/currencies/list - Read
List system roles
Returns a list of all System roles
GET /alt-adnmg/systemroles/list - Read
Load a data list
Loads an Infinity data list identified by its GUID. The caller supplies the data list ID in the path. Arbitrary additional query-string parameters are passed through as data list filter fields, using the raw Infinity field name and value (no per-field configuration or type conversion). Columns are returned under their raw Infinity field names. Optional context_record_id scopes record-bound lists. Paging is controlled with limit/session_key/start_row_index/more_rows_range_key/infinity_session.
GET /alt-adnmg/datalists/{data_list_id} - Read
Load a search list
Loads an Infinity search list identified by its GUID. The caller supplies the search list ID in the path. Arbitrary additional query-string parameters are passed through as search criteria fields, using the raw Infinity field name and value (no per-field configuration or type conversion). Columns are returned under their raw Infinity field names. Optional context_record_id scopes record-bound searches. Search lists have no session paging; use limit to cap the number of rows returned.
GET /alt-adnmg/searchlists/{search_list_id} - Read
Search for Business Process Parameters
Searches for a specified business process parameter set
GET /alt-adnmg/businessprocessparameterset/search - Read
Search for sites
Search screen for finding a site.
GET /alt-adnmg/sites/search - Read
Simple list load
Gets the data for a simple datalist using ID or Name and any parameters. /appfxwebservice.asmx?op=SimpleDataListLoad, SOAPAction=Blackbaud.AppFx.WebService.API.1/SimpleDataListLoad.
GET /alt-adnmg/simplelists/{simple_list_id} - Read
Simple list translation
/appfxwebservice.asmx?op=SimpleDataListGetTranslation, SOAPAction=Blackbaud.AppFx.WebService.API.1/SimpleDataListGetTranslation.
GET /alt-adnmg/simplelists/translation/{simple_list_id} - Read
View a Business Process
Displays the most recent status information for the given business process parameter set.
GET /alt-adnmg/businessprocess/{business_process_parameter_set_id}/view - Read
View a currency configuration
This view operation loads information necessary for formatting a value as currency.
GET /alt-adnmg/currencies/{currency_id}/currencyconfiguration - Write
Create a batch
Add operation for adding a batch
POST /alt-adnmg/batches - Write
Create a code table entry
Creates a code table entry.
POST /alt-adnmg/codetables/entry/{code_table_name} - Write
Create a data form record
Saves a new record through the Infinity add data form identified by form_id. Field values are supplied in the values map keyed by the form's field IDs; use field_meta to override a field's data type (for example guid) or supply a code-table translation. context_record_id attaches the new record to a parent record for child forms.
POST /alt-adnmg/dataforms/{form_id}/records - Write
Create a notification
Operation for adding notification parameters for altru.
POST /alt-adnmg/notifications - Write
Create a revenue batch row
Add operation for revenue batch records.
POST /alt-adnmg/batches/revenue - Write
Create an application user system role
Data form used to add a system role to an application user from the application user page.
POST /alt-adnmg/appusersystemroles - Write
Edit a batch instance
Edit operation for editing a batch header. replaced by batch properties edit operation.
PATCH /alt-adnmg/batchinstances/{batch_instance_id} - Write
Edit a batch template
Edit dataoperation design for adding batch instances
PATCH /alt-adnmg/batchtemplates/{batch_template_id} - Write
Edit a code table entry
Edit a code table entry.
PATCH /alt-adnmg/codetables/entry/{code_table_name} - Write
Edit an application user
Data form used to edit an application user with CMS fields
PATCH /alt-adnmg/applicationusers/{application_user_id} - Write
Edit third-party authentication application users in bulk
A data form used to add multiple third-party authentication application users to the system.
PATCH /alt-adnmg/applicationusers/thirdpartyauth/bulk - Write
Launch a business process
This operation is used to launch a business process.
POST /alt-adnmg/businessprocess/launch - Write
Perform record operation
Performs an Infinity record operation identified by its GUID on a specific record. The caller must know the record operation ID and record ID.
POST /alt-adnmg/recordoperations/{record_operation_id}/records/{record_id} - Write
Update a data form record
Saves changes to an existing record through the Infinity edit data form identified by form_id. Supply the field values to change in the values map, keyed by the form's field IDs. Include ts_long (the optimistic-concurrency token from a prior GET) so the save can detect a concurrent edit.
PATCH /alt-adnmg/dataforms/{form_id}/records/{record_id} - Destructive
Delete code table entry
Deletes a code table entry.
DELETE /alt-adnmg/codetables/{code_table_name}/codetableentryid/{entry_id}
Altru Analysis
- Read
Get a deferred ad-hoc query execution result
Fetches the result of a deferred ad-hoc query execution using the `deferred_result_key` and `infinity_session` returned by CreateAdHocQueryExecution. Pass `infinity_session` as a query parameter so the poll reaches the same server session that holds the result. While the key is valid this returns 200: `status` is `ready` with the full result set once the query finishes, or `running` while it is still executing (poll again with the same key and session).
GET /alt-anamg/adhocqueries/executions/{id} - Read
Get ad-hoc query ID by name
Gets the query ID for the given query name.
GET /alt-anamg/adhocqueries/id/{query_name} - Read
Get an ad-hoc query definition
Gets the definition of a saved ad-hoc query, including its selected fields, filters, sorts, and metadata.
GET /alt-anamg/AdHocQuery/GetDefinition - Read
List ad-hoc query entries
Gets the results for the given query ID.
GET /alt-anamg/adhocqueries/{query_id} - Write
Execute an ad-hoc query
Runs an ad-hoc query. Provide `adhoc_query_id` to run a saved query, or `query_view_id` plus `select_fields` to run an inline (transient) query — supply exactly one of the two modes. Synchronous by default: returns 200 with `status` = `ready` and the result set. Set `execute_async` = true to run deferred: returns 200 with `status` = `deferred`, a `deferred_result_key`, and an `infinity_session` — poll GetAdHocQueryExecution (passing both back) to fetch the result. A 400 indicates an invalid request.
POST /alt-anamg/adhocqueries/executions - Write
Save an ad-hoc query
Creates or updates a saved ad-hoc query. Omit `id` to create a new query; supply an existing `id` to update it in place. `name`, `query_view_id`, and at least one `select_fields` entry are required; `filter_fields`, `sort_fields`, and `group_filter_fields` refine the definition, and the folder/site/category/data-form IDs and the boolean flags are all optional. Returns the created or updated `adhoc_query_id` together with owner and audit metadata. A 400 indicates an invalid request.
POST /alt-anamg/adhocqueries - Destructive
Cancel a deferred ad-hoc query execution
Requests best-effort cancellation of a deferred ad-hoc query execution using the `deferred_result_key` returned by CreateAdHocQueryExecution. Pass `infinity_session` as a query parameter so the cancel reaches the same server instance running the query. Always returns 200 with `status` = `cancellation_requested`; cancellation is best-effort (a no-op if the query already finished or the key is unknown), so poll GetAdHocQueryExecution to observe `query_was_cancelled`.
DELETE /alt-anamg/adhocqueries/executions/{id}
Altru Constituent
- Read
Get a constituent address
This operation is used to edit an address.
GET /alt-conmg/addresses/{address_id} - Read
Get a constituent alternate lookup id
This operation is used to edit a constituent's alternate lookup id.
GET /alt-conmg/alternatelookupids/{alternate_lookup_id_id} - Read
Get a constituent appeal
Operation for editing a constituent appeal record.
GET /alt-conmg/constituentappeals/{constituent_appeal_id} - Read
Get a constituent appeal response
This operation is used to add and edit constituent appeal responses.
GET /alt-conmg/constituentappealresponses/{constituent_appeal_id} - Read
Get a constituent attribute
Edits an attribute on a constituent record.
GET /alt-conmg/constituentattributes/{constituent_attribute_id} - Read
Get a constituent correspondence code
This operation is for editing constituent correspondence.
GET /alt-conmg/constituentcorrespondencecodes/{constituent_correspondence_id} - Read
Get a constituent correspondence code response
This operation is used to add and edit constituent correspondence responses.
GET /alt-conmg/constituentcorrespondencecodes/{constituent_correspondence_id}/response - Read
Get a constituent email address
This operation is used to edit email addresses.
GET /alt-conmg/emailaddresses/{email_address_id} - Read
Get a constituent fundraiser
This operation is used to edit a fundraiser constituency of a constituent.
GET /alt-conmg/fundraisers/{fundraiser_date_range_id} - Read
Get a constituent interaction
Edit operation for a non-move interaction.
GET /alt-conmg/interactions/{constituent_interaction_id} - Read
Get a constituent phone
This operation is used to edit phone records.
GET /alt-conmg/phones/{phone_id} - Read
Get a constituent solicit code
Edit a constituent solicit code
GET /alt-conmg/solicitcodes/{constituent_solicit_code_id} - Read
Get a Relationship Job Info
This operation is used to edit relationship job inoperationation.
GET /alt-conmg/relationshipjobsinfo/{relationship_job_information_id} - Read
Get a tribute
This operation is used for editing a tribute for a given revenue record.
GET /alt-conmg/tribute/{revenue_tribute_id} - Read
Get an education
Edits educational history.
GET /alt-conmg/educationalhistories/{educational_history_id} - Read
Get an individual
This operation is used to edit biographical inoperationation for an individual.
GET /alt-conmg/individuals/{constituent_id} - Read
Get an organization
Organization constituent edit operation for gift data entry
GET /alt-conmg/organizations/{constituent_id} - Read
List constituent addresses
This operation returns all address contact inoperationation for a constituent.
GET /alt-conmg/constituents/{constituent_id}/addresses - Read
List constituent alternate lookup ids
This operation returns all alternate lookup ids for a constituent.
GET /alt-conmg/constituents/{constituent_id}/alternatelookupids - Read
List constituent appeals
Returns a list of appeals sent to this constituent.
GET /alt-conmg/constituentappeals/{constituent_id}/appeals - Read
List constituent attributes
Returns a list for all attribute values for a constituent.
GET /alt-conmg/constituents/{constituent_id}/constituentattributelist - Read
List constituent duplicate matches
List of constituents matching web operations automatch threshold.
GET /alt-conmg/constituents/constituentduplicatematch - Read
List constituent email addresses
This operation returns all email addresses for a constituent.
GET /alt-conmg/constituents/{constituent_id}/emailaddresses - Read
List constituent fundraisers
Returns a list of all fundraisers
GET /alt-conmg/fundraisers/List - Read
List constituent inactivity reason codes
Returns a list of reason codes.
GET /alt-conmg/constituentinactivityreasoncodes - Read
List constituent memberships
Displays a list of memberships for a given constituent for api only.
GET /alt-conmg/constituent/{constituent_id}/constituentmemberships - Read
List constituent merge configurations
List of available merge configurations that can be used with the constituent merge process
GET /alt-conmg/constituentmergeconfiguration - Read
List constituent phones
This operation returns all phone numbers for a constituent.
GET /alt-conmg/constituents/{constituent_id}/phones - Read
List constituent solicit codes
Constituent solicit code list
GET /alt-conmg/constituents/{constituent_id}/solicitcodes - Read
List contact email addresses
This operation returns all email address contact inoperationation for a constituent.
GET /alt-conmg/constituents/{constituent_id}/contactinformationemailaddress - Read
List contact information phones
This operation returns all phone contact inoperationation for a constituent.
GET /alt-conmg/constituents/{constituent_id}/contactinformationphone - Read
List educations
This operation returns the education history for a constituent.
GET /alt-conmg/constituents/{constituent_id}/educationalhistories - Read
List patron data
Returns all refunds for a patron.
GET /alt-conmg/constituents/{constituent_id}/patrondata - Read
List patron orders
This operation returns orders for a patron.
GET /alt-conmg/constituents/{constituent_id}/patronorders - Read
List Relationship Job Infos
This operation returns a list of all employment history for a constituent.
GET /alt-conmg/constituents/{constituent_id}/relationshipjobsinfo - Read
List states
Lists all states for a given country.
GET /alt-conmg/states/{country_id} - Read
List tributes
Returns a list of tributes where the current constituent is the tributee or the acknowledgee.
GET /alt-conmg/constituents/{constituent_id}/tributes - Read
Search for constituent addresses
This provides the ability to search for a constituent's addresses.
GET /alt-conmg/addresses/search - Read
Search for constituent fundraisers
Search for fundraisers.
GET /alt-conmg/constituents/fundraisersearch - Read
Search for constituents
This provides the ability to search for constituents.
GET /alt-conmg/constituents/search - Read
Search for educations
This search list provides the ability to search for educational history records.
GET /alt-conmg/educationalhistories/search - Read
Search for tributes
Search for tributes.
GET /alt-conmg/tributes/search - Read
View a constituent address
This operation is used for viewing basic address inoperationation.
GET /alt-conmg/addresses/{address_id}/view - Read
View a constituent note
This operation displays a constituent note.
GET /alt-conmg/constituentnotes/{constituent_note_id}/view - Read
View a constituent profile picture
Defines the fields for the individual personal inoperationation tile.
GET /alt-conmg/constituents/{constituent_id}/profilepicture - Read
View a constituent summary profile
This view operation provides a constituent summary profile.
GET /alt-conmg/constituents/{constituent_id}/view - Read
View an individual's recent revenue'
Displays recent revenue inoperationation for an individual.
GET /alt-conmg/individuals/{constituent_id}/recentrevenueview - Read
View an individual's revenue summary
Displays revenue summary inoperationation about an individual.
GET /alt-conmg/individuals/{constituent_id}/revenuesummaryview - Read
View constituent primary contact information
This view operation displays the preferred address, phone, and email inoperationation for a given constituent
GET /alt-conmg/constituents/{constituent_id}/contactview - Write
Create a constituent
This operation is used to add an individual constituent, spouse(optional), and business(optional).
POST /alt-conmg/constituents - Write
Create a constituent address
This operation is used to add an address.
POST /alt-conmg/addresses - Write
Create a constituent alternate lookup id
This operation is used to add an alternate lookup id for a constituent.
POST /alt-conmg/alternatelookupids - Write
Create a constituent appeal
Operation for adding a constituent appeal record.
POST /alt-conmg/constituentappeals - Write
Create a constituent appeal response
Add a constituent appeal response to the system.
POST /alt-conmg/constituentappealresponses - Write
Create a constituent attribute
Adds an attribute to a constituent record.
POST /alt-conmg/constituentattributes - Write
Create a constituent correspondence code
This operation is used to add correspondence record for a constituent.
POST /alt-conmg/constituentcorrespondencecodes - Write
Create a constituent email address
This operation is used to add email addresses.
POST /alt-conmg/emailaddresses - Write
Create a constituent fundraiser
This operation is used to add a fundraiser constituency to a constituent.
POST /alt-conmg/fundraisers - Write
Create a constituent interaction
Add dataoperation for interaction records.
POST /alt-conmg/interactions - Write
Create a constituent note
This operation is used to add a constituent note.
POST /alt-conmg/constituentnotes - Write
Create a constituent phone
This operation is used to add phone records.
POST /alt-conmg/phones - Write
Create a constituent solicit code
Assign a solicit code to a constituent
POST /alt-conmg/solicitcodes - Write
Create a Relationship Job Info
This operation is used to add relationship job inoperationation.
POST /alt-conmg/relationshipjobsinfo - Write
Create a tribute
This operation is used for adding a new tribute to a revenue record.
POST /alt-conmg/tribute - Write
Create an education
Adds a new educational history record to an existing constituent.
POST /alt-conmg/educationalhistories - Write
Create an individual
This operation is used to add an individual constituent, spouse(optional), and business(optional).
POST /alt-conmg/individuals - Write
Create an organization
This operation is used to add organizations, including biographical, constituency and contact inoperationation.
POST /alt-conmg/organizations - Write
Create merge two constituents
This operation lets the user merge two selected constituent records.
POST /alt-conmg/mergetwoconstituents - Write
Edit a constituent address
This operation is used to edit an address.
PATCH /alt-conmg/addresses/{address_id} - Write
Edit a constituent alternate lookup id
This operation is used to edit a constituent's alternate lookup id.
PATCH /alt-conmg/alternatelookupids/{alternate_lookup_id_id} - Write
Edit a constituent appeal
Operation for editing a constituent appeal record.
PATCH /alt-conmg/constituentappeals/{constituent_appeal_id} - Write
Edit a constituent appeal response
This operation is used to add and edit constituent appeal responses.
PATCH /alt-conmg/constituentappealresponses/{constituent_appeal_id} - Write
Edit a constituent attribute
Edits an attribute on a constituent record.
PATCH /alt-conmg/constituentattributes/{constituent_attribute_id} - Write
Edit a constituent correspondence code
This operation is for editing constituent correspondence.
PATCH /alt-conmg/constituentcorrespondencecodes/{constituent_correspondence_id} - Write
Edit a constituent correspondence code response
This operation is used to add and edit constituent correspondence responses.
PATCH /alt-conmg/constituentcorrespondencecodes/{constituent_correspondence_id}/response - Write
Edit a constituent email address
This operation is used to edit email addresses.
PATCH /alt-conmg/emailaddresses/{email_address_id} - Write
Edit a constituent fundraiser
This operation is used to edit a fundraiser constituency of a constituent.
PATCH /alt-conmg/fundraisers/{fundraiser_date_range_id} - Write
Edit a constituent interaction
Edit operation for a non-move interaction.
PATCH /alt-conmg/interactions/{constituent_interaction_id} - Write
Edit a constituent note
This operation is for editing a given constituent's note.
PATCH /alt-conmg/constituentnotes/{constituent_note_id} - Write
Edit a constituent phone
This operation is used to edit phone records.
PATCH /alt-conmg/phones/{phone_id} - Write
Edit a constituent solicit code
Edit a constituent solicit code
PATCH /alt-conmg/solicitcodes/{constituent_solicit_code_id} - Write
Edit a Relationship Job Info
This operation is used to edit relationship job inoperationation.
PATCH /alt-conmg/relationshipjobsinfo/{relationship_job_information_id} - Write
Edit a tribute
This operation is used for editing a tribute for a given revenue record.
PATCH /alt-conmg/tribute/{revenue_tribute_id} - Write
Edit an education
Edits educational history.
PATCH /alt-conmg/educationalhistories/{educational_history_id} - Write
Edit an individual
This operation is used to edit biographical inoperationation for an individual.
PATCH /alt-conmg/individuals/{constituent_id} - Write
Edit an organization
Organization constituent edit operation for gift data entry
PATCH /alt-conmg/organizations/{constituent_id} - Destructive
Delete a constituent
This deletion handles only the basic deletion rules for a constituent.
DELETE /alt-conmg/constituents/{constituent_id} - Destructive
Delete a constituent address
This deletion handles only the basic deletion rules for an address (currently none).
DELETE /alt-conmg/addresses/{address_id} - Destructive
Delete a constituent alternate lookup id
This record operation deletes the specified constituent alternate lookup id record.
DELETE /alt-conmg/alternatelookupids/{alternate_lookup_id_id} - Destructive
Delete a constituent appeal
This delete method handles the basic deletion rules for a constituent appeal.
DELETE /alt-conmg/constituentappeals/{constituent_appeal_id} - Destructive
Delete a constituent attribute
Removes a constituent attribute from the system.
DELETE /alt-conmg/constituentattributes/{constituent_attribute_id} - Destructive
Delete a constituent correspondence code
Delete the specified constituent correspondence record.
DELETE /alt-conmg/constituentcorrespondencecodes/{constituent_correspondence_id} - Destructive
Delete a constituent email address
This deletion handles only the basic deletion rules for an email address (currently none).
DELETE /alt-conmg/emailaddresses/{email_address_id} - Destructive
Delete a constituent fundraiser
This record operation is used to handle the rules of deleting a fundraiser constituency.
DELETE /alt-conmg/fundraisers/{fundraiser_date_range_id} - Destructive
Delete a constituent interaction
This delete method handles the basic deletion rules for a constituent interaction.
DELETE /alt-conmg/interactions/{constituent_interaction_id} - Destructive
Delete a constituent note
This deletion handles only the basic deletion rules for a constituent note (currently none).
DELETE /alt-conmg/constituentnotes/{constituent_note_id} - Destructive
Delete a constituent phone
This deletion handles only the basic deletion rules for a phone (currently none).
DELETE /alt-conmg/phones/{phone_id} - Destructive
Delete a constituent solicit code
This record operation is used to delete the constituent solicit code.
DELETE /alt-conmg/solicitcodes/{constituent_solicit_code_id} - Destructive
Delete a Relationship Job Info
Delete relationship job inoperationation
DELETE /alt-conmg/relationshipjobsinfo/{relationship_job_information_id} - Destructive
Delete a tribute
Deletes a revenue tribute record from the system.
DELETE /alt-conmg/tributes/{revenue_tribute_id} - Destructive
Delete an education
This deletion handles only the basic deletion rules for an educational history (currently none).
DELETE /alt-conmg/educationalhistories/{educational_history_id}
Altru Event
- Read
Get an event
Operation for editing an event record.
GET /alt-evtmg/events/{event_id} - Read
Get an event appeal
Operation for editing event appeals.
GET /alt-evtmg/appeals/{event_id} - Read
Get an event location
Operation for editing an event location record.
GET /alt-evtmg/locations/{event_location_id} - Read
Get an event registrant
Operation used for editing a registrant record.
GET /alt-evtmg/registrants/{registrant_id} - Read
Get an event registration option
Operation for editing a registration option.
GET /alt-evtmg/registrationoptions/{event_price_id} - Read
Get an event registration type
Operation for editing an event registration type.
GET /alt-evtmg/registrationtypes/{event_registration_type_id} - Read
List event appeals
Displays the appeals for the given event.
GET /alt-evtmg/events/{event_id}/appeals - Read
List event prices
Lists all event price lists.
GET /alt-evtmg/eventprices/{event_id} - Read
List event registrants
Displays the registrants for the given event.
GET /alt-evtmg/events/{event_id}/registrants - Read
List event registration options
Displays the registration options for the given event.
GET /alt-evtmg/event/{event_id}/registrationoptions - Read
Location lists
Displays a list of event locations.
GET /alt-evtmg/locations/list - Read
Location search
Search screen for event location records.
GET /alt-evtmg/locations/search - Read
Search for event registrants
Search screen for event registrant records.
GET /alt-evtmg/registrants/search - Read
Search for event registration types
A search list of event registration types
GET /alt-evtmg/registrationtypes/search - Read
Search for events
Search screen for event records.
GET /alt-evtmg/events/search - Read
View a microsite event
Displays microsite details for an event.
GET /alt-evtmg/micrositeevents/{event_id}/view - Read
View an event
Displays summary inoperationation for an event.
GET /alt-evtmg/events/{event_id}/view - Write
Create an event
Operation for adding an event record.
POST /alt-evtmg/events - Write
Create an event registrant
Operation used for adding a registrant record along with guests and registrations.
POST /alt-evtmg/registrants - Write
Create an event registration option
Operation for adding a registration option record.
POST /alt-evtmg/registrationoptions - Write
Create an event registration type
Operation for adding an event registration type record.
POST /alt-evtmg/registrationtypes - Write
Edit a registrant attended status
Updates the attended status to attended for a registrant.
PATCH /alt-evtmg/registrantcheckin/{registrant_id} - Write
Edit an event
Operation for editing an event record.
PATCH /alt-evtmg/events/{event_id} - Write
Edit an event appeal
Operation for editing event appeals.
PATCH /alt-evtmg/appeals/{event_id} - Write
Edit an event location
Operation for editing an event location record.
PATCH /alt-evtmg/locations/{event_location_id} - Write
Edit an event registrant
Operation used for editing a registrant record.
PATCH /alt-evtmg/registrants/{registrant_id} - Write
Edit an event registration option
Operation for editing a registration option.
PATCH /alt-evtmg/registrationoptions/{event_price_id} - Write
Edit an event registration type
Operation for editing an event registration type.
PATCH /alt-evtmg/registrationtypes/{event_registration_type_id} - Write
Location add
Operation for adding an event location record.
POST /alt-evtmg/locations - Destructive
Delete an event
Removes an event from the system.
DELETE /alt-evtmg/events/{event_id} - Destructive
Delete an event registrant
Removes a registrant from the given event.
DELETE /alt-evtmg/registrants/{registrant_id} - Destructive
Delete an event registration option
Removes a registration option from the given event.
DELETE /alt-evtmg/registrationoptions/{event_price_id} - Destructive
Delete an event registration type
Deletes an event registration record.
DELETE /alt-evtmg/registrationtypes/{event_registration_type_id} - Destructive
Location delete
Deletes an event location from the system.
DELETE /alt-evtmg/locations/{event_location_id}
Altru Fundraising
- Read
Get a fundraising purpose recipient
This operation is for editing a given fundraising purpose recipient.
GET /alt-fndmg/fundraisingpurposerecipients/{fundraising_purpose_recipient_id}/view - Read
List designation hierarchies
Returns all of the designation hierarchies.
GET /alt-fndmg/designations/hierarchies/list - Read
List designations
List of all designations.
GET /alt-fndmg/designations/list - Read
List fundraising purpose types
This returns a list of fundraising purpose types.
GET /alt-fndmg/fundraisingpurposetypes - Read
List recurring gift installment histories
A operation of recurring gift installments and activity.
GET /alt-fndmg/recurringgiftinstallmenthistories/{revenue_id}/list - Read
Search for campaigns
Search for campaigns.
GET /alt-fndmg/campaigns/search - Read
Search for designations
Designation Search.
GET /alt-fndmg/designations/search - Read
Search for educational histories
This search list provides the ability to search for educational history records.
GET /alt-fndmg/educationalhistory/search - Read
Search for fundraising purposes
Search screen for finding fundraising purpose records.
GET /alt-fndmg/fundraisingpurposes/search - Write
Create a fundraising purpose
Operation for adding a fundraising purpose record.
POST /alt-fndmg/fundraisingpurposes - Write
Create a fundraising purpose recipient
Operation for adding a recipient for a fundraising purpose.
POST /alt-fndmg/fundraisingpurposerecipients - Write
Edit a fundraising purpose
Operation used for editing a fundraising purpose.
PATCH /alt-fndmg/fundraisingpurposes/{fundraising_purpose_id} - Write
Edit a fundraising purpose recipient
This operation is for editing a given fundraising purpose recipient.
PATCH /alt-fndmg/fundraisingpurposerecipients/{fundraising_purpose_recipient_id} - Destructive
Delete a fundraising purpose
This delete method handles the basic deletion rules for a fundraising purpose.
DELETE /alt-fndmg/fundraisingpurposes/{fundraising_purpose_id} - Destructive
Delete a fundraising purpose recipient
This delete method handles the basic deletion rules for a fundraising purpose recipient.
DELETE /alt-fndmg/fundraisingpurposerecipients/{fundraising_purpose_recipient_id}
Altru Marketing
- Read
Get a correspondence code
This operation is for editing a correspondence code.
GET /alt-mktmg/correspondencecodes/{correspondence_code_id} - Read
Get a marketing appeal
Operation used for editing an appeal.
GET /alt-mktmg/appeals/{appeal_id} - Read
Get a marketing segment
Operation used for editing a segment.
GET /alt-mktmg/segments/{segment_id} - Read
Get a response category
This operation is used to edit response categories.
GET /alt-mktmg/responsecategories/{response_category_id} - Read
List correspondence codes
This operation returns the correspondence code operation.
GET /alt-mktmg/correspondencecodes/list - Read
List marketing appeals
Returns a list of all appeals.
GET /alt-mktmg/appeals/list - Read
List marketing segments
Displays a list of all possible record sources available for use in segmentations and lists.
GET /alt-mktmg/segments/recordsources - Read
List marketing solicit codes
Solicit code list
GET /alt-mktmg/solicitcodes/list - Read
Search for marketing appeals
Search screen for finding appeal records.
GET /alt-mktmg/appeals/search - Read
Search for marketing solicit codes
Search for a solict codes.
GET /alt-mktmg/solicitcodes/search - Write
Create a correspondence code
This operation is used to add a correspondence code.
POST /alt-mktmg/correspondencecodes - Write
Create a marketing appeal
Operation for adding a appeal record.
POST /alt-mktmg/appeals - Write
Create a marketing segment
Adds a segment.
POST /alt-mktmg/segments - Write
Create a response category
This operation is used to add response categories.
POST /alt-mktmg/responsecategories - Write
Edit a correspondence code
This operation is for editing a correspondence code.
PATCH /alt-mktmg/correspondencecodes/{correspondence_code_id} - Write
Edit a marketing appeal
Operation used for editing an appeal.
PATCH /alt-mktmg/appeals/{appeal_id} - Write
Edit a marketing segment
Operation used for editing a segment.
PATCH /alt-mktmg/segments/{segment_id} - Write
Edit a response category
This operation is used to edit response categories.
PATCH /alt-mktmg/responsecategories/{response_category_id} - Destructive
Delete a correspondence code
This deletion handles only the basic deletion rules for a correspondence code (currently none).
DELETE /alt-mktmg/correspondencecodes/{correspondence_code_id} - Destructive
Delete a marketing appeal
This handles the deletion of an appeal.
DELETE /alt-mktmg/appeals/{appeal_id} - Destructive
Delete a marketing segment
Removes a segment from the system.
DELETE /alt-mktmg/segments/{segment_id} - Destructive
Delete a response category
This handles the deletion of a response category.
DELETE /alt-mktmg/responsecategories/{response_category_id}
Altru Prospect
- Read
Get a prospect
Edit operation for setting details on the prospect record.
GET /alt-prsmg/prospects/{constituent_id} - Read
Get a prospect contact report
Edit an existing contact report.
GET /alt-prsmg/prospectcontactreports/{interaction_id} - Read
Get a prospect manager
This operation is used to edit a prospect segmentation.
GET /alt-prsmg/prospectsegmentations/{prospect_segmentation_id} - Read
Get a prospect opportunity
Edits an opportunity.
GET /alt-prsmg/prospectopportunities/{opportunity_id} - Read
Get a prospect plan
Edit dataoperation for a prospect plan.
GET /alt-prsmg/prospectplans/{prospect_plan_id} - Read
Get a stewardship plan
This operation is for editing a given stewardship plan's steward.
GET /alt-prsmg/stewardshipplans/{stewardship_plan_steward_id} - Read
Get a stewardship plan steps
Edit operation for a stewardship plan step for an individual.
GET /alt-prsmg/stewardshipplansteps/{stewardship_plan_step_id} - Read
List prospect contact reports
List of opportunities for a contact report's prospect plan.
GET /alt-prsmg/prospectcontactreports/{interaction_id}/opportunitylist - Read
List prospect managers
This operation returns cell data for a prospect segmentation.
GET /alt-prsmg/prospectsegmentations/{prospect_segmentation_id}/list - Read
List prospect opportunities
List of opportunities for a prospect plan.
GET /alt-prsmg/prospectopportunities/{prospect_plan_id}/list - Read
List prospect plans
List of prospect plans.
GET /alt-prsmg/prospects/{constituent_id}/prospectplans - Read
List prospect steps
List of planned/pending steps for a given plan.
GET /alt-prsmg/prospectsteps/{prospect_plan_id}/plannedlist - Read
List stewardship plan steps
List of pending steps for a given stewardship plan.
GET /alt-prsmg/stewardshipplansteps/{stewardship_plan_id}/list - Read
List stewardship plans
This operation returns all stewardship plans related to a constituent.
GET /alt-prsmg/prospect/{constituent_id}/stewardshipplans - Read
Search for prospect managers
Search for prospects that have been assigned a prospect manager.
GET /alt-prsmg/prospectmanagers/search - Read
Search for prospect opportunities
Search for opportunity
GET /alt-prsmg/prospectopportunities/search - Read
Search for prospects
Search for prospects.
GET /alt-prsmg/prospects/search - Read
Search for stewardship plan steps
Search for stewardship plan steps
GET /alt-prsmg/stewardshipplansteps/search - Read
View a prospect
This view operation provides summary inoperationation about the prospect.
GET /alt-prsmg/prospects/{constituent_id}/view - Read
View a prospect plan
View data form for a prospect plan.
GET /alt-prsmg/prospectplans/{prospect_plan_id}/view - Read
View a prospect status
Defines the fields for the prospects tile.
GET /alt-prsmg/prospects/{constituent_id}/prospectstatus - Write
Create a prospect
Add dataoperation for a prospect.
POST /alt-prsmg/prospects - Write
Create a prospect constituency
This operation is used to add a prospect constituency to a constituent.
POST /alt-prsmg/prospectsconstituency - Write
Create a prospect contact report
Creates and transoperations a step into a contact report.
POST /alt-prsmg/prospectcontactreports - Write
Create a prospect manager
This operation is used to add a prospect segmentation.
POST /alt-prsmg/prospectsegmentations - Write
Create a prospect opportunity
Adds an opportunity to a prospect plan.
POST /alt-prsmg/prospectopportunities - Write
Create a prospect plan
Add dataoperation for a prospect plan.
POST /alt-prsmg/prospectplans - Write
Create a prospect steps
Add dataoperation for step records.
POST /alt-prsmg/prospectsteps - Write
Create a stewardship plan
This operation is used to add a stewardship plan.
POST /alt-prsmg/stewardshipplans - Write
Create a stewardship plan steps
Add operation for a stewardship plan step for an individual.
POST /alt-prsmg/stewardshipplansteps - Write
Edit a prospect
Edit operation for setting details on the prospect record.
PATCH /alt-prsmg/prospects/{constituent_id} - Write
Edit a prospect contact report
Edit an existing contact report.
PATCH /alt-prsmg/prospectcontactreports/{interaction_id} - Write
Edit a prospect manager
This operation is used to edit a prospect segmentation.
PATCH /alt-prsmg/prospectsegmentations/{prospect_segmentation_id} - Write
Edit a prospect opportunity
Edits an opportunity.
PATCH /alt-prsmg/prospectopportunities/{opportunity_id} - Write
Edit a prospect plan
Edit dataoperation for a prospect plan.
PATCH /alt-prsmg/prospectplans/{prospect_plan_id} - Write
Edit a prospect steps
Edit operation for a step.
PATCH /alt-prsmg/prospectsteps/{interaction_id} - Write
Edit a stewardship plan
This operation is for editing a given stewardship plan's steward.
PATCH /alt-prsmg/stewardshipplans/{stewardship_plan_steward_id} - Write
Edit a stewardship plan steps
Edit operation for a stewardship plan step for an individual.
PATCH /alt-prsmg/stewardshipplansteps/{stewardship_plan_step_id} - Destructive
Delete a prospect manager
This record operation is used to delete a prospect segmentation.
DELETE /alt-prsmg/prospectsegmentations/{prospect_segmentation_id} - Destructive
Delete a prospect opportunity
This delete method handles the basic deletion rules for an opportunity.
DELETE /alt-prsmg/prospects/{opportunity_id}/prospectopportunities - Destructive
Delete a prospect plan
This delete method handles the basic deletion rules for a prospect plan.
DELETE /alt-prsmg/prospectplans/{prospect_plan_id} - Destructive
Delete a prospect steps
Deletes a step from a plan.
DELETE /alt-prsmg/prospectsteps/{step_id} - Destructive
Delete a stewardship plan
Deletes a stewardship plan.
DELETE /alt-prsmg/stewardshipplans/{stewardship_plan_id} - Destructive
Delete a stewardship plan steps
Deletes a step from a stewardship plan.
DELETE /alt-prsmg/stewardshipplansteps/{stewardship_plan_step_id}
Altru Revenue
- Read
Get a recurring gift
Edit operation for recurring gift records.
GET /alt-revmg/recurringgifts/{revenue_id} - Read
Get a revenue lookup id
This operation allows for the editing of a revenue record's lookup id.
GET /alt-revmg/revenuelookupids/{revenue_id} - Read
Get a revenue payment
Edits a payment.
GET /alt-revmg/payments/{revenue_id} - Read
List default recognition credits
Returns a list of default recognition credits.
GET /alt-revmg/defaultrecognitioncredits/{constituent_or_acquisition_list_id}/list - Read
List gifts
Returns a list of gifts.
GET /alt-revmg/gifts - Read
Search for revenue
Search for revenue
GET /alt-revmg/revenue/search - Read
Search for revenue payments
Search for a payment.
GET /alt-revmg/payments/search - Read
Search for revenue transactions
Search for transaction
GET /alt-revmg/revenuetransactions/search - Write
Create a recurring gift
Add operation for recurring gifts.
POST /alt-revmg/recurringgifts - Write
Create a revenue note
Adds a note to a revenue record.
POST /alt-revmg/revenuenotes - Write
Create a revenue payment
Adds a payment to the system.
POST /alt-revmg/payments - Write
Edit a recurring gift
Edit operation for recurring gift records.
PATCH /alt-revmg/recurringgifts/{revenue_id} - Write
Edit a recurring gift status
Edit gift status for recurring gift templates.
PATCH /alt-revmg/recurringgiftstatus/{revenue_id} - Write
Edit a revenue lookup id
This operation allows for the editing of a revenue record's lookup id.
PATCH /alt-revmg/revenuelookupids/{revenue_id} - Write
Edit a revenue payment
Edits a payment.
PATCH /alt-revmg/payments/{revenue_id} - Destructive
Delete a revenue payment
Delete a payment that is not associated with a constituent record.
DELETE /alt-revmg/payments/{revenue_id}
Altru Sales
- Read
Get an order delivery information
Edit the delivery/shipping inoperationation on an order
GET /alt-slsmg/orders/{sales_order_id} - Read
List order ticket details
List all generated tickets for an order for print history purposes.
GET /alt-slsmg/sales/{sales_order_id}/orders - Read
List sales order tickets without refunds
Lists all tickets belonging to a sales order, regardless of whether they have been refunded.
GET /alt-slsmg/sales/{sales_order_id}/tickets - Read
View an order patron
Provides inoperationation about a patron that is linked to an order.
GET /alt-slsmg/orders/{sales_order_id}/view - Write
Create a sales order note
This operation is used to add a sales order note.
POST /alt-slsmg/orders - Write
Edit an order delivery information
Edit the delivery/shipping inoperationation on an order
PATCH /alt-slsmg/orders/{sales_order_id}
Altru Volunteer
- Read
Get a job
Edits an existing job.
GET /alt-volmg/jobs/{job_id} - Read
Get a job occurrence
Edits an occurrence of a job.
GET /alt-volmg/occurrences/{job_occurrence_id} - Read
Get a timesheet
Edit a timesheet.
GET /alt-volmg/timesheets/{time_sheet_id} - Read
Get a volunteer
Edit a volunteer
GET /alt-volmg/volunteers/{volunteer_id} - Read
List assignments
This operation returns all assignments for a volunteer on a specified day.
GET /alt-volmg/volunteerassignments/{volunteer_id}/list?day={day} - Read
List jobs
This operation returns all occurrences for a job.
GET /alt-volmg/jobs/{job_id}/list - Read
List timesheets
Lists the timesheets for a volunteer.
GET /alt-volmg/timesheets/{volunteer_id}/list - Read
List volunteer schedules
This operation returns all dates with openings for an occurrence including assignments, used by the job occurrence schedule calendar.
GET /alt-volmg/volunteerschedules/{job_occurrence_id}/list - Read
Search for assignments
This search is for finding constituents who are volunteers but not assigned to a job on a date.
GET /alt-volmg/volunteerassignments/search - Read
Search for job occurrences
This search is for finding job occurrences.
GET /alt-volmg/occurrences/search - Read
Search for jobs
This search is for finding jobs.
GET /alt-volmg/jobs/search - Read
Search for volunteers
This search is for finding constituents who are members of the volunteer.
GET /alt-volmg/volunteers/search - Read
View a job occurrence
Shows basic inoperationation about a job occurrence
GET /alt-volmg/occurrences/{job_occurrence_id}/view - Read
View a volunteer
Shows general inoperationation about a volunteer.
GET /alt-volmg/volunteers/{volunteer_id}/view - Write
Create a job
Adds a new job.
POST /alt-volmg/jobs - Write
Create a job occurrence
Adds an occurrence of a job.
POST /alt-volmg/occurrences - Write
Create a timesheet
Add a timesheet.
POST /alt-volmg/timesheets - Write
Create a volunteer
Add a volunteer
POST /alt-volmg/volunteers - Write
Create a volunteer schedule
Used for assigning volunteers to a given job occurrence.
POST /alt-volmg/volunteerschedules - Write
Create an assignment
Assign job occurrences to a volunteer on a specific day.
POST /alt-volmg/volunteerassignments - Write
Edit a job
Edits an existing job.
PATCH /alt-volmg/jobs/{job_id} - Write
Edit a job occurrence
Edits an occurrence of a job.
PATCH /alt-volmg/occurrences/{job_occurrence_id} - Write
Edit a timesheet
Edit a timesheet.
PATCH /alt-volmg/timesheets/{time_sheet_id} - Write
Edit a volunteer
Edit a volunteer
PATCH /alt-volmg/volunteers/{volunteer_id} - Destructive
Delete a job
Delete a job.
DELETE /alt-volmg/jobs/{job_id} - Destructive
Delete a job occurrence
Delete an occurrence of a job.
DELETE /alt-volmg/occurrences/{job_occurrence_id} - Destructive
Delete a timesheet
Deletes a timesheet from the system.
DELETE /alt-volmg/timesheets/{time_sheet_id} - Destructive
Delete a volunteer
This record operation is used to handle the rules of deleting a volunteer constituency.
DELETE /alt-volmg/volunteers/{volunteer_date_range_id} - Destructive
Delete an assignment
Remove a volunteer from a job.
DELETE /alt-volmg/volunteerassignments/{volunteer_assignment_id}
Consent
- Read
Get consent channel configuration.
Gets the collection of consent channel configuration.
GET /consent/configuration/channels - Read
Get consent defaults.
Gets the default consent statement and privacy policy.
GET /consent/configuration/defaults - Read
Get constituent consent list.
Get a list of constituent consents.
GET /consent/constituents/consents - Read
Get constituent consents.
Get the collection of consents for the specified constituent.
GET /consent/constituents/{constituent_id}/consents - Write
Add channel category.
Add consent configuration for a channel and category.
POST /consent/configuration/channels - Write
Create consents for a single constituent.
Create one or more consents for a single constituent.
POST /consent/constituents/{constituent_id}/consents - Write
Create consents for one or more constituents.
Create one or more consents for one or more constituents.
POST /consent/constituents/consents - Write
Edit channel solicit code assignments.
Edit channel solicit code assignments for the given channel and optional category.
PATCH /consent/configuration/channels/{channel}/solicitcodeassignments - Write
Edit consent channel.
Edit a consent channel.
PATCH /consent/configuration/channels/{channel} - Write
Edit consent defaults.
Edit the default consent statement and/or privacy policy.
PATCH /consent/configuration/defaults - Write
Edit constituent consent.
Edit a constituent consent.
PATCH /consent/constituents/consents/{consent_id} - Write
Get constituent consent list (V2).
Get a list of constituent consents using POST to work around query string length limitations.
POST /consent/constituents/consentlist - Destructive
Delete channel category configuration.
Delete a channel category configuration.
DELETE /consent/configuration/channels/{channel}/categories/{category} - Destructive
Delete constituent consent.
Delete a constituent consent.
DELETE /consent/constituents/consents/{consent_id}
Code Table
- Read
Get a code table (PREVIEW)
Returns details about a code table. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /codetable/v1/codetables/{id} - Read
Get a table entry (PREVIEW)
Returns details about a table entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /codetable/v1/codetables/{code_table_id}/tableentries/{id} - Read
Get code table list (PREVIEW)
Returns a list of code tables. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /codetable/v1/codetables - Read
Get table entries list (PREVIEW)
Returns a list of table entries. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /codetable/v1/codetables/{code_table_id}/tableentries - Write
Create a code table (PREVIEW)
Creates a new code table. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /codetable/v1/codetables - Write
Create a table entry (PREVIEW)
Creates a new table entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /codetable/v1/codetables/{code_table_id}/tableentries - Write
Edit a code table (PREVIEW)
Edit the details about a code table. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /codetable/v1/codetables/{id} - Write
Edit a table entry (PREVIEW)
Edit the details about a table entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /codetable/v1/codetables/{code_table_id}/tableentries/{id} - Destructive
Delete a code table (PREVIEW)
Delete a user defined code table. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /codetable/v1/codetables/{id} - Destructive
Delete a table entry (PREVIEW)
Deletes a table entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /codetable/v1/codetables/{code_table_id}/tableentries/{id}
Communication Preference
- Read
Consent categories
Returns a list of consent categories.
GET /commpref/v1/consent/categories - Read
Consent channel categories
Returns a list of valid consent channel category combinations.
GET /commpref/v1/consent/channelcategories - Read
Consent channels
Returns a list of consent channels.
GET /commpref/v1/consent/channels - Read
Consent sources
Returns a list of consent sources.
GET /commpref/v1/consent/sources - Read
Constituent consent list
Returns a list of constituent consent records.
GET /commpref/v1/constituents/{constituent_id}/consents - Read
Constituent solicit code list (Single constituent)
Returns a list of solicit codes for the specified constituent.
GET /commpref/v1/constituents/{constituent_id}/constituentsolicitcodes - Read
Solicit codes
Returns a list of available solicit code types.
GET /commpref/v1/solicitcodes - Write
Constituent consent (Create)
Creates a consent record for a constituent.
POST /commpref/v1/consent/consents - Write
Constituent solicit code (Create)
Creates a constituent solicit code.
POST /commpref/v1/constituentsolicitcodes - Write
Constituent solicit code (Edit)
Edits a constituent solicit code.
PATCH /commpref/v1/constituentsolicitcodes/{constituent_solicit_code_id} - Destructive
Constituent consent
Deletes a constituent consent record.
DELETE /commpref/v1/consents/{consent_id} - Destructive
Constituent solicit code
Deletes a constituent solicit code.
DELETE /commpref/v1/constituentsolicitcodes/{constituent_solicit_code_id}
CRM Administration
- Read
Get a batch instance
Edit operation for editing a batch header. replaced by batch properties edit operation.
GET /crm-adnmg/batchinstances/{batch_instance_id} - Read
Get a batch template
Edit dataoperation design for adding batch instances
GET /crm-adnmg/batchtemplates/{batch_template_id} - Read
Get a code table entry description by ID
Gets a code table entry description by ID.
GET /crm-adnmg/codetables/{code_table_name}/entryid/{entry_id} - Read
Get a code table sort method
Allows changing the sort method for a code table (alpha or user-defined).
GET /crm-adnmg/codetablesortmethods/{code_table_id} - Read
Get a data form record
Loads an existing record through the Infinity data form identified by form_id. The values map is keyed by the form's field IDs. The returned ts_long is an optimistic-concurrency token to send back on a subsequent update.
GET /crm-adnmg/dataforms/{form_id}/records/{record_id} - Read
Get an application user
Data form used to edit an application user with CMS fields
GET /crm-adnmg/applicationusers/{application_user_id} - Read
Get batch template metadata by batch template ID
Gets batch template metadata by batch template ID.
GET /crm-adnmg/batchtemplatemetadata/{batch_template_id} - Read
Get code table entry ID by description
Gets a code table entry ID by description.
GET /crm-adnmg/codetables/{code_table_name}/entrydescription/{entry_description} - Read
Get data form defaults
Loads the default field values for a new record on the Infinity add data form identified by form_id, without creating a record. Use context_record_id to resolve defaults that depend on a parent record for child forms. The returned values map is keyed by the form's field IDs.
GET /crm-adnmg/dataforms/{form_id}/defaults - Read
Get information about application and SQL CLR versions
Returns the current product version.
GET /crm-adnmg/information - Read
List batch templates
Returns a list of all batch templates
GET /crm-adnmg/batchtemplates/list - Read
List Business Process Statuses
Returns a status list for all business processes. the best practice for calling this endpoint is to include a parameter to ensure that the call can complete and results are returned. note that a parameter is not required but highly recommended. not using a parameter could cause a call to this endpoint not to complete.
GET /crm-adnmg/businessprocessstatus/list - Read
List Business Processes
Returns a list of business process instances.
GET /crm-adnmg/businessprocessinstances/list - Read
List code table entries
Returns table entries for the specified code table.
GET /crm-adnmg/codetables/{code_table_name}/entries - Read
List code tables
List of entries defined for a given code table
GET /crm-adnmg/codetables/{code_table_id}/list - Read
List currencies
Lists all currencies in the system.
GET /crm-adnmg/currencies/list - Read
List system roles
Returns a list of all System roles
GET /crm-adnmg/systemroles/list - Read
Load a data list
Loads an Infinity data list identified by its GUID. The caller supplies the data list ID in the path. Arbitrary additional query-string parameters are passed through as data list filter fields, using the raw Infinity field name and value (no per-field configuration or type conversion). Columns are returned under their raw Infinity field names. Optional context_record_id scopes record-bound lists. Paging is controlled with limit/session_key/start_row_index/more_rows_range_key/infinity_session.
GET /crm-adnmg/datalists/{data_list_id} - Read
Load a search list
Loads an Infinity search list identified by its GUID. The caller supplies the search list ID in the path. Arbitrary additional query-string parameters are passed through as search criteria fields, using the raw Infinity field name and value (no per-field configuration or type conversion). Columns are returned under their raw Infinity field names. Optional context_record_id scopes record-bound searches. Search lists have no session paging; use limit to cap the number of rows returned.
GET /crm-adnmg/searchlists/{search_list_id} - Read
Search for Business Process Parameters
Searches for a specified business process parameter set
GET /crm-adnmg/businessprocessparameterset/search - Read
Search for sites
Search screen for finding a site.
GET /crm-adnmg/sites/search - Read
Simple list load
Gets the data for a simple datalist using ID or Name and any parameters. /appfxwebservice.asmx?op=SimpleDataListLoad, SOAPAction=Blackbaud.AppFx.WebService.API.1/SimpleDataListLoad.
GET /crm-adnmg/simplelists/{simple_list_id} - Read
Simple list translation
/appfxwebservice.asmx?op=SimpleDataListGetTranslation, SOAPAction=Blackbaud.AppFx.WebService.API.1/SimpleDataListGetTranslation.
GET /crm-adnmg/simplelists/translation/{simple_list_id} - Read
View a Business Process
Displays the most recent status information for the given business process parameter set.
GET /crm-adnmg/businessprocess/{business_process_parameter_set_id}/view - Read
View a currency configuration
This view operation loads information necessary for formatting a value as currency.
GET /crm-adnmg/currencies/{currency_id}/currencyconfiguration - Write
Create a batch
Add operation for adding a batch
POST /crm-adnmg/batches - Write
Create a code table entry
Creates a code table entry.
POST /crm-adnmg/codetables/entry/{code_table_name} - Write
Create a data form record
Saves a new record through the Infinity add data form identified by form_id. Field values are supplied in the values map keyed by the form's field IDs; use field_meta to override a field's data type (for example guid) or supply a code-table translation. context_record_id attaches the new record to a parent record for child forms.
POST /crm-adnmg/dataforms/{form_id}/records - Write
Create a notification
Operation for adding notification parameters.
POST /crm-adnmg/notifications - Write
Create a revenue batch row
Add operation for revenue batch records.
POST /crm-adnmg/batches/revenue - Write
Create an application user system role
Data form used to add a system role to an application user from the application user page.
POST /crm-adnmg/appusersystemroles - Write
Edit a batch instance
Edit operation for editing a batch header. replaced by batch properties edit operation.
PATCH /crm-adnmg/batchinstances/{batch_instance_id} - Write
Edit a batch template
Edit dataoperation design for adding batch instances
PATCH /crm-adnmg/batchtemplates/{batch_template_id} - Write
Edit a code table entry
Edit a code table entry.
PATCH /crm-adnmg/codetables/entry/{code_table_name} - Write
Edit an application user
Data form used to edit an application user with CMS fields
PATCH /crm-adnmg/applicationusers/{application_user_id} - Write
Edit third-party authentication application users in bulk
A data form used to add multiple third-party authentication application users to the system.
PATCH /crm-adnmg/applicationusers/thirdpartyauth/bulk - Write
Launch a business process
This operation is used to launch a business process.
POST /crm-adnmg/businessprocess/launch - Write
Perform record operation
Performs an Infinity record operation identified by its GUID on a specific record. The caller must know the record operation ID and record ID.
POST /crm-adnmg/recordoperations/{record_operation_id}/records/{record_id} - Write
Update a data form record
Saves changes to an existing record through the Infinity edit data form identified by form_id. Supply the field values to change in the values map, keyed by the form's field IDs. Include ts_long (the optimistic-concurrency token from a prior GET) so the save can detect a concurrent edit.
PATCH /crm-adnmg/dataforms/{form_id}/records/{record_id} - Destructive
Delete code table entry
Deletes a code table entry.
DELETE /crm-adnmg/codetables/{code_table_name}/codetableentryid/{entry_id}
CRM Analysis
- Read
Get a deferred ad-hoc query execution result
Fetches the result of a deferred ad-hoc query execution using the `deferred_result_key` and `infinity_session` returned by CreateAdHocQueryExecution. Pass `infinity_session` as a query parameter so the poll reaches the same server session that holds the result. While the key is valid this returns 200: `status` is `ready` with the full result set once the query finishes, or `running` while it is still executing (poll again with the same key and session).
GET /crm-anamg/adhocqueries/executions/{id} - Read
Get ad-hoc query ID by name
Gets the query ID for the given query name.
GET /crm-anamg/adhocqueries/id/{query_name} - Read
Get an ad-hoc query definition
Gets the definition of a saved ad-hoc query, including its selected fields, filters, sorts, and metadata.
GET /crm-anamg/AdHocQuery/GetDefinition - Read
List ad-hoc query entries
Gets the results for the given query ID.
GET /crm-anamg/adhocqueries/{query_id} - Write
Execute an ad-hoc query
Runs an ad-hoc query. Provide `adhoc_query_id` to run a saved query, or `query_view_id` plus `select_fields` to run an inline (transient) query — supply exactly one of the two modes. Synchronous by default: returns 200 with `status` = `ready` and the result set. Set `execute_async` = true to run deferred: returns 200 with `status` = `deferred`, a `deferred_result_key`, and an `infinity_session` — poll GetAdHocQueryExecution (passing both back) to fetch the result. A 400 indicates an invalid request.
POST /crm-anamg/adhocqueries/executions - Write
Save an ad-hoc query
Creates or updates a saved ad-hoc query. Omit `id` to create a new query; supply an existing `id` to update it in place. `name`, `query_view_id`, and at least one `select_fields` entry are required; `filter_fields`, `sort_fields`, and `group_filter_fields` refine the definition, and the folder/site/category/data-form IDs and the boolean flags are all optional. Returns the created or updated `adhoc_query_id` together with owner and audit metadata. A 400 indicates an invalid request.
POST /crm-anamg/adhocqueries - Destructive
Cancel a deferred ad-hoc query execution
Requests best-effort cancellation of a deferred ad-hoc query execution using the `deferred_result_key` returned by CreateAdHocQueryExecution. Pass `infinity_session` as a query parameter so the cancel reaches the same server instance running the query. Always returns 200 with `status` = `cancellation_requested`; cancellation is best-effort (a no-op if the query already finished or the key is unknown), so poll GetAdHocQueryExecution to observe `query_was_cancelled`.
DELETE /crm-anamg/adhocqueries/executions/{id}
CRM Constituent
- Read
Get a constituent address
This operation is used to edit an address.
GET /crm-conmg/addresses/{address_id} - Read
Get a constituent alternate lookup id
This operation is used to edit a constituent's alternate lookup id.
GET /crm-conmg/alternatelookupids/{alternate_lookup_id_id} - Read
Get a constituent appeal
Operation for editing a constituent appeal record.
GET /crm-conmg/constituentappeals/{constituent_appeal_id} - Read
Get a constituent appeal response
This operation is used to add and edit constituent appeal responses.
GET /crm-conmg/constituentappealresponses/{constituent_appeal_id} - Read
Get a constituent attribute
Edits an attribute on a constituent record.
GET /crm-conmg/constituentattributes/{constituent_attribute_id} - Read
Get a constituent correspondence code
This operation is for editing constituent correspondence.
GET /crm-conmg/constituentcorrespondencecodes/{constituent_correspondence_id} - Read
Get a constituent correspondence code response
This operation is used to add and edit constituent correspondence responses.
GET /crm-conmg/constituentcorrespondencecodes/{constituent_correspondence_id}/response - Read
Get a constituent email address
This operation is used to edit email addresses.
GET /crm-conmg/emailaddresses/{email_address_id} - Read
Get a constituent fundraiser
This operation is used to edit a fundraiser constituency of a constituent.
GET /crm-conmg/fundraisers/{fundraiser_date_range_id} - Read
Get a constituent interaction
Edit operation for a non-move interaction.
GET /crm-conmg/interactions/{constituent_interaction_id} - Read
Get a constituent phone
This operation is used to edit phone records.
GET /crm-conmg/phones/{phone_id} - Read
Get a constituent solicit code
Edit a constituent solicit code
GET /crm-conmg/solicitcodes/{constituent_solicit_code_id} - Read
Get a Relationship Job Info
This operation is used to edit relationship job inoperationation.
GET /crm-conmg/relationshipjobsinfo/{relationship_job_information_id} - Read
Get a tribute
This operation is used for editing a tribute for a given revenue record.
GET /crm-conmg/tribute/{revenue_tribute_id} - Read
Get an education
Edits educational history.
GET /crm-conmg/educationalhistories/{educational_history_id} - Read
Get an individual
This operation is used to edit biographical inoperationation for an individual.
GET /crm-conmg/individuals/{constituent_id} - Read
Get an organization
Organization constituent edit operation for gift data entry
GET /crm-conmg/organizations/{constituent_id} - Read
List constituent addresses
This operation returns all address contact inoperationation for a constituent.
GET /crm-conmg/constituents/{constituent_id}/addresses - Read
List constituent alternate lookup ids
This operation returns all alternate lookup ids for a constituent.
GET /crm-conmg/constituents/{constituent_id}/alternatelookupids - Read
List constituent appeals
Returns a list of appeals sent to this constituent.
GET /crm-conmg/constituentappeals/{constituent_id}/appeals - Read
List constituent attributes
Returns a list for all attribute values for a constituent.
GET /crm-conmg/constituents/{constituent_id}/constituentattributelist - Read
List constituent duplicate matches
List of constituents matching web operations automatch threshold.
GET /crm-conmg/constituents/constituentduplicatematch - Read
List constituent email addresses
This operation returns all email addresses for a constituent.
GET /crm-conmg/constituents/{constituent_id}/emailaddresses - Read
List constituent fundraisers
Returns a list of all fundraisers
GET /crm-conmg/fundraisers/List - Read
List constituent inactivity reason codes
Returns a list of reason codes.
GET /crm-conmg/constituentinactivityreasoncodes - Read
List constituent memberships
Displays a list of memberships for a given constituent for api only.
GET /crm-conmg/constituent/{constituent_id}/constituentmemberships - Read
List constituent merge configurations
List of available merge configurations that can be used with the constituent merge process
GET /crm-conmg/constituentmergeconfiguration - Read
List constituent phones
This operation returns all phone numbers for a constituent.
GET /crm-conmg/constituents/{constituent_id}/phones - Read
List constituent solicit codes
Constituent solicit code list
GET /crm-conmg/constituents/{constituent_id}/solicitcodes - Read
List contact email addresses
This operation returns all email address contact inoperationation for a constituent.
GET /crm-conmg/constituents/{constituent_id}/contactinformationemailaddress - Read
List contact information phones
This operation returns all phone contact inoperationation for a constituent.
GET /crm-conmg/constituents/{constituent_id}/contactinformationphone - Read
List educations
This operation returns the education history for a constituent.
GET /crm-conmg/constituents/{constituent_id}/educationalhistories - Read
List patron data
Returns all refunds for a patron.
GET /crm-conmg/constituents/{constituent_id}/patrondata - Read
List patron orders
This operation returns orders for a patron.
GET /crm-conmg/constituents/{constituent_id}/patronorders - Read
List Relationship Job Infos
This operation returns a list of all employment history for a constituent.
GET /crm-conmg/constituents/{constituent_id}/relationshipjobsinfo - Read
List states
Lists all states for a given country.
GET /crm-conmg/states/{country_id} - Read
List tributes
Returns a list of tributes where the current constituent is the tributee or the acknowledgee.
GET /crm-conmg/constituents/{constituent_id}/tributes - Read
Search for constituent addresses
This provides the ability to search for a constituent's addresses.
GET /crm-conmg/addresses/search - Read
Search for constituent fundraisers
Search for fundraisers.
GET /crm-conmg/constituents/fundraisersearch - Read
Search for constituents
This provides the ability to search for constituents.
GET /crm-conmg/constituents/search - Read
Search for educations
This search list provides the ability to search for educational history records.
GET /crm-conmg/educationalhistories/search - Read
Search for tributes
Search for tributes.
GET /crm-conmg/tributes/search - Read
View a constituent address
This operation is used for viewing basic address inoperationation.
GET /crm-conmg/addresses/{address_id}/view - Read
View a constituent note
This operation displays a constituent note.
GET /crm-conmg/constituentnotes/{constituent_note_id}/view - Read
View a constituent profile picture
Defines the fields for the individual personal inoperationation tile.
GET /crm-conmg/constituents/{constituent_id}/profilepicture - Read
View a constituent summary profile
This view operation provides a constituent summary profile.
GET /crm-conmg/constituents/{constituent_id}/view - Read
View an individual's recent revenue'
Displays recent revenue inoperationation for an individual.
GET /crm-conmg/individuals/{constituent_id}/recentrevenueview - Read
View an individual's revenue summary
Displays revenue summary inoperationation about an individual.
GET /crm-conmg/individuals/{constituent_id}/revenuesummaryview - Read
View constituent primary contact information
This view operation displays the preferred address, phone, and email inoperationation for a given constituent
GET /crm-conmg/constituents/{constituent_id}/contactview - Write
Create a constituent
This operation is used to add an individual constituent, spouse(optional), and business(optional).
POST /crm-conmg/constituents - Write
Create a constituent address
This operation is used to add an address.
POST /crm-conmg/addresses - Write
Create a constituent alternate lookup id
This operation is used to add an alternate lookup id for a constituent.
POST /crm-conmg/alternatelookupids - Write
Create a constituent appeal
Operation for adding a constituent appeal record.
POST /crm-conmg/constituentappeals - Write
Create a constituent appeal response
Add a constituent appeal response to the system.
POST /crm-conmg/constituentappealresponses - Write
Create a constituent attribute
Adds an attribute to a constituent record.
POST /crm-conmg/constituentattributes - Write
Create a constituent correspondence code
This operation is used to add correspondence record for a constituent.
POST /crm-conmg/constituentcorrespondencecodes - Write
Create a constituent email address
This operation is used to add email addresses.
POST /crm-conmg/emailaddresses - Write
Create a constituent fundraiser
This operation is used to add a fundraiser constituency to a constituent.
POST /crm-conmg/fundraisers - Write
Create a constituent interaction
Add dataoperation for interaction records.
POST /crm-conmg/interactions - Write
Create a constituent note
This operation is used to add a constituent note.
POST /crm-conmg/constituentnotes - Write
Create a constituent phone
This operation is used to add phone records.
POST /crm-conmg/phones - Write
Create a constituent solicit code
Assign a solicit code to a constituent
POST /crm-conmg/solicitcodes - Write
Create a Relationship Job Info
This operation is used to add relationship job inoperationation.
POST /crm-conmg/relationshipjobsinfo - Write
Create a tribute
This operation is used for adding a new tribute to a revenue record.
POST /crm-conmg/tribute - Write
Create an education
Adds a new educational history record to an existing constituent.
POST /crm-conmg/educationalhistories - Write
Create an individual
This operation is used to add an individual constituent, spouse(optional), and business(optional).
POST /crm-conmg/individuals - Write
Create an organization
This operation is used to add organizations, including biographical, constituency and contact inoperationation.
POST /crm-conmg/organizations - Write
Create merge two constituents
This operation lets the user merge two selected constituent records.
POST /crm-conmg/mergetwoconstituents - Write
Edit a constituent address
This operation is used to edit an address.
PATCH /crm-conmg/addresses/{address_id} - Write
Edit a constituent alternate lookup id
This operation is used to edit a constituent's alternate lookup id.
PATCH /crm-conmg/alternatelookupids/{alternate_lookup_id_id} - Write
Edit a constituent appeal
Operation for editing a constituent appeal record.
PATCH /crm-conmg/constituentappeals/{constituent_appeal_id} - Write
Edit a constituent appeal response
This operation is used to add and edit constituent appeal responses.
PATCH /crm-conmg/constituentappealresponses/{constituent_appeal_id} - Write
Edit a constituent attribute
Edits an attribute on a constituent record.
PATCH /crm-conmg/constituentattributes/{constituent_attribute_id} - Write
Edit a constituent correspondence code
This operation is for editing constituent correspondence.
PATCH /crm-conmg/constituentcorrespondencecodes/{constituent_correspondence_id} - Write
Edit a constituent correspondence code response
This operation is used to add and edit constituent correspondence responses.
PATCH /crm-conmg/constituentcorrespondencecodes/{constituent_correspondence_id}/response - Write
Edit a constituent email address
This operation is used to edit email addresses.
PATCH /crm-conmg/emailaddresses/{email_address_id} - Write
Edit a constituent fundraiser
This operation is used to edit a fundraiser constituency of a constituent.
PATCH /crm-conmg/fundraisers/{fundraiser_date_range_id} - Write
Edit a constituent interaction
Edit operation for a non-move interaction.
PATCH /crm-conmg/interactions/{constituent_interaction_id} - Write
Edit a constituent note
This operation is for editing a given constituent's note.
PATCH /crm-conmg/constituentnotes/{constituent_note_id} - Write
Edit a constituent phone
This operation is used to edit phone records.
PATCH /crm-conmg/phones/{phone_id} - Write
Edit a constituent solicit code
Edit a constituent solicit code
PATCH /crm-conmg/solicitcodes/{constituent_solicit_code_id} - Write
Edit a Relationship Job Info
This operation is used to edit relationship job inoperationation.
PATCH /crm-conmg/relationshipjobsinfo/{relationship_job_information_id} - Write
Edit a tribute
This operation is used for editing a tribute for a given revenue record.
PATCH /crm-conmg/tribute/{revenue_tribute_id} - Write
Edit an education
Edits educational history.
PATCH /crm-conmg/educationalhistories/{educational_history_id} - Write
Edit an individual
This operation is used to edit biographical inoperationation for an individual.
PATCH /crm-conmg/individuals/{constituent_id} - Write
Edit an organization
Organization constituent edit operation for gift data entry
PATCH /crm-conmg/organizations/{constituent_id} - Destructive
Delete a constituent
This deletion handles only the basic deletion rules for a constituent.
DELETE /crm-conmg/constituents/{constituent_id} - Destructive
Delete a constituent address
This deletion handles only the basic deletion rules for an address (currently none).
DELETE /crm-conmg/addresses/{address_id} - Destructive
Delete a constituent alternate lookup id
This record operation deletes the specified constituent alternate lookup id record.
DELETE /crm-conmg/alternatelookupids/{alternate_lookup_id_id} - Destructive
Delete a constituent appeal
This delete method handles the basic deletion rules for a constituent appeal.
DELETE /crm-conmg/constituentappeals/{constituent_appeal_id} - Destructive
Delete a constituent attribute
Removes a constituent attribute from the system.
DELETE /crm-conmg/constituentattributes/{constituent_attribute_id} - Destructive
Delete a constituent correspondence code
Delete the specified constituent correspondence record.
DELETE /crm-conmg/constituentcorrespondencecodes/{constituent_correspondence_id} - Destructive
Delete a constituent email address
This deletion handles only the basic deletion rules for an email address (currently none).
DELETE /crm-conmg/emailaddresses/{email_address_id} - Destructive
Delete a constituent fundraiser
This record operation is used to handle the rules of deleting a fundraiser constituency.
DELETE /crm-conmg/fundraisers/{fundraiser_date_range_id} - Destructive
Delete a constituent interaction
This delete method handles the basic deletion rules for a constituent interaction.
DELETE /crm-conmg/interactions/{constituent_interaction_id} - Destructive
Delete a constituent note
This deletion handles only the basic deletion rules for a constituent note (currently none).
DELETE /crm-conmg/constituentnotes/{constituent_note_id} - Destructive
Delete a constituent phone
This deletion handles only the basic deletion rules for a phone (currently none).
DELETE /crm-conmg/phones/{phone_id} - Destructive
Delete a constituent solicit code
This record operation is used to delete the constituent solicit code.
DELETE /crm-conmg/solicitcodes/{constituent_solicit_code_id} - Destructive
Delete a Relationship Job Info
Delete relationship job inoperationation
DELETE /crm-conmg/relationshipjobsinfo/{relationship_job_information_id} - Destructive
Delete a tribute
Deletes a revenue tribute record from the system.
DELETE /crm-conmg/tributes/{revenue_tribute_id} - Destructive
Delete an education
This deletion handles only the basic deletion rules for an educational history (currently none).
DELETE /crm-conmg/educationalhistories/{educational_history_id}
CRM Event
- Read
Get an event
Operation for editing an event record.
GET /crm-evtmg/events/{event_id} - Read
Get an event appeal
Operation for editing event appeals.
GET /crm-evtmg/appeals/{event_id} - Read
Get an event location
Operation for editing an event location record.
GET /crm-evtmg/locations/{event_location_id} - Read
Get an event registrant
Operation used for editing a registrant record.
GET /crm-evtmg/registrants/{registrant_id} - Read
Get an event registration option
Operation for editing a registration option.
GET /crm-evtmg/registrationoptions/{event_price_id} - Read
Get an event registration type
Operation for editing an event registration type.
GET /crm-evtmg/registrationtypes/{event_registration_type_id} - Read
List event appeals
Displays the appeals for the given event.
GET /crm-evtmg/events/{event_id}/appeals - Read
List event prices
Lists all event price lists.
GET /crm-evtmg/eventprices/{event_id} - Read
List event registrants
Displays the registrants for the given event.
GET /crm-evtmg/events/{event_id}/registrants - Read
List event registration options
Displays the registration options for the given event.
GET /crm-evtmg/event/{event_id}/registrationoptions - Read
Location lists
Displays a list of event locations.
GET /crm-evtmg/locations/list - Read
Location search
Search screen for event location records.
GET /crm-evtmg/locations/search - Read
Search for event registrants
Search screen for event registrant records.
GET /crm-evtmg/registrants/search - Read
Search for event registration types
A search list of event registration types
GET /crm-evtmg/registrationtypes/search - Read
Search for events
Search screen for event records.
GET /crm-evtmg/events/search - Read
View a microsite event
Displays microsite details for an event.
GET /crm-evtmg/micrositeevents/{event_id}/view - Read
View an event
Displays summary inoperationation for an event.
GET /crm-evtmg/events/{event_id}/view - Write
Create an event
Operation for adding an event record.
POST /crm-evtmg/events - Write
Create an event registrant
Operation used for adding a registrant record along with guests and registrations.
POST /crm-evtmg/registrants - Write
Create an event registration option
Operation for adding a registration option record.
POST /crm-evtmg/registrationoptions - Write
Create an event registration type
Operation for adding an event registration type record.
POST /crm-evtmg/registrationtypes - Write
Edit a registrant attended status
Updates the attended status to attended for a registrant.
PATCH /crm-evtmg/registrantcheckin/{registrant_id} - Write
Edit an event
Operation for editing an event record.
PATCH /crm-evtmg/events/{event_id} - Write
Edit an event appeal
Operation for editing event appeals.
PATCH /crm-evtmg/appeals/{event_id} - Write
Edit an event location
Operation for editing an event location record.
PATCH /crm-evtmg/locations/{event_location_id} - Write
Edit an event registrant
Operation used for editing a registrant record.
PATCH /crm-evtmg/registrants/{registrant_id} - Write
Edit an event registration option
Operation for editing a registration option.
PATCH /crm-evtmg/registrationoptions/{event_price_id} - Write
Edit an event registration type
Operation for editing an event registration type.
PATCH /crm-evtmg/registrationtypes/{event_registration_type_id} - Write
Location add
Operation for adding an event location record.
POST /crm-evtmg/locations - Destructive
Delete an event
Removes an event from the system.
DELETE /crm-evtmg/events/{event_id} - Destructive
Delete an event registrant
Removes a registrant from the given event.
DELETE /crm-evtmg/registrants/{registrant_id} - Destructive
Delete an event registration option
Removes a registration option from the given event.
DELETE /crm-evtmg/registrationoptions/{event_price_id} - Destructive
Delete an event registration type
Deletes an event registration record.
DELETE /crm-evtmg/registrationtypes/{event_registration_type_id} - Destructive
Location delete
Deletes an event location from the system.
DELETE /crm-evtmg/locations/{event_location_id}
CRM Fundraising
- Read
Get a fundraising purpose recipient
This operation is for editing a given fundraising purpose recipient.
GET /crm-fndmg/fundraisingpurposerecipients/{fundraising_purpose_recipient_id}/view - Read
List designation hierarchies
Returns all of the designation hierarchies.
GET /crm-fndmg/designations/hierarchies/list - Read
List designations
List of all designations.
GET /crm-fndmg/designations/list - Read
List fundraising purpose types
This returns a list of fundraising purpose types.
GET /crm-fndmg/fundraisingpurposetypes - Read
List recurring gift installment histories
A operation of recurring gift installments and activity.
GET /crm-fndmg/recurringgiftinstallmenthistories/{revenue_id}/list - Read
Search for educational histories
This search list provides the ability to search for educational history records.
GET /crm-fndmg/educationalhistory/search - Read
Search for fundraising purpose recipients
Search for a fundraising purpose recipient.
GET /crm-fndmg/fundraisingpurposerecipients/search - Read
Search for fundraising purposes
Search screen for finding fundraising purpose records.
GET /crm-fndmg/fundraisingpurposes/search - Write
Create a fundraising purpose
Operation for adding a fundraising purpose record.
POST /crm-fndmg/fundraisingpurposes - Write
Create a fundraising purpose recipient
Operation for adding a recipient for a fundraising purpose.
POST /crm-fndmg/fundraisingpurposerecipients - Write
Edit a fundraising purpose
Operation used for editing a fundraising purpose.
PATCH /crm-fndmg/fundraisingpurposes/{fundraising_purpose_id} - Write
Edit a fundraising purpose recipient
This operation is for editing a given fundraising purpose recipient.
PATCH /crm-fndmg/fundraisingpurposerecipients/{fundraising_purpose_recipient_id} - Destructive
Delete a fundraising purpose
This delete method handles the basic deletion rules for a fundraising purpose.
DELETE /crm-fndmg/fundraisingpurposes/{fundraising_purpose_id} - Destructive
Delete a fundraising purpose recipient
This delete method handles the basic deletion rules for a fundraising purpose recipient.
DELETE /crm-fndmg/fundraisingpurposerecipients/{fundraising_purpose_recipient_id}
CRM Marketing
- Read
Get a correspondence code
This operation is for editing a correspondence code.
GET /crm-mktmg/correspondencecodes/{correspondence_code_id} - Read
Get a marketing appeal
Operation used for editing an appeal.
GET /crm-mktmg/appeals/{appeal_id} - Read
Get a marketing segment
Operation used for editing a segment.
GET /crm-mktmg/segments/{segment_id} - Read
Get a response category
This operation is used to edit response categories.
GET /crm-mktmg/responsecategories/{response_category_id} - Read
List correspondence codes
This operation returns the correspondence code operation.
GET /crm-mktmg/correspondencecodes/list - Read
List marketing appeals
Returns a list of all appeals.
GET /crm-mktmg/appeals/list - Read
List marketing segments
Displays a list of all possible record sources available for use in segmentations and lists.
GET /crm-mktmg/segments/recordsources - Read
List marketing solicit codes
Solicit code list
GET /crm-mktmg/solicitcodes/list - Read
Search for marketing appeals
Search screen for finding appeal records.
GET /crm-mktmg/appeals/search - Read
Search for marketing solicit codes
Search for a solict codes.
GET /crm-mktmg/solicitcodes/search - Write
Create a correspondence code
This operation is used to add a correspondence code.
POST /crm-mktmg/correspondencecodes - Write
Create a marketing appeal
Operation for adding a appeal record.
POST /crm-mktmg/appeals - Write
Create a marketing segment
Adds a segment.
POST /crm-mktmg/segments - Write
Create a response category
This operation is used to add response categories.
POST /crm-mktmg/responsecategories - Write
Edit a correspondence code
This operation is for editing a correspondence code.
PATCH /crm-mktmg/correspondencecodes/{correspondence_code_id} - Write
Edit a marketing appeal
Operation used for editing an appeal.
PATCH /crm-mktmg/appeals/{appeal_id} - Write
Edit a marketing segment
Operation used for editing a segment.
PATCH /crm-mktmg/segments/{segment_id} - Write
Edit a response category
This operation is used to edit response categories.
PATCH /crm-mktmg/responsecategories/{response_category_id} - Destructive
Delete a correspondence code
This deletion handles only the basic deletion rules for a correspondence code (currently none).
DELETE /crm-mktmg/correspondencecodes/{correspondence_code_id} - Destructive
Delete a marketing appeal
This handles the deletion of an appeal.
DELETE /crm-mktmg/appeals/{appeal_id} - Destructive
Delete a marketing segment
Removes a segment from the system.
DELETE /crm-mktmg/segments/{segment_id} - Destructive
Delete a response category
This handles the deletion of a response category.
DELETE /crm-mktmg/responsecategories/{response_category_id}
CRM Prospect
- Read
Get a prospect
Edit operation for setting details on the prospect record.
GET /crm-prsmg/prospects/{constituent_id} - Read
Get a prospect contact report
Edit an existing contact report.
GET /crm-prsmg/prospectcontactreports/{interaction_id} - Read
Get a prospect manager
This operation is used to edit a prospect segmentation.
GET /crm-prsmg/prospectsegmentations/{prospect_segmentation_id} - Read
Get a prospect opportunity
Edits an opportunity.
GET /crm-prsmg/prospectopportunities/{opportunity_id} - Read
Get a prospect plan
Edit dataoperation for a prospect plan.
GET /crm-prsmg/prospectplans/{prospect_plan_id} - Read
Get a stewardship plan
This operation is for editing a given stewardship plan's steward.
GET /crm-prsmg/stewardshipplans/{stewardship_plan_steward_id} - Read
Get a stewardship plan steps
Edit operation for a stewardship plan step for an individual.
GET /crm-prsmg/stewardshipplansteps/{stewardship_plan_step_id} - Read
List prospect contact reports
List of opportunities for a contact report's prospect plan.
GET /crm-prsmg/prospectcontactreports/{interaction_id}/opportunitylist - Read
List prospect managers
This operation returns cell data for a prospect segmentation.
GET /crm-prsmg/prospectsegmentations/{prospect_segmentation_id}/list - Read
List prospect opportunities
List of opportunities for a prospect plan.
GET /crm-prsmg/prospectopportunities/{prospect_plan_id}/list - Read
List prospect plans
List of prospect plans.
GET /crm-prsmg/prospects/{constituent_id}/prospectplans - Read
List prospect steps
List of planned/pending steps for a given plan.
GET /crm-prsmg/prospectsteps/{prospect_plan_id}/plannedlist - Read
List stewardship plan steps
List of pending steps for a given stewardship plan.
GET /crm-prsmg/stewardshipplansteps/{stewardship_plan_id}/list - Read
List stewardship plans
This operation returns all stewardship plans related to a constituent.
GET /crm-prsmg/prospect/{constituent_id}/stewardshipplans - Read
Search for prospect managers
Search for prospects that have been assigned a prospect manager.
GET /crm-prsmg/prospectmanagers/search - Read
Search for prospect opportunities
Search for opportunity
GET /crm-prsmg/prospectopportunities/search - Read
Search for prospects
Search for prospects.
GET /crm-prsmg/prospects/search - Read
Search for stewardship plan steps
Search for stewardship plan steps
GET /crm-prsmg/stewardshipplansteps/search - Read
View a prospect
This view operation provides summary inoperationation about the prospect.
GET /crm-prsmg/prospects/{constituent_id}/view - Read
View a prospect plan
View data form for a prospect plan.
GET /crm-prsmg/prospectplans/{prospect_plan_id}/view - Read
View a prospect status
Defines the fields for the prospects tile.
GET /crm-prsmg/prospects/{constituent_id}/prospectstatus - Write
Create a prospect
Add dataoperation for a prospect.
POST /crm-prsmg/prospects - Write
Create a prospect constituency
This operation is used to add a prospect constituency to a constituent.
POST /crm-prsmg/prospectsconstituency - Write
Create a prospect contact report
Creates and transoperations a step into a contact report.
POST /crm-prsmg/prospectcontactreports - Write
Create a prospect manager
This operation is used to add a prospect segmentation.
POST /crm-prsmg/prospectsegmentations - Write
Create a prospect opportunity
Adds an opportunity to a prospect plan.
POST /crm-prsmg/prospectopportunities - Write
Create a prospect plan
Add dataoperation for a prospect plan.
POST /crm-prsmg/prospectplans - Write
Create a prospect steps
Add dataoperation for step records.
POST /crm-prsmg/prospectsteps - Write
Create a stewardship plan
This operation is used to add a stewardship plan.
POST /crm-prsmg/stewardshipplans - Write
Create a stewardship plan steps
Add operation for a stewardship plan step for an individual.
POST /crm-prsmg/stewardshipplansteps - Write
Edit a prospect
Edit operation for setting details on the prospect record.
PATCH /crm-prsmg/prospects/{constituent_id} - Write
Edit a prospect contact report
Edit an existing contact report.
PATCH /crm-prsmg/prospectcontactreports/{interaction_id} - Write
Edit a prospect manager
This operation is used to edit a prospect segmentation.
PATCH /crm-prsmg/prospectsegmentations/{prospect_segmentation_id} - Write
Edit a prospect opportunity
Edits an opportunity.
PATCH /crm-prsmg/prospectopportunities/{opportunity_id} - Write
Edit a prospect plan
Edit dataoperation for a prospect plan.
PATCH /crm-prsmg/prospectplans/{prospect_plan_id} - Write
Edit a prospect steps
Edit operation for a step.
PATCH /crm-prsmg/prospectsteps/{interaction_id} - Write
Edit a stewardship plan
This operation is for editing a given stewardship plan's steward.
PATCH /crm-prsmg/stewardshipplans/{stewardship_plan_steward_id} - Write
Edit a stewardship plan steps
Edit operation for a stewardship plan step for an individual.
PATCH /crm-prsmg/stewardshipplansteps/{stewardship_plan_step_id} - Destructive
Delete a prospect manager
This record operation is used to delete a prospect segmentation.
DELETE /crm-prsmg/prospectsegmentations/{prospect_segmentation_id} - Destructive
Delete a prospect opportunity
This delete method handles the basic deletion rules for an opportunity.
DELETE /crm-prsmg/prospects/{opportunity_id}/prospectopportunities - Destructive
Delete a prospect plan
This delete method handles the basic deletion rules for a prospect plan.
DELETE /crm-prsmg/prospectplans/{prospect_plan_id} - Destructive
Delete a prospect steps
Deletes a step from a plan.
DELETE /crm-prsmg/prospectsteps/{step_id} - Destructive
Delete a stewardship plan
Deletes a stewardship plan.
DELETE /crm-prsmg/stewardshipplans/{stewardship_plan_id} - Destructive
Delete a stewardship plan steps
Deletes a step from a stewardship plan.
DELETE /crm-prsmg/stewardshipplansteps/{stewardship_plan_step_id}
CRM Revenue
- Read
Get a recurring gift
Edit operation for recurring gift records.
GET /crm-revmg/recurringgifts/{revenue_id} - Read
Get a revenue lookup id
This operation allows for the editing of a revenue record's lookup id.
GET /crm-revmg/revenuelookupids/{revenue_id} - Read
Get a revenue payment
Edits a payment.
GET /crm-revmg/payments/{revenue_id} - Read
List default recognition credits
Returns a list of default recognition credits.
GET /crm-revmg/defaultrecognitioncredits/{constituent_or_acquisition_list_id}/list - Read
List gifts
Returns a list of gifts.
GET /crm-revmg/gifts - Read
Search for revenue
Search for revenue
GET /crm-revmg/revenue/search - Read
Search for revenue payments
Search for a payment.
GET /crm-revmg/payments/search - Read
Search for revenue transactions
Search for transaction
GET /crm-revmg/revenuetransactions/search - Write
Create a recurring gift
Add operation for recurring gifts.
POST /crm-revmg/recurringgifts - Write
Create a revenue note
Adds a note to a revenue record.
POST /crm-revmg/revenuenotes - Write
Create a revenue payment
Adds a payment to the system.
POST /crm-revmg/payments - Write
Edit a recurring gift
Edit operation for recurring gift records.
PATCH /crm-revmg/recurringgifts/{revenue_id} - Write
Edit a recurring gift status
Edit gift status for recurring gift templates.
PATCH /crm-revmg/recurringgiftstatus/{revenue_id} - Write
Edit a revenue lookup id
This operation allows for the editing of a revenue record's lookup id.
PATCH /crm-revmg/revenuelookupids/{revenue_id} - Write
Edit a revenue payment
Edits a payment.
PATCH /crm-revmg/payments/{revenue_id} - Destructive
Delete a revenue payment
Delete a payment that is not associated with a constituent record.
DELETE /crm-revmg/payments/{revenue_id}
CRM Volunteer
- Read
Get a job
Edits an existing job.
GET /crm-volmg/jobs/{job_id} - Read
Get a job occurrence
Edits an occurrence of a job.
GET /crm-volmg/occurrences/{job_occurrence_id} - Read
Get a timesheet
Edit a timesheet.
GET /crm-volmg/timesheets/{time_sheet_id} - Read
Get a volunteer
Edit a volunteer
GET /crm-volmg/volunteers/{volunteer_id} - Read
List assignments
This operation returns all assignments for a volunteer on a specified day.
GET /crm-volmg/volunteerassignments/{volunteer_id}/list?day={day} - Read
List jobs
This operation returns all occurrences for a job.
GET /crm-volmg/jobs/{job_id}/list - Read
List timesheets
Lists the timesheets for a volunteer.
GET /crm-volmg/timesheets/{volunteer_id}/list - Read
List volunteer schedules
This operation returns all dates with openings for an occurrence including assignments, used by the job occurrence schedule calendar.
GET /crm-volmg/volunteerschedules/{job_occurrence_id}/list - Read
Search for assignments
This search is for finding constituents who are volunteers but not assigned to a job on a date.
GET /crm-volmg/volunteerassignments/search - Read
Search for job occurrences
This search is for finding job occurrences.
GET /crm-volmg/occurrences/search - Read
Search for jobs
This search is for finding jobs.
GET /crm-volmg/jobs/search - Read
Search for volunteers
This search is for finding constituents who are members of the volunteer.
GET /crm-volmg/volunteers/search - Read
View a job occurrence
Shows basic inoperationation about a job occurrence
GET /crm-volmg/occurrences/{job_occurrence_id}/view - Read
View a volunteer
Shows general inoperationation about a volunteer.
GET /crm-volmg/volunteers/{volunteer_id}/view - Write
Create a job
Adds a new job.
POST /crm-volmg/jobs - Write
Create a job occurrence
Adds an occurrence of a job.
POST /crm-volmg/occurrences - Write
Create a timesheet
Add a timesheet.
POST /crm-volmg/timesheets - Write
Create a volunteer
Add a volunteer
POST /crm-volmg/volunteers - Write
Create a volunteer schedule
Used for assigning volunteers to a given job occurrence.
POST /crm-volmg/volunteerschedules - Write
Create an assignment
Assign job occurrences to a volunteer on a specific day.
POST /crm-volmg/volunteerassignments - Write
Edit a job
Edits an existing job.
PATCH /crm-volmg/jobs/{job_id} - Write
Edit a job occurrence
Edits an occurrence of a job.
PATCH /crm-volmg/occurrences/{job_occurrence_id} - Write
Edit a timesheet
Edit a timesheet.
PATCH /crm-volmg/timesheets/{time_sheet_id} - Write
Edit a volunteer
Edit a volunteer
PATCH /crm-volmg/volunteers/{volunteer_id} - Destructive
Delete a job
Delete a job.
DELETE /crm-volmg/jobs/{job_id} - Destructive
Delete a job occurrence
Delete an occurrence of a job.
DELETE /crm-volmg/occurrences/{job_occurrence_id} - Destructive
Delete a timesheet
Deletes a timesheet from the system.
DELETE /crm-volmg/timesheets/{time_sheet_id} - Destructive
Delete a volunteer
This record operation is used to handle the rules of deleting a volunteer constituency.
DELETE /crm-volmg/volunteers/{volunteer_date_range_id} - Destructive
Delete an assignment
Remove a volunteer from a job.
DELETE /crm-volmg/volunteerassignments/{volunteer_assignment_id}
CSRconnect
- Read
Get a collection of engagement elements (PREVIEW)
Returns a collection of standard engagement elements that can be tied to donations for the authenticated affiliate. Purely resource- and content-based engagement elements are not included. Each engagement element's `engagement_element_id` can be used to fetch more granular donation detail for that engagement element. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/metrics/engagementelements - Read
Get a collection of giving campaign summaries (PREVIEW)
Returns a collection of company giving campaigns for the authenticated affiliate. Each campaign includes the total amount donated and the count of unique donors. Each campaign's `campaign_id` can be used to fetch more granular donation detail for that campaign. `total_amount` includes pledges made toward the campaign but excludes payroll donations. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/metrics/give/campaigns - Read
Get a summary of giving totals (PREVIEW)
Returns a summary of giving totals for the authenticated affiliate, broken down by donation type. The date_type param applies only to donation metrics. It controls whether donations are included by the date the record was created or the date of the actual donation. For example, an employee can record an offline donation on one date, but the donation itself occurred on an earlier date. For a company match or incentive request that requires approval, the create date is when the employee submits the request, and the donation date is when the request is approved and becomes a donation. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/metrics/give?country_code={country_code} - Read
Get a summary of volunteering totals (PREVIEW)
Returns a summary of volunteering totals for the authenticated affiliate, broken down into events, activities, and NPO-created events. `events` reflects employee-created volunteer events. `activities` reflects individually recorded volunteer activities. `npoEvents` reflects events created by a nonprofit organization. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/metrics/volunteer - Read
Get all groups by employee (PREVIEW)
Returns all of the groups for a single employee. Passing the affiliate_employee_id returns a paginated set of results containing the information for each group the employee is associated with. limit is the number of results per page, capped at 25. In the response, group_admin and group_member identify the employee's level of association with the group. creator_affiliate_employee_id exposes the employee that created the group page. show_membership indicates a user decision to have their name shown as a member on the group page for other group members to see. has_pending_membership indicates that the user requested to join the group but the request has not been accepted by the group admin. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/groups - Read
Get an employee’s Give charity bucket (PREVIEW)
Returns the Give charity bucket for an employee. Employees may have different sets of charities eligible for donations. You can pass this ID to the charity search endpoint to find eligible organizations for that employee's donations. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/buckets/give - Read
Get an employee’s Volunteer charity bucket (PREVIEW)
Returns the Volunteer charity bucket for an employee. Employees may have different sets of charities eligible for volunteering. You can pass this ID to the charity search endpoint to find eligible organizations for that employee’s volunteering activity. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/buckets/volunteer - Read
Get an employee's custom question responses (PREVIEW)
Returns an employee’s responses to a custom question set. When an employee signs up for an event or records individual volunteer activity, they may be prompted to answer a set of questions related to their participation. This endpoint returns an array of the questions and responses for a given employee and responseId. The responseId can be obtained from the participation or RIA entry payload via the customQuestionSetResponseId property. See the Volunteer section in this reference for details on retrieving participation and RIA entry information. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/customquestions/{response_id} - Read
Get an employee's participations for an event (PREVIEW)
Returns all participations for a given employee and event. This endpoint returns a paginated set of all the participations (shifts) for a given employee and event. You will pass the employee identifier as well as the event type and event ID. The type and ID can be obtained by using the /scheduled and /history endpoints above. When using the query params, be aware that pageSize is limited to 25 results. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/events/{event_type}/{event_id}/participations - Read
Get charity data (PREVIEW)
Returns giving and volunteering totals for a single charity. You can use the `v1/metrics/charities` endpoint to pull identifiers for the top charities; for a charity not returned there, the identifier can be found using CSRconnect admin tools and reporting. Returns 400 Bad Request if charity_id does not correspond to a known charity. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/metrics/charities/{charity_id} - Read
Get data on a specific engagement element (PREVIEW)
Returns donation totals for a single engagement element, broken down by donation type. You can use the `v1/metrics/engagementelements` endpoint to pull all available engagement element identifiers. Only processed donations are included in the metrics summary. The `Payroll` donation type reflects processed payroll donations only, not future pledges. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/metrics/engagementelements/{engagement_element_id} - Read
Get data specific to a single giving campaign (PREVIEW)
Returns donation totals for a single giving campaign, broken down by donation type. You can use the `v1/metrics/give/campaigns` endpoint to pull all available campaign identifiers. Only processed donations are included in the metrics summary. The `Payroll` donation type reflects processed payroll donations only, not future pledges. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/metrics/give/campaigns/{campaign_id} - Read
Get details for a participation (PREVIEW)
Returns a participation record for a specific employee, event, and shift. If this is a guest participation, the response contains a guest ID and name. Note the customQuestionSetResponseId . If the user was required to answer any questions while adding this shift, the value is the unique identifier for their responses. See the Custom Questions section above in this reference for more information on fetching these responses. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/events/{event_type}/{event_id}/participations/{participation_id} - Read
Get employee details by affiliate employee ID (PREVIEW)
Returns details of an employee using the employee's affiliate employee ID. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/affiliateemployeeid/{affiliate_employee_id} - Read
Get employee details by employee ID (PREVIEW)
Returns the details of an employee. This endpoint returns a high level profile for the employee in CSRconnect. Passing the employee ID as listed on the HR file will return a basic user profile. The affiliateEmployeeId returned will be used in other endpoints when fetching participation related data. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{employee_id} - Read
Get event details (PREVIEW)
Returns information about a specific event. See above for information of how to obtain eventId. If private is True, the creator chose to not expose the event in search and only employees with a link to the event would be able to sign up. The charity_external_key is the official registration ID for the charity. For example, EIN#. The affiliate_organization_id will only contain a value if the event is tied to a custom organization created by a client admin. The majority of events will contain charity_id which is the unique identifier of an official charity in CSRconnect. The event_occurence_summary contains all the occurrences of this event. For a recurring event, each occurrence will be detailed here. This is also where you will find the shift and time information. Setting include_participations to true (attach '?include_participations=true' to the end of the url), will add the event's participation data to the return object. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/volunteer/events/{event_type}/{event_id} - Read
Get event participants (PREVIEW)
Returns a paged list of the participants for a given event. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/volunteer/events/{event_type}/{event_id}/participants/{page}/{limit} - Read
Get giving campaign participation for an employee (PREVIEW)
Returns an employee’s participation data for a specific giving campaign You can use the v1/metrics/give/campaigns endpoint defined in the metrics reference to pull all available campaign identifiers. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/givecampaigns/{campaign_id} - Read
Get group information (PREVIEW)
Returns an object containing all the primary details for a Groups page in CSRconnect. The group_id is the unique identifier of the group page. This ID can be obtained by searching a group program. membership_type defines the method of "join" for all pages in the program. A value of "1" indicates that all group pages in the program are closed and require a request to join that must be approved by the group administrator. A value of "2" indicates that all group pages in the program are open and can be freely joined without approval. A value of "3" indicates that the creator of each group determines at the time of page creation whether the group is open or closed. open indicates the membership choice when membership_type is "3". If true, the creator made the page open and any employee can join. If false, the creator made the page closed and employees must request to join. For membership_type values "1" or "2", the value reflects that closed or open setting. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/groups/{group_id} - Read
Get group programs (PREVIEW)
Returns all of the group programs configured by the client. In addition to the general details about the group program, the payload contains the following: group_creators indicates which employees are allowed to create a group within the specific program. A value of "1" indicates that only super admins can create group pages and a value of "2" indicates that any employee can create a page for the program. group_membership_type defines the method of "join" for all pages in the program. A value of "1" indicates that all group pages in the program are closed and require a request to join that must be approved by the group administrator. A value of "2" indicates that all group pages are open and can be freely joined without approval. A value of "3" indicates that the creator of each group determines at the time of page creation whether the group is open or closed. group_members_privacy_type defines the user privacy setting for each group in the program. A value of "1" indicates that all groups are private and the group page will not show a list of members. A value of "2" indicates that all group pages are public and display a list of members. When a group page is public, each user may opt out of being shown in the member list. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/groups/programs - Read
Get individual activities (PREVIEW)
Returns a list of individual activities for an employee. Record Individual Activity or "RIA" is a feature in CSRconnect that allows an employee to track volunteering that is not tied to an event in the system. Users create Activities that explain the nature and location of the volunteer participation. Each Activity will have one or many entries. Each entry is a date and number of hours participated. This endpoint returns a paginated set of all the activities and entries for a given employee. When using the query params, be aware that pageSize is limited to 25 results. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/ria/activities - Read
Get individual activity details (PREVIEW)
Returns details about an employee individual activity. See above for information of how to obtain riaId. The projectTypeId will display a value of "1" if this Activity is associated with a Volunteer Match event. Volunteer Match events are sourced from a 3rd party and do not have set times or shifts. Activities are used to capture hours related to the Volunteer Match opportunity. If null, the Activity was employee created and has no relationship to any event. Note the customQuestionSetResponseId . If the user was required to answer any questions while adding entries, the value is the unique identifier for their responses. See the Custom Questions section above in this reference for more information on fetching these responses. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/ria/{ria_id} - Read
Get participation data for an employee (PREVIEW)
Returns giving and volunteering participation metrics for a specific employee. The start and end params control the date range for the metrics summary. Pass standard date format (mm/dd/yy). Data is available for records created after 2014. The dateType param should be defined as "donated" or "created" and applies only to donation metrics. This controls which donations are included in the metrics summary by the date the record was created or the date of the actual donation. For example a user can record an offline donation on 01/01/19 but the donation date of that offline donation was 12/15/18. The created date is 01/01/19 and the donation date was 12/15/18. For a company match or incentive request that requires approval, the date the employee submits the request will be the create date and the date the request is approved and becomes a donation is the donation date. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/metrics - Read
Get past events for an employee (PREVIEW)
Returns past events an employee has signed up for or been added to. Only past participations are included. This endpoint returns a paginated set of the events that an employee has signed up for, or been added to, where their assigned shifts are all in the past. When using the query params, be aware that pageSize is limited to 25 results. events.type indicates the origin of the event. A value of "1" indicates that an employee created the event. A value of "2" indicates that an NPO created the event. has_wait_list will be true if any of the employees shifts are currently in the waitlisted state. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/history/events - Read
Get skills (PREVIEW)
Returns a list of skills used by the organization. Each organization can turn skills on and off. This will only return the skills that are currently active for the associated organization for the external api call. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/volunteer/skills - Read
Get top charities (PREVIEW)
Returns the top charities supported by the authenticated affiliate for both giving and volunteering. Each collection contains a high-level giving or volunteering summary. Each charity's `charity_id` is the unique identifier for the organization in CSRconnect and can be used to fetch a more granular summary for that organization. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/metrics/charities - Read
Get upcoming events for an employee (PREVIEW)
Returns events that an employee has signed up for or been added to. Only upcoming participations are included. This endpoint returns a paginated set of the events that an employee has signed up for, or been added to, where their assigned shifts are still in the future. Once all of the employees shifts are in the past, the event will move to the history collection. See /history below for more information. When using the query params, be aware that pageSize is limited to 25 results. events.type indicates the origin of the event. A value of "1" indicates that an employee created the event. A value of "2" indicates that an NPO created the event. has_wait_list will be true if any of the employees shifts are currently in the waitlisted state. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/scheduled/events - Write
Assign an employee to a group (PREVIEW)
Assigns an employee to a group page. In the body of the request you pass the following: affiliate_employee_id is the ID of the employee you are assigning to the group page. If the group program has a disclaimer and disclaimer text, accepted_disclaimer indicates that the employee has accepted that disclaimer. send_me_email_notifications indicates a user decision to accept email communications from the administrator of the group page. show_membership indicates a user decision to have their name shown as a member on the group page for other group members to see. The response success value is false when the employee is already a member, or when the group program requires a disclaimer that was not accepted. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /csr-connect/v1/groups/{group_id}/join - Write
Create an event (PREVIEW)
Creates a volunteer event. To associate a benefitting organization with the event, provide one of the following (in order of precedence): `nonprofitId` (the unique GUID for the charity — highest precedence, resolves an exact match), `charityId` (the CSRconnect charity identifier), `registrationNumber` (for example, the charity's EIN), or `benefittingOrganization` (a free-text organization name). At least one of these must be supplied. Charity identifier validation is enforced by the upstream API. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /csr-connect/v1/volunteer/events - Write
Create an individual activity (PREVIEW)
Creates a new individual activity for an employee. As mentioned above, an Activity is a description of volunteerism that hours of participation are added to as "entries". The body of this post contains all the required values for an Activity. charity_id is the unique identifier for the charity that the participation benefits. See the Charities section above in this reference to learn more about this identifier and how to search the eligible organizations for this user and feature. If the isVirtual param is true, it means that there is no location for the Activity. This could be something like a phone call or web based event. The address will not be required. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/ria - Write
Create event participations (PREVIEW)
Adds participations to an event. See above for information of how to obtain event_id. In the body of this post, you will pass the following: affiliateEmployeeId is the unique identifier of the employee you are signing up. An array of shifts as objects. These are the individual participations. See the /{eventId} reference above for details on the parameters of the shift. Note: The hours of participation defined for each shift can not exceed the length of the shift plus 10 hours. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /csr-connect/v1/volunteer/events/{event_type}/{event_id}/signup - Write
Create new individual activity hours (PREVIEW)
Add new hour entries for an employee activity. See the sections above for more information on obtaining the riaId or creating new Activities. In the body of this post, you will pass the date and number of hours for each date. A single date should not contain more than 24 hours. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/ria/{ria_id}/entries - Write
Edit a participation (PREVIEW)
Edits an employee’s participation for a given event and shift. This endpoint allows you to edit/update a single participation record (shift) for the given employee and event. In the body, you will pass hours. This is the amount of time that the employee will volunteer for this shift. The hours value can not exceed the length of the shift plus 10 hours. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/events/{event_type}/{event_id}/participations/{participation_id} - Write
Edit an event (PREVIEW)
Edits an event. The major difference between update and add an event are - update requires an Event ID. Furthermore, some fields are not updatable at this time. These include shifts and the event schedule due to complexities with moving participations. `eventId` is required for edits and is validated by the upstream API. To associate a benefitting organization with the event, provide one of the following (in order of precedence): `nonprofitId` (the unique GUID for the charity — highest precedence, resolves an exact match), `charityId` (the CSRconnect charity identifier), `registrationNumber` (for example, the charity's EIN), or `benefittingOrganization` (a free-text organization name). At least one of these must be supplied. Charity identifier validation is enforced by the upstream API. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /csr-connect/v1/volunteer/updateevents - Write
Edit an individual activity (PREVIEW)
This endpoint allows you to edit/update an Activity for the given employee by passing the unique identifier of the Activity. The body of this post contains all the required values for an Activity. See the /ria post method above for more information on the details of an Activity. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/ria/{ria_id} - Write
Edit individual activity hours (PREVIEW)
Edits hour entries for an employee’s individual activity. See the sections above for more information on obtaining the entryId or creating new Entries. In the body of this post, you will pass the date and number of hours for each date. A single date should not contain more than 24 hours. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/ria/{ria_id}/entries/{entry_id} - Write
Get employee details for special character IDs (PREVIEW)
Returns details for an employee by employee ID. Use this endpoint if the employee ID contains special characters. This endpoint returns a high level profile for the employee in CSRconnect. Passing the employee ID as listed on the HR file will return a basic user profile. The affiliateEmployee ID returned will be used in other endpoints when fetching participation related data. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /csr-connect/v1/employees - Write
Search for charities in a charity bucket (PREVIEW)
Returns charities within a charity bucket that meet the provided criteria. Charity buckets are sets of charities eligible for specific CSRconnect features. Pass the bucket ID for the employee and feature you are working with. Once you have the bucket ID, you can construct a request to search the bucket. In the body of the request, provide the search term, page number, and limit. The term is the string which the API will use to search charity name. The page is the page number of the paginated results you want to pull. The limit is the number of results per page. There is a limit of 25 results per page. For each valid request, the api will return a payload of charity results and details for each organization. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /csr-connect/v1/charities/buckets/{bucket_id}/search/charities - Write
Search for charities in an affiliate's bucket (PREVIEW)
This is a simpler search operation that doesn't require the caller to send the charity bucket ID. Instead, the API will resolve the charity bucket from the authenticated affiliate and then perform the same bucket search behavior used by the standard bucket search endpoint. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /csr-connect/v1/charities/buckets/search/charities - Write
Search groups (PREVIEW)
Searches for a group page within a specific group program. Use the group programs endpoint to obtain the group_program_id. In the body of the request, provide the term, page, and limit. term is the string the API uses to search the group page name. page is the page of paginated results to pull. limit is the number of results per page, capped at 25. include_virtual is optional. When true, groups with no defined location are included. The default value is false. To search by location, use the optional distance_in_miles, latitude, and longitude params. Passing a latitude and longitude returns groups within a 50 mile radius by default; use distance_in_miles to change the radius. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /csr-connect/v1/groups/programs/{group_program_id}/search - Write
Search volunteer events (PREVIEW)
This endpoint allows you to search all the volunteer events in the client community. It returns a paginated set of results with all the event details. In the body of the post, you will pass the following: The term is the string that the API will use to search for matching event names. The page is the page of results you wish to fetch. The limit is number of results per page. This can not exceed 25 and will default to 25 if the value you pass is greater. start_date defines the start date of the date range you are searching within. end_date defines the end date of the date range you are searching within. modified_from defines the start date of the updated date range you are searching within. modified_to defines the end date of the updated date range you are searching within. If include_virtual is true, all Virtual Events (events with no location) will be included. The default value is false. To search by location, you can use the optional distance_in_miles, latitude and longitude params. By passing a lat and long, your result set will contain events within a 50 mile radius of the location. If you wish to change the search radius, use the distance_in_miles param to define a different search radius. If hide_full is true, all events with a set capacity and no open shifts will be excluded. Note: In the return, event_type identifies the type of event. If the value is 1, the event was created by someone at the company. If the value is 2 the event was created externally by a non-profit. Also, this is not related to EventTypes (plural) which includes a set of meta data tag "Types" that are used for reporting and search filtering. These are defined by the event creator while creating the event. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /csr-connect/v1/volunteer/events/search - Destructive
Delete a participation (PREVIEW)
Deletes a participation for a given employee and event. You cannot delete participations tied to Grant, Incentive, or VTO requests. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/events/{event_type}/{event_id}/participations/{participation_id} - Destructive
Delete an individual activity (PREVIEW)
Delete an employee’s individual activity. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/ria/{ria_id} - Destructive
Delete individual activity hours (PREVIEW)
Deletes an hours entry for an employee’s individual activity. See the sections above for more information on obtaining the entryId or creating new Entries. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /csr-connect/v1/employees/{affiliate_employee_id}/volunteer/ria/{ria_id}/entries/{entry_id} - Destructive
Remove an employee from a group (PREVIEW)
Removes an employee from a group page. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /csr-connect/v1/groups/{group_id}/members/{affiliate_employee_id}
Custom field
- Read
Get custom field categories (PREVIEW)
Gets a list of custom field categories for a given custom field type. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /customfield/customfieldcategories?record_type={record_type} - Read
Get custom field category by ID (PREVIEW)
Gets custom field category by ID. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /customfield/customfieldcategories/{id}?record_type={record_type} - Write
Add custom field category (PREVIEW)
Add custom field category. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /customfield/customfieldcategories - Write
Edit custom field category (PREVIEW)
Edit custom field category. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /customfield/customfieldcategories/{id} - Destructive
Delete custom field (PREVIEW)
Delete a custom field by ID. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /customfield/customfieldcategories/{id}?record_type={record_type}
Event
- Read
Get a constituent's event participation (PREVIEW)
Returns a constituent's event participation. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/constituents/{constituent_id}/eventparticipation - Read
Get a participant
Returns information about a specific participant.
GET /event/v1/participants/{participant_id} - Read
Get a participant benefit by ID. (PREVIEW)
Returns a participant benefit. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/eventparticipantbenefits/benefits/{benefit_id} - Read
Get an event
Returns information about an event. This endpoint is deprecated. For more detailed event information, use the Get an eventV2 endpoint instead.
GET /event/v1/events/{event_id} - Read
Get an event attachment
Returns information about an attachment.
GET /event/v1/events/{event_id}/attachments/{attachment_id} - Read
Get an eventV2 (PREVIEW)
Returns information about an event. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v2/events/{event_id} - Read
Get benefits for a participant. (PREVIEW)
Returns a collection of benefits by participant ID. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/eventparticipantbenefits/{participant_id}/benefits/list - Read
Get event attachment tags
Returns a list of available attachment tags.
GET /event/v1/eventattachmenttags - Read
Get event attachments
Returns a list of attachments for an event.
GET /event/v1/events/{event_id}/attachments - Read
Get event categories
Returns a list of active event categories.
GET /event/v1/eventcategories - Read
Get event custom field category details (PREVIEW)
Returns a list of event custom field category details. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/events/customfields/categories/details - Read
Get event custom fields (PREVIEW)
Returns a list of event custom fields. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/events/{event_id}/customfields - Read
Get event expenses. (PREVIEW)
Returns a list of expenses for an event. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/events/{event_id}/expenses - Read
Get event fees
Returns a list of fees for an event.
GET /event/v1/events/{event_id}/eventfees - Read
Get event groups (PREVIEW)
Returns a list of event groups. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/eventgroups - Read
Get event list
Returns a paginated list of events.
GET /event/v1/eventlist - Read
Get event participant list
Returns a list of participants for an event.
GET /event/v1/events/{event_id}/participants - Read
Get event participant options
Returns the participant options for an event.
GET /event/v1/events/{event_id}/eventparticipantoptions - Read
Get expense types (PREVIEW)
Returns a collection of expense types. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/expensetypes - Read
Get participant donations
Returns the donations for a participant.
GET /event/v1/participants/{participant_id}/donations - Read
Get participant fee payments
Returns the fee payments for a participant.
GET /event/v1/participants/{participant_id}/feepayments - Read
Get participant fees
Returns a list of fees for a participant.
GET /event/v1/participants/{participant_id}/fees - Read
Get participant options
Returns the participant options for a participant.
GET /event/v1/participants/{participant_id}/participantoptions - Read
Get participant pledges (PREVIEW)
Returns the pledges for a participant. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/participants/{participant_id}/pledges - Read
Get participant seating details (PREVIEW)
Returns participant seating information. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/participants/{participant_id}/seating - Read
Get participation levels
Returns a list of participation levels for all events. Participation levels describe a participant's involvement in an event, such as child participant or local business supporter.
GET /event/v1/participationlevels - Read
Get waive benefits status for a participant. (PREVIEW)
Returns the waive benefits status for a participant by participant ID. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/eventparticipantbenefits/{participant_id}/waivebenefits - Read
Gets an event expense. (PREVIEW)
Returns an event expense for a given expense ID. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/expenses/{expense_id} - Read
Returns event custom field category values (PREVIEW)
Returns event custom field category values. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /event/v1/events/customfields/categories/values - Write
Copy event participant options (PREVIEW)
Copy event participant options from a source event onto a target event. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /event/v1/events/copyparticipantoptions - Write
Create a benefit for a participant. (PREVIEW)
Adds a new participant benefit. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /event/v1/eventparticipantbenefits/benefits - Write
Create a participant
Creates a new participant for an event. Note: Host participants and standalone participants have the Host registrant type. To create a participant with the Guest registrant type, include a host_id . To create a Host participant, pass a constituent_id (must be a constituent record) and do not pass a host_id . To create a Guest participant that will be linked to an existing record, pass a constituent_id (constituent or non-constituent record) and pass the participant ID of the Host as the host_id . To create a Guest participant that will create a new non-constituent record, do not pass a constituent_id (a new unnamed guest will be created as a non-constituent) and pass the participant ID of the Host as the host_id .
POST /event/v1/events/{event_id}/participants - Write
Create a participant donation
Creates a new donation for a participant.
POST /event/v1/participants/{participant_id}/donations - Write
Create a participant fee
Creates a new fee for a participant.
POST /event/v1/participants/{participant_id}/fees - Write
Create a participant fee payment
Creates a new fee payment for a participant.
POST /event/v1/participants/{participant_id}/feepayments - Write
Create a participant option
Creates a new participant option for a participant.
POST /event/v1/participants/{participant_id}/participantoptions - Write
Create a participation level
Creates a new participation level.
POST /event/v1/participationlevels - Write
Create an event
Creates a new event.
POST /event/v1/events - Write
Create an event attachment
Creates an event attachment.
POST /event/v1/events/{event_id}/attachments - Write
Create an event attachment upload
Creates a document upload location and unique document identifier for physical attachments. Use the returned url to upload a physical file for an attachment, then call the Create an event attachment endpoint. Maximum file size is 100MB.
POST /event/v1/eventattachmentupload - Write
Create an event category
Creates a new event category.
POST /event/v1/eventcategories - Write
Create an event expense (PREVIEW)
Create an event expense. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /event/v1/events/{event_id}/expenses - Write
Create an event fee
Creates a new fee for an event.
POST /event/v1/events/{event_id}/eventfees - Write
Create an event participant option
Creates a new participant option for an event.
POST /event/v1/events/{event_id}/eventparticipantoptions - Write
Create event custom field (PREVIEW)
Create event custom field. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /event/v1/events/customfields - Write
Edit a participant
Edits the details about a participant.
PATCH /event/v1/participants/{participant_id} - Write
Edit a participant benefit. (PREVIEW)
Edit existing participant benefit entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /event/v1/eventparticipantbenefits/benefits - Write
Edit a participant option
Edits the details about a participant option.
PATCH /event/v1/participantoptions/{option_id} - Write
Edit a participation level
Edits the details about a participation level.
PATCH /event/v1/participationlevels/{participation_level_id} - Write
Edit an event
Edits the details about an event.
PATCH /event/v1/events/{event_id} - Write
Edit an event attachment
Edits an event attachment.
PATCH /event/v1/events/{event_id}/attachments/{attachment_id} - Write
Edit an event category
Edits the details about an event category.
PATCH /event/v1/eventcategories/{event_category_id} - Write
Edit an event expense (PREVIEW)
Edit an event expense. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /event/v1/expenses/{expense_id} - Write
Edit an event fee
Edits an event fee.
PATCH /event/v1/eventfees/{fee_id} - Write
Edit an event participant option
Edits the details about an event participant option.
PATCH /event/v1/eventparticipantoptions/{option_id} - Write
Edit event custom field (PREVIEW)
Edit event custom field. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /event/v1/events/customfields/{custom_field_id} - Write
Edit participant benefit notes. (PREVIEW)
Updates the benefit notes for a specified event participant. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /event/v1/eventparticipantbenefits/benefits/notes - Write
Edit participant seating (PREVIEW)
Edits the seating details for a participant. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /event/v1/participants/{participant_id}/seating - Write
Edit waive benefits status for a participant. (PREVIEW)
Updates the waive benefits status for a participant. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /event/v1/eventparticipantbenefits/waivebenefits - Destructive
Delete a participant
Deletes a participant.
DELETE /event/v1/participants/{participant_id} - Destructive
Delete a participant benefit. (PREVIEW)
Deletes an existing participant benefit entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /event/v1/eventparticipantbenefits/benefits/{benefit_id} - Destructive
Delete a participant donation
Deletes a participant donation for a participant.
DELETE /event/v1/participantdonations/{participant_donation_id} - Destructive
Delete a participant fee
Deletes a participant fee for a participant.
DELETE /event/v1/participantfees/{participant_fee_id} - Destructive
Delete a participant fee payment
Deletes a participant fee payment for a participant.
DELETE /event/v1/participantfeepayments/{participant_fee_payment_id} - Destructive
Delete a participant option
Deletes a participant option for a participant.
DELETE /event/v1/participantoptions/{option_id} - Destructive
Delete a participation level
Deletes a participation level.
DELETE /event/v1/participationlevels/{participation_level_id} - Destructive
Delete an event
Deletes an event.
DELETE /event/v1/events/{event_id} - Destructive
Delete an event attachment
Deletes an event attachment.
DELETE /event/v1/events/{event_id}/attachments/{attachment_id} - Destructive
Delete an event category
Deletes an event category.
DELETE /event/v1/eventcategories/{event_category_id} - Destructive
Delete an event fee
Deletes a fee for an event.
DELETE /event/v1/eventfees/{fee_id} - Destructive
Delete an event participant option
Deletes an event participant option.
DELETE /event/v1/eventparticipantoptions/{option_id} - Destructive
Delete event custom field (PREVIEW)
Delete event custom field. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /event/v1/events/customfields/{custom_field_id} - Destructive
Deletes an event expense (PREVIEW)
Deletes an event expense. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /event/v1/expenses/{expense_id}
Fixed Assets
- Read
Get a transaction
Gets information about a transaction.
GET /fixedassets/v1/transactions/{transaction_id} - Read
Get an asset
Gets information about an asset.
GET /fixedassets/v1/assets/{asset_id} - Read
Get asset list
Returns a paginated list of assets.
GET /fixedassets/v1/assets - Read
Get transaction list
Returns a paginated list of transactions.
GET /fixedassets/v1/transactions - Write
Create an asset
Creates a new asset.
POST /fixedassets/v1/assets
Donation Forms
- Read
Get donation forms
Returns a list of forms.
GET /fms-rport/forms/v1
Gift Aid
- Read
Get gift record with gift splits by gift ID
Get single gift by gift ID
GET /gar-gfacr/v1/gifts/{gift_id}/giftaid - Read
Get tax declarations for constituent
Returned tax declarations by constituent ID
GET /gar-gfacr/v1/taxdeclarations/constituents/{constituent_id} - Write
Add constituent tax declaration
Add tax declaration
POST /gar-gfacr/v1/taxdeclarations/constituents/{constituent_id} - Write
Update constituent gift split tax
Update gift split tax
PATCH /gar-gfacr/v1/gifts/{gift_id}/giftaid/splits - Write
Update constituent gift tax
Update gift tax
PATCH /gar-gfacr/v1/gifts/{gift_id}/giftaid - Write
Update constituent tax declaration
Update tax declaration
PATCH /gar-gfacr/v1/taxdeclarations/{declaration_id} - Destructive
Deletes a constituent tax declaration
Deletes a constituent tax declaration
DELETE /gar-gfacr/v1/taxdeclarations/{declaration_id}
Gift v2
- Read
Get a gift benefit by ID. (PREVIEW)
Returns a gift benefit. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v1/gifts/benefits/{benefit_id} - Read
Get a gift note by ID. (PREVIEW)
Returns a single gift note for the specified gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/gifts/{gift_id}/notes/{note_id} - Read
Get assets for a planned gift. (PREVIEW)
Returns a paginated list of assets for the specified planned gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/gifts/{gift_id}/plannedgift/assets - Read
Get available relationships for a planned gift. (PREVIEW)
Returns a paginated list of available relationships across all 4 types (Individual, Organization, Financial, Education) for the constituent associated with the specified planned gift. Each relationship includes flags indicating whether it is already added as a gift relationship or beneficiary. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/gifts/{gift_id}/plannedgift/relationships/available - Read
Get Batch Gift (PREVIEW)
Returns a single batch gift by ID ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/batchgifts/{batchGiftId} - Read
Get beneficiaries for a planned gift. (PREVIEW)
Returns a paginated list of beneficiaries for the specified planned gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/gifts/{gift_id}/plannedgift/beneficiaries - Read
Get benefits for a gift. (PREVIEW)
Returns a collection of benefits by gift ID. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v1/gifts/{gift_id}/benefits/list - Read
Get notes for a gift. (PREVIEW)
Returns a paginated list of notes for the specified gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/gifts/{gift_id}/notes - Read
Get pledge installments (PREVIEW)
This gets the installments of an existing pledge gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/gifts/{gift_id}/installments - Read
Get pledge payments (PREVIEW)
This gets the payments of an existing pledge gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/gifts/{gift_id}/pledgepayments - Read
Get realized revenue gifts for a planned gift. (PREVIEW)
Returns a paginated list of realized revenue gifts for the specified planned gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/gifts/{gift_id}/plannedgift/realizedrevenuegifts - Read
Get relationships for a planned gift. (PREVIEW)
Returns a paginated list of relationships for the specified planned gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/gifts/{gift_id}/plannedgift/relationships - Read
Get the potential matching gifts for a gift (PREVIEW)
Suggests the organizations that might match the gift: organizations the donor has a flagged matching gift relationship with, for which no matching gift pledge exists yet against this gift. The list is empty when the gift exists but has no suggestions; a gift that does not exist is a 404. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/gifts/{gift_id}/potentialmatchinggifts - Read
Gets a planned gift by its identifier. (PREVIEW)
Returns the details of a planned gift including vehicle-specific fields. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /gft-gifts/v2/gifts/{gift_id}/plannedgift - Write
Add Gifts to Batch (PREVIEW)
Add multiple gifts to an existing unapproved batch ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /gft-gifts/v2/batchgifts/{batchId} - Write
Add pledge installments (PREVIEW)
This adds installments to an existing pledge gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /gft-gifts/v2/gifts/{gift_id}/installments - Write
Adds a new asset to a planned gift. (PREVIEW)
Creates a new asset record and associates it with the specified planned gift. The asset is automatically assigned the next sequence number. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /gft-gifts/v2/gifts/{gift_id}/plannedgift/assets - Write
Adds a new beneficiary to a planned gift. (PREVIEW)
Creates a new beneficiary record and associates it with the specified planned gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /gft-gifts/v2/gifts/{gift_id}/plannedgift/beneficiaries - Write
Adds a new relationship to a planned gift. (PREVIEW)
Creates a new relationship record and associates it with the specified planned gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /gft-gifts/v2/gifts/{gift_id}/plannedgift/relationships - Write
Create a benefit for a gift. (PREVIEW)
Adds a new gift benefit. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /gft-gifts/v1/gifts/benefits - Write
Create a gift. (PREVIEW)
Supported gift types include One-time, pledge, pledge payment, recurring, stock, gift-in-kind, matching gift pledge, matching gift payment, and other. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /gft-gifts/v2/gifts - Write
Create a note for a gift. (PREVIEW)
Creates a new note on the specified gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /gft-gifts/v2/gifts/{gift_id}/notes - Write
Edit a gift benefit. (PREVIEW)
Edit existing gift benefit entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /gft-gifts/v1/gifts/benefits - Write
Edit a gift note. (PREVIEW)
Updates the specified fields on an existing gift note. Only the provided fields are updated; omitted fields retain their current values. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /gft-gifts/v2/gifts/{gift_id}/notes/{note_id} - Write
Edit Batch Gift (PREVIEW)
Updates a batch gift ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /gft-gifts/v2/batchgifts/{batchGiftId} - Write
Edit gift benefit notes. (PREVIEW)
Updates the benefit notes for a specified gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /gft-gifts/v1/gifts/benefits/notes - Write
Edit payment information for a recurring gift (PREVIEW)
Edits payment information for a recurring gift paid by credit card. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /gft-gifts/v2/recurringgifts/{gift_id}/amendments/paymentinformation - Write
Edits an existing asset on a planned gift. (PREVIEW)
Updates the specified asset fields on an existing planned gift asset. Only the provided fields are updated; omitted fields retain their current values. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /gft-gifts/v2/gifts/{gift_id}/plannedgift/assets/{asset_id} - Write
Edits an existing beneficiary on a planned gift. (PREVIEW)
Updates the specified fields on an existing planned gift beneficiary. Only the provided fields are updated; omitted fields retain their current values. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /gft-gifts/v2/gifts/{gift_id}/plannedgift/beneficiaries/{beneficiary_id} - Write
Edits an existing planned gift. (PREVIEW)
Updates the specified fields on an existing planned gift. Only the provided fields are updated; omitted fields retain their current values. Supports all vehicle types with a single flat model. The vehicle type itself is immutable and cannot be changed after creation. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /gft-gifts/v2/gifts/{gift_id}/plannedgift - Write
Edits an existing relationship on a planned gift. (PREVIEW)
Updates the specified fields on an existing planned gift relationship. Only the provided fields are updated; omitted fields retain their current values. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /gft-gifts/v2/gifts/{gift_id}/plannedgift/relationships/{relationship_id} - Write
Generate pledge installments from schedule (PREVIEW)
This generates the installments for a given schedule. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /gft-gifts/v2/gifts/generateinstallments - Write
Links a gift to a planned gift. (PREVIEW)
Associates the specified gift with a planned gift. The gift must not be a planned gift itself, and the planned gift must belong to the same constituent as the gift. When ignore_warnings is false (default), the operation returns warnings about side effects (e.g., Gift Aid qualification changes in UK environments). When ignore_warnings is true, the operation proceeds and executes those side effects. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /gft-gifts/v2/gifts/{gift_id}/plannedgiftlink - Write
Sell a stock gift (PREVIEW)
This updates a stock gift to sold with the given details. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /gft-gifts/v2/gifts/{gift_id}/stock/sell - Destructive
Delete a gift benefit. (PREVIEW)
Deletes an existing gift benefit entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /gft-gifts/v1/gifts/benefits/{benefit_id} - Destructive
Delete a gift note. (PREVIEW)
Deletes the specified note from the gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /gft-gifts/v2/gifts/{gift_id}/notes/{note_id} - Destructive
Deletes a beneficiary from a planned gift. (PREVIEW)
Permanently removes the specified beneficiary from the planned gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /gft-gifts/v2/gifts/{gift_id}/plannedgift/beneficiaries/{beneficiary_id} - Destructive
Deletes a relationship from a planned gift. (PREVIEW)
Permanently removes the specified relationship from the planned gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /gft-gifts/v2/gifts/{gift_id}/plannedgift/relationships/{relationship_id} - Destructive
Deletes an asset from a planned gift. (PREVIEW)
Permanently removes the specified asset from the planned gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /gft-gifts/v2/gifts/{gift_id}/plannedgift/assets/{asset_id} - Destructive
Unlinks a gift from its planned gift. (PREVIEW)
Removes the planned gift association from the specified gift. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /gft-gifts/v2/gifts/{gift_id}/plannedgiftlink
Gift Batch
- Read
List gift batches
Returns a list of gift batches.
GET /gift-batch/v1/giftbatches - Write
Create gift batch
Creates a gift batch.
POST /gift-batch/v1/giftbatches - Destructive
Delete gift batch
Deletes a gift batch.
DELETE /gift-batch/v1/giftbatches/{batch_id}
Grantmaking
- Read
Gets the classifications for Activities.
Fetches the coding tables associated with the Activities.
GET /grantmaking/api/v1/activities/classifications - Read
Gets the classifications for Contacts.
Fetches the coding tables associated with the Contacts. Includes coding sheet properties when applicable.
GET /grantmaking/api/v1/contacts/classifications - Read
Gets the classifications for Organizations.
Fetches the coding tables associated with the Organizations. Includes coding sheet properties when applicable.
GET /grantmaking/api/v1/organizations/classifications - Read
Gets the classifications for Payments.
Fetches the coding tables associated with the Payments.
GET /grantmaking/api/v1/payments/classifications - Read
Gets the classifications for Requests.
Fetches the coding tables associated with the Requests. Includes coding sheet properties when applicable.
GET /grantmaking/api/v1/requests/classifications - Read
Gets the classifications for Requirements.
Fetches the coding tables associated with the Requirements.
GET /grantmaking/api/v1/requirements/classifications - Read
Return a Contact.
Fetches a Contact from the Grantmaking system.
GET /grantmaking/api/v1/contacts/{contact_id} - Read
Return a Payment.
Fetches a Payment from the Grantmaking system.
GET /grantmaking/api/v1/payments/{payment_id} - Read
Return a Request.
Fetches a Request from the Grantmaking system.
GET /grantmaking/api/v1/requests/{request_id} - Read
Return a Requirement.
Fetches a Requirement from the Grantmaking system.
GET /grantmaking/api/v1/requirements/{requirement_id} - Read
Return an Activity.
Fetches an Activity from the Grantmaking system.
GET /grantmaking/api/v1/activities/{activity_id} - Read
Return an Organization.
Fetches an Organization from the Grantmaking system.
GET /grantmaking/api/v1/organizations/{organization_id} - Write
Create a Refund Payment in Grantmaking.
Create a Refund Payment record in Grantmaking associated with the same Refund from the payment service.
POST /grantmaking/api/v1/payments/refund - Write
Return Requests with the provided IDs.
Fetches Requests from the Grantmaking system.
POST /grantmaking/api/v1/requests/ids - Write
Return the Scheduled Payments.
Fetches the Scheduled Payments from the Grantmaking system.
POST /grantmaking/api/v1/payments/search/scheduled - Write
Search for Activities which meet the provided criteria.
Fetches Grantmaking Activities that meet the provided search criteria.
POST /grantmaking/api/v1/activities/search - Write
Search for Contacts which meet the provided criteria.
Fetches Grantmaking Contacts that meet the provided search criteria.
POST /grantmaking/api/v1/contacts/search - Write
Search for Organizations which meet the provided criteria.
Fetches Grantmaking Organizations that meet the provided search criteria.
POST /grantmaking/api/v1/organizations/search - Write
Search for Payments which meet the provided criteria.
Fetches Grantmaking Payments that meet the provided search criteria.
POST /grantmaking/api/v1/payments/search - Write
Search for Requests which meet the provided criteria.
Fetches Grantmaking Requests that meet the provided search criteria.
POST /grantmaking/api/v1/requests/search - Write
Search for Requirements which meet the provided criteria.
Fetches Grantmaking Requirements that meet the provided search criteria.
POST /grantmaking/api/v1/requirements/search - Write
Set the status of a Payment to Canceled.
Update the status of a Grantmaking Payment to the Canceled status.
POST /grantmaking/api/v1/payments/cancel - Write
Set the status of a Payment to Paid.
Update the status of a Grantmaking Payment to the Paid status.
POST /grantmaking/api/v1/payments/pay - Write
Updates a Payment in the Grantmaking system.
Updates a Payment in the Grantmaking system
POST /grantmaking/api/v1/payments/update - Write
Updates a Request in the Grantmaking system.
Updates a Request in the Grantmaking system.
POST /grantmaking/api/v1/requests - Write
Updates an Organization in the Grantmaking system.
Updates an Organization in the Grantmaking system
POST /grantmaking/api/v1/organizations/update - Destructive
Void a Paid Payment.
Void a Paid Payment, creating a new Payment with a status of Void and a negative amount.
POST /grantmaking/api/v1/payments/void
GrantsConnect
- Read
Download an application (PREVIEW)
Retrieves a temporary URL to download an application in PDF format. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /grants-connect/v1/applications/{application_id}/fileuploads/{file_upload_id} - Read
Get applicants (PREVIEW)
Retrieves information about the applicants and collaborators for an application. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /grants-connect/v1/applications/{application_id}/applicants - Read
Get application forms (PREVIEW)
Retrieves information about application forms. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /grants-connect/v1/applications/{application_id}/forms - Read
Get budget funding source details (PREVIEW)
Retrieves information about the funding sources connected to a budget. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /grants-connect/v1/budgets/{budget_id}/budgetfundingsources - Read
Get file uploads for an application (PREVIEW)
Retrieves information about the file uploads for an application. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /grants-connect/v1/applications/{application_id}/fileuploads - Read
Get in-kind items for a payment (PREVIEW)
Retrieves information about the in-kind items included in a payment. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /grants-connect/v1/payments/{payment_id}/inkinditems - Read
Get in-kind items for an application (PREVIEW)
Retrieves information about the in-kind items awarded for a specific application. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /grants-connect/v1/applications/{application_id}/inkinditems - Read
Get in-kind items for an award (PREVIEW)
Retrieves information about the in-kind items included in an award for a specific application. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /grants-connect/v1/awards/{award_id}/inkinditems - Read
Get picklist options (PREVIEW)
Retrieves information about all picklist options for the specified picklist. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /grants-connect/v1/picklist/{picklist_id}/picklistoptions - Read
Get picklists (PREVIEW)
Retrieves information about all picklists. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /grants-connect/v1/picklist - Write
Add a picklist option (PREVIEW)
Adds a new picklist option to an existing picklist. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/picklist/{picklist_id}/picklistoptions - Write
Bulk add or edit picklist options (PREVIEW)
Adds or edits multiple picklist options at the same time. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/picklist/{picklist_id}/addeditpicklistoptionsbulk - Write
Create a payment (PREVIEW)
Creates a payment for an approved and awarded application. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/payments - Write
Edit a payment (PREVIEW)
Edits an existing cash or in-kind payment. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /grants-connect/v1/payments/{payment_id} - Write
Edit a picklist option (PREVIEW)
Edits an existing picklist option. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /grants-connect/v1/picklist/picklistoptions/{picklist_option_id} - Write
Get applicant form response translations (PREVIEW)
Retrieves information about form fields. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/formfields/{application_form_id}/applicantresponsetranslations - Write
Search applicants (PREVIEW)
Retrieves information about applicants. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/applicants/search - Write
Search applications (PREVIEW)
Retrieves information about applications. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/applications/search - Write
Search awards (PREVIEW)
Retrieves information about awards. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/awards/search - Write
Search budgets (PREVIEW)
Retrieves information about budgets. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/budgets/search - Write
Search form fields (PREVIEW)
Retrieves information about form fields. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/formfields/search - Write
Search funding sources (PREVIEW)
Retrieves information about funding sources. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/fundingsources/search - Write
Search grant program activity (PREVIEW)
Retrieves information about grant activities. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/activities/{application_id} - Write
Search payments (PREVIEW)
Retrieves information about payments. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/payments/search - Write
Search roles (PREVIEW)
Search roles. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/roles/search - Write
Search system tags (PREVIEW)
Retrieves information about system tags. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/tags/search - Write
Search user role by details (PREVIEW)
Retrieves information about user roles. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/userroles/search - Write
Search users (PREVIEW)
Retrieves information about users. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/users/search - Write
Search workflow levels (PREVIEW)
Retrieves information about workflows. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/workflows/{workflow_id}/workflowlevels - Write
Search workflow managers (PREVIEW)
Retrieves information about workflow managers. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/workflowmanagers/search - Write
Search workflows (PREVIEW)
Search user workflow levels ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/userworkflowlevels/search - Write
Search workflows (PREVIEW)
Retrieves information about workflows. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /grants-connect/v1/workflows/search - Destructive
Delete a payment (PREVIEW)
Deletes a payment from an award. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /grants-connect/v1/payments/{payment_id}
User Identity
- Read
Get user info
Returns account information for the authenticated user, including their name, email address, and Blackbaud ID.
GET /idn-idact/v1/user/info
Import
- Read
Get a job (PREVIEW)
Gets an import job. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /import/jobs/{job_id} - Read
Get exception file download URI (PREVIEW)
Gets the download URI for an import job's exception file. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /import/jobs/{job_id}/exceptionfiledownloadinfo - Read
Get import file upload request (PREVIEW)
Gets new upload information — the URL, HTTP method, and headers to send — for a pending import job's import file. Requesting new upload information invalidates any previously uploaded import file; the import file must be uploaded as described in this response, not with upload information obtained from an earlier request. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /import/jobs/{job_id}/uploadrequest - Read
Get import file upload URI (PREVIEW)
Deprecated: use GetJobUploadRequest, which also returns the HTTP method and headers required for the upload. Gets a new file upload URI for a pending import job. Requesting a new upload URI invalidates any previously uploaded import file; the import file must be uploaded using the URI from this response, not an upload URI obtained from an earlier request. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /import/jobs/{job_id}/uploaduri - Read
Get jobs (PREVIEW)
Gets import jobs for the current environment. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /import/jobs - Read
Get JSON import schema (PREVIEW)
Returns the JSON schema for JSONL import files. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /import/jsonimportschema - Write
Create a job (PREVIEW)
Creates a new import job. As a best practice, review the field mappings in the response before uploading the import file; uploading the file should be the last step before starting the job. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /import/jobs - Write
Edit a job (PREVIEW)
Edits an import job. Changing `file_name` or `header_row` invalidates any previously uploaded import file; the replacement file must be uploaded using the `file_upload_request` returned in the response, not upload information obtained from an earlier request. `file_upload_request` is only included in the response when the edit changed `file_name` or `header_row`; it is omitted otherwise, and any previously uploaded file remains valid. As a best practice, review the field mappings in the response before uploading the import file; uploading the file should be the last step before starting the job. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /import/jobs/{job_id} - Write
Start a job (PREVIEW)
Starts a pending import job. Call this after the import file has been uploaded. The uploaded file must not exceed the maximum import file size (50 MB by default). A larger file is rejected with an `import-file-too-large` error whose `values` member carries `max_file_size_bytes` (and `file_size_bytes` when known); the job stays pending, so you can request a new upload request (`GET jobs/{job_id}/uploadrequest`), upload a smaller file, and start the job again. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /import/jobs/start - Destructive
Delete a job (PREVIEW)
Deletes an import job. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /import/jobs/{job_id}
JustGiving Consumer User
- Read
Get a pre-signed URL for the user's donations CSV
Returns a pre-signed AWS URL for downloading the page's donations as a CSV file, delivering just the signedURL string. Formerly known as: GetFundraisingPageDonationsCsv The **jg.fundraise** SKY API application scope is required.
GET /jg/consumer/user/consumer/context/v1/fundraising/pages/{pageGuid}/donations/csv - Read
Get a team's details for the authenticated user
Retrieves v3 team details by short name, returning team identity, status, donation summary totals, paginated membership list and campaign/tribute metadata. Formerly known as: GetTeamV3 The **jg.fundraise** SKY API application scope is required.
GET /jg/consumer/user/consumer/context/v1/teamsv3/{teamShortName} - Read
Get page donations by third-party reference
Retrieves donations for a page filtered by third-party reference, returning a paginated donations array plus pagination metadata. Formerly known as: GetFundraisingPageDonationsByReference The **jg.fundraise** SKY API application scope is required.
GET /jg/consumer/user/consumer/context/v1/fundraising/pages/{pageShortName}/donations/ref/{thirdPartyReference} - Read
Get the authenticated user's fundraising pages
Lists all fundraising pages for the authenticated user, returning an array of pages with titles, status, short names, amounts raised, images and event data. Formerly known as: GetFundraisingPages The **jg.fundraise** SKY API application scope is required.
GET /jg/consumer/user/consumer/context/v1/fundraising/pages - Read
Get the signed-in user's donation details
Gets full details of a single donation by donation ID, returning amount, currency, donor display name, date, message, estimated tax reclaim, source and status. Formerly known as: RetrieveDonationDetails The **jg.fundraise** SKY API application scope is required.
GET /jg/consumer/user/consumer/context/v1/donation/{donationId} - Read
Get the signed-in user's fundraising page donations by ID
Retrieves donations for a page by page ID or short name (V2 variant), returning a paginated donations array with amounts, donor details, messages, status and pagination metadata. Formerly known as: GetFundraisingPageDonationsByIdV2 The **jg.fundraise** SKY API application scope is required.
GET /jg/consumer/user/consumer/context/v1/fundraising/donations - Read
Get the signed-in user's unclaimed-page claim record
Returns the claim record for a given claim short name, including claimer contact details, page content, activity/occasion, target amount and associated charity, campaign, team and event data. Formerly known as: GetUnclaimedPage The **jg.fundraise** SKY API application scope is required.
GET /jg/consumer/user/consumer/context/v1/unclaimedpage/getunclaimedpage/{shortName} - Read
Get the user's fundraising page thank-you message
Returns the message shown to donors after they give to this page. Only the page owner can read it. The **jg.fundraise** SKY API application scope is required.
GET /jg/consumer/user/consumer/context/v1/fundraising/pages/{pageShortName}/thankyou - Write
Add an image to the authenticated user's fundraising page
Adds an image (by caption/URL/default flag) to a page, returning next-link references containing the image resource URL and page URI. Formerly known as: AddImageToFundraisingPage The **jg.fundraise** SKY API application scope is required.
PUT /jg/consumer/user/consumer/context/v1/fundraising/pages/{pageShortName}/images - Write
Add the authenticated user's fundraising page to a team
Requests to join a v2 team with a fundraising page; returns only status codes since the request is sent to the team owner or auto-approved for open teams. Formerly known as: JoinTeamV2 The **jg.fundraise** SKY API application scope is required.
PUT /jg/consumer/user/consumer/context/v1/teams/join/{teamShortName} - Write
Close the user's fundraising page
Closes a fundraising page owned by the user, returning an empty body on success with errorMessage only on failure. Formerly known as: CloseFundraisingPage The **jg.fundraise** SKY API application scope is required.
PUT /jg/consumer/user/consumer/context/v1/fundraising/pages/{pageShortName}/close - Write
Create a fundraising page for the authenticated user
Registers a new fundraising page, returning the new pageId, a single-use signOnUrl, and next-link references to the created page. Formerly known as: RegisterFundraisingPage The **jg.fundraise** SKY API application scope is required.
PUT /jg/consumer/user/consumer/context/v1/fundraising/pages - Write
Create a team for the authenticated user
Creates a new v2 fundraising team and returns its numeric ID, teamGuid, public teamUrl and a next link to the team resource. Formerly known as: CreateTeamV2 The **jg.fundraise** SKY API application scope is required.
PUT /jg/consumer/user/consumer/context/v1/teams - Write
Register an unclaimed fundraising page for the user
Registers an unclaimed fundraising page tied to a holding user for later claiming. Formerly known as: RegisterUnClaimedFundraisingPage The **jg.fundraise** SKY API application scope is required.
PUT /jg/consumer/user/consumer/context/v1/fundraising/unclaimedpages - Write
Set the user's fundraising page default image
Sets an existing image as the page's default image via PUT; no response body is documented for the operation. Formerly known as: UpdateFundraisingPageDefaultImage The **jg.fundraise** SKY API application scope is required.
PUT /jg/consumer/user/consumer/context/v1/fundraising/pages/{pageShortName}/images/default - Write
Update a team's details
Updates an existing v2 team's details and returns the team ID, teamGuid, public teamUrl and a next link to the team resource. Formerly known as: UpdateTeamV2 The **jg.fundraise** SKY API application scope is required.
PUT /jg/consumer/user/consumer/context/v1/teamsv2/byguid/{teamGuid} - Write
Update the user's fundraising page expiry date
Extends a page's lifetime by updating its expiry date, returning the new expiryDate timestamp. Formerly known as: ExtendFundraisingPage The **jg.fundraise** SKY API application scope is required.
PUT /jg/consumer/user/consumer/context/v1/fundraising/pages/{pageShortName}/extend - Write
Update the user's fundraising page story
Updates a fundraising page's narrative story, returning the updated story text. Formerly known as: UpdateFundraisingPageStory The **jg.fundraise** SKY API application scope is required.
PUT /jg/consumer/user/consumer/context/v1/fundraising/pages/{pageShortName}/pagestory - Write
Update the user's fundraising page title
Updates a fundraising page's title, returning the updated pageTitle. Formerly known as: UpdateFundraisingPageTitle The **jg.fundraise** SKY API application scope is required.
PUT /jg/consumer/user/consumer/context/v1/fundraising/pages/{pageShortName}/pagetitle - Destructive
Cancel the user's fundraising page
Cancels/removes a fundraising page owned by the authenticated user, communicating the outcome purely through the HTTP status code. Formerly known as: CancelFundraisingPage The **jg.fundraise** SKY API application scope is required.
DELETE /jg/consumer/user/consumer/context/v1/fundraising/pages/{pageShortName} - Destructive
Delete an image from the user's fundraising page
Deletes a specified image from a fundraising page; no response body is documented for the operation. Formerly known as: DeleteFundraisingPageImage The **jg.fundraise** SKY API application scope is required.
DELETE /jg/consumer/user/consumer/context/v1/fundraising/pages/{pageShortName}/images/{imageName}
JustGiving Consumer Public
- Read
Check whether a fundraising page short name is taken
Checks whether a page short name is available for registration, signalling the result purely through the HTTP status code with no response body: 200 means the short name is already registered and 404 means it is available. Formerly known as: FundraisingPageUrlCheck
HEAD /jg/consumer/app/consumer/v1/fundraising/pages/{pageShortName} - Read
Get a campaign by its short name
Retrieves a campaign by its short name, returning the full campaign profile: title, story, target, currency, status, linked charities and a donation summary. Formerly known as: GetCampaignByShortName
GET /jg/consumer/app/consumer/v1/campaign/byshortname/{shortName} - Read
Get a campaign by its unique identifier
Retrieves a V2 campaign by GUID, returning the full campaign profile: title, story, target, currency, status, charities and donation summary. Formerly known as: GetCampaignByGuid
GET /jg/consumer/app/consumer/v1/campaign/byguid/{campaignGuid} - Read
Get a campaign's totals by GUID
Retrieves donation totals for a V2 campaign by GUID, returning direct/fundraiser amounts, Gift Aid, offline totals, target and third-party reference totals. Formerly known as: GetCampaignTotalsByGuid
GET /jg/consumer/app/consumer/v1/campaign/byguid/{campaignGuid}/totals - Read
Get a campaign's totals by short name
Retrieves donation totals for a campaign by short name, returning direct/fundraiser amounts, Gift Aid, offline totals, target and third-party reference totals. Formerly known as: GetCampaignTotalsByShortName
GET /jg/consumer/app/consumer/v1/campaign/byshortname/{shortName}/totals - Read
Get a charity's details
Retrieves a lightweight, cacheable charity profile by charity ID, returning name, description, address, logo/page URLs, registration and contact details, categories, and country/currency codes. Formerly known as: GetCharityById
GET /jg/consumer/app/consumer/v1/charity/{charityId} - Read
Get a crowdfunding page's details by id
Retrieves full details of a crowdfunding page by ID, returning pledged/raised amounts, owner, location, pitch, story sections and images. Formerly known as: GetCrowdfundingPageDetailsById
GET /jg/consumer/app/consumer/v1/crowdfunding/pagebyid/{pageId} - Read
Get a donation by its ID
Gets full details of a single donation by donation ID, returning amount, currency, donor display name, date, message, estimated tax reclaim, source and status. Formerly known as: RetrieveDonationDetails
GET /jg/consumer/app/consumer/v1/donation/{donationId} - Read
Get a fundraising page or claim record by prefix and name
Retrieves full fundraising page details (V2 variant), returning page identity, status, activity, fundraising totals, charity, branding and media data. Formerly known as: GetFundraisingPageDetailsV2
GET /jg/consumer/app/consumer/v1/fundraising/pages/{prefix}/{pageShortName} - Read
Get a fundraising page's donations by ID or name
Retrieves donations for a page by page ID or short name (V2 variant), returning a paginated donations array with amounts, donor details, messages, status and pagination metadata. Formerly known as: GetFundraisingPageDonationsByIdV2
GET /jg/consumer/app/consumer/v1/fundraising/donations - Read
Get a fundraising page's donations by prefix
Retrieves donations for a page by short name (V2 variant), returning a paginated donations array with amounts, donor details, messages, status and pagination metadata. Formerly known as: GetFundraisingPageDonationsV2
GET /jg/consumer/app/consumer/v1/fundraising/pages/{prefix}/{pageShortName}/donations - Read
Get a fundraising page's donations by reference
Retrieves donations for a page filtered by third-party reference, returning a paginated donations array plus pagination metadata. Formerly known as: GetFundraisingPageDonationsByReference
GET /jg/consumer/app/consumer/v1/fundraising/pages/{pageShortName}/donations/ref/{thirdPartyReference} - Read
Get a fundraising page's images
Retrieves all images for a page by short name, returning an array of image objects with caption, relative url and absoluteUrl. Formerly known as: GetImagesForFundraisingPage
GET /jg/consumer/app/consumer/v1/fundraising/pages/{pageShortName}/images - Read
Get a fundraising page's updates
Retrieves timeline page updates for a fundraising page. Formerly known as: PageUpdatesV2
GET /jg/consumer/app/consumer/v1/fundraising/pages/{pageShortName}/updatesv2 - Read
Get a fundraising page's videos
Retrieves all videos for a page by short name, returning an array of video objects with caption and url. Formerly known as: GetVideosForFundraisingPage
GET /jg/consumer/app/consumer/v1/fundraising/pages/{pageShortName}/videos - Read
Get a single event by its identifier
Retrieves a single event by ID, returning its name, description, dates (start/completion/expiry), type and location. Formerly known as: GetEventById
GET /jg/consumer/app/consumer/v1/event/{eventId} - Read
Get a team's details
Retrieves v3 team details by short name, returning team identity, status, donation summary totals, paginated membership list and campaign/tribute metadata. Formerly known as: GetTeamV3
GET /jg/consumer/app/consumer/v1/teamsv3/{teamShortName} - Read
Get an unclaimed page's claim record by short name
Returns the claim record for a given claim short name, including claimer contact details, page content, activity/occasion, target amount and associated charity, campaign, team and event data. Formerly known as: GetUnclaimedPage
GET /jg/consumer/app/consumer/v1/unclaimedpage/getunclaimedpage/{shortName} - Read
Get the details of a fundraising page by ID
Retrieves full page details by page ID, returning identity, status, activity, fundraising totals, donation count, charity, branding and media data. Formerly known as: GetFundraisingPageDetailsById
GET /jg/consumer/app/consumer/v1/fundraising/pagebyid/{pageId} - Read
Get the donations for a third-party reference
Retrieves a paginated list of donations matching a third-party (SDI) reference, returning per-donation details plus pagination metadata. Formerly known as: RetrieveDonationDetailsByReference
GET /jg/consumer/app/consumer/v1/donation/ref/{thirdPartyReference} - Read
Get the events run by a charity
Returns a paginated list of a charity's fundraising events by charity ID, including each event's name, type, location, and dates plus pagination metadata. Formerly known as: GetEventsByCharityId
GET /jg/consumer/app/consumer/v1/charity/{charityId}/events - Read
Get the fundraising pages registered for an event
Returns paginated fundraising-page summaries for an event, including aggregate totals raised and per-page details. Formerly known as: GetPagesForEvent
GET /jg/consumer/app/consumer/v1/event/{eventId}/pages - Read
Get the fundraising-page leaderboard across events
Returns a paginated fundraising leaderboard across specified events: event/currency details, aggregated totals and donation count, plus a ranked pages collection and pagination metadata. Formerly known as: GetLeaderboardForEvents
GET /jg/consumer/app/consumer/v1/events/leaderboard - Read
Get the status of a donation by its ID
Gets the status of a donation by donation ID (deprecated, removed in V2), returning amount, donation/SDI references and status. Formerly known as: RetrieveDonationStatus
GET /jg/consumer/app/consumer/v1/donation/{donationId}/status - Read
Get the total donations for a third-party reference
Returns aggregate totals for donations matching a third-party reference, giving combined donation amount, count, estimated tax reclaim and currency. Formerly known as: RetrieveDonationTotalByReference
GET /jg/consumer/app/consumer/v1/donationtotal/ref/{thirdPartyReference} - Read
List the countries known to the Consumer API
Returns the list of allowable countries (ISO 3166-1 two-letter code and full name) for use when registering a new user account. Formerly known as: ListCountries
GET /jg/consumer/app/consumer/v1/countries - Read
List the event types known to the Consumer API
Lists all available event types, returning a collection of type objects each with ID, name, classification and description. Formerly known as: GetEventTypes
GET /jg/consumer/app/consumer/v1/event/types - Read
Search charity name suggestions within a campaign
Searches campaigns and returns an array of matching charity suggestions (name, ID, logo and description). Formerly known as: CampaignSearch
GET /jg/consumer/app/consumer/v1/campaign/autocomplete - Read
Search fundraising pages for autocomplete suggestions
Searches fundraising pages and returns a Results array of matching fundraiser pages (URL, name, owner, event/charity IDs, raised and target amounts) plus a total hit count. Formerly known as: FundraiserSearchV2
GET /jg/consumer/app/consumer/v1/fundraising/autocomplete - Read
Search remembered (in-memory) people
Searches for remembered (in-memory tribute) people, returning a paginated results array of matching person records with names, location and dates plus hit/page counts. Formerly known as: InMemorySearch
GET /jg/consumer/app/consumer/v1/remember/search - Read
Search tags for autocomplete suggestions
Searches fundraising pages by tag/keyword and returns a Results array of matching pages (URL, name, owner, event, raised/target amounts, status) with a total hit count. Formerly known as: TagsSearch
GET /jg/consumer/app/consumer/v1/tags/search - Read
Suggest fundraising page short names for a preferred name
Suggests available page short-name variations based on a preferred name, returning a Names array of alternative short-name strings. Formerly known as: SuggestPageShortNames
GET /jg/consumer/app/consumer/v1/fundraising/pages/suggest - Write
Register a new event
Programmatically creates a new event, returning the new event ID and a next link to retrieve it (HTTP 201 Created; the contract documents HTTP 200, so treat both as success). Formerly known as: RegisterEvent
POST /jg/consumer/app/consumer/v1/event - Write
Register an unclaimed fundraising page
Registers an unclaimed fundraising page tied to a holding user for later claiming. Formerly known as: RegisterUnClaimedFundraisingPage
PUT /jg/consumer/app/consumer/v1/fundraising/unclaimedpages
JustGiving Data
- Read
Get custom codes for a page (PREVIEW)
Retrieves the custom code values applied to a given fundraising page. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /jg/data/v1/charity/pages/{page_id}/customcodes - Read
Get custom codes for an event (PREVIEW)
Retrieves the custom code values applied to a given fundraising event. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /jg/data/v1/charity/events/{event_id}/customcodes - Read
Get donations list (PREVIEW)
Retrieves the donations list for the charity between a date interval of maximum 3 months ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /jg/data/v1/charity/donations/{start_date}/{end_date} - Read
Get pages created (PREVIEW)
Retrieves a list of all pages created for a specific event within the specified date range ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /jg/data/v1/charity/pages/created/{start_date}/{end_date} - Read
Get Pages created for Event (PREVIEW)
Retrieves a list of all pages created for a specific event within the specified date range ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /jg/data/v1/charity/pages/created/events/{event_id}/{start_date}/{end_date} - Read
Get pages modified (PREVIEW)
Retrieves a list of all pages modified within the specified date range ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /jg/data/v1/charity/pages/modified/{start_date}/{end_date} - Read
Get pages modified for event (PREVIEW)
Retrieves a list of all pages modified for a specific event within the specified date range ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /jg/data/v1/charity/pages/modified/events/{event_id}/{start_date}/{end_date} - Read
Get payment by id (PREVIEW)
Retrieves a detailed breakdown of a single payment. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /jg/data/v1/charity/payments/{payment_id} - Read
Get Payment Summary List (PREVIEW)
Retrieves a list of payment summaries for the charity within the specified date range. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /jg/data/v1/charity/payments/{start_date}/{end_date} - Read
Search Pages Created (PREVIEW)
Fetches all the pages created based on the filters provided in the query string ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /jg/data/v1/charity/pages/created/{start_date}/{end_date}/search - Read
Search Pages Modifed (PREVIEW)
Fetches all the pages modified based on the filters provided in the query string ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /jg/data/v1/charity/pages/modified/{start_date}/{end_date}/search - Write
Edit custom codes for a page (PREVIEW)
Applies one or more custom code values to a fundraising page. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PUT /jg/data/v1/charity/pages/{page_id}/customcodes - Write
Edit custom codes for an event (PREVIEW)
Applies one or more custom code values to a fundraising event. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PUT /jg/data/v1/charity/events/{event_id}/customcodes - Write
Edit custom codes for multiple events (PREVIEW)
Applies custom code values to multiple fundraising events in a single batch operation. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PUT /jg/data/v1/charity/events/customcodes - Write
Edit custom codes for multiple pages (PREVIEW)
Applies custom codes to multiple pages in a single batch operation. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PUT /jg/data/v1/charity/pages/customcodes
List
- Read
Get a list of lists
Returns a list of lists for the given list type
GET /list/lists?list_type={list_type} - Write
Append identifiers to a list
Appends a set of identifiers to the filter of an existing list. The list_id parameter cannot reference a list that was created from a static query. The ids parameter is limited to 100,000 identifiers.
POST /list/appendidstolist - Write
Create a list from set of identifiers
Creates a new list filtered to the specified set of identifiers. Returns a unique identifier for the new list The name parameter must be unique and not in use on an existing list. The ids parameter is limited to 100,000 identifiers. The name parameter is limited to 50 characters
POST /list/createlistfromids
Lists V2
- Read
Get a data model (PREVIEW)
Returns information about a specific data model ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /lst-lists/datamodels/{modelName} - Read
Get data model list (PREVIEW)
Returns the list of available data models ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /lst-lists/datamodels - Write
Calculates the total count of records (PREVIEW)
Calculates the total count of records which meet the criteria of the request ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /lst-lists/count - Write
Executes a query request (PREVIEW)
Executes a query to return a list of records ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /lst-lists/executequery - Write
Executes an advanced aggregation request (PREVIEW)
Executes an advanced aggregation request ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /lst-lists/executeadvancedaggregation - Write
Executes an aggregation request (PREVIEW)
Executes an aggregation operation against a data model ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /lst-lists/executeaggregation
List Management
- Read
Gets a list (PREVIEW)
Returns a saved list ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /lst-lstmg/lists/{list_id} - Write
Creates a new list (PREVIEW)
Saves a new list ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /lst-lstmg/lists - Write
Edits an existing list (PREVIEW)
Edits an existing, saved list ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /lst-lstmg/lists/{list_id} - Destructive
Deletes an existing list (PREVIEW)
Deletes an existing, saved list ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /lst-lstmg/lists/{list_id}
Membership
- Read
Get a single membership card
Returns a single membership card by ID
GET /membership/v1/memberships/{member_junction_id}/membershipcards/{membership_card_id} - Read
Get gift of membership
Returns the gift of membership.
GET /membership/v1/memberships/{member_junction_id}/membershipgift - Read
Get linked gifts for membership
Returned linked gifts by joint membership ID
GET /membership/v1/memberships/{member_junction_id}/linkedgifts - Read
Get membership benefits list
Returns the membership benefits list.
GET /membership/v1/memberships/{member_junction_id}/benefits - Read
Get membership cards for membership
Returned membership cards by member junction ID
GET /membership/v1/memberships/{member_junction_id}/membershipcards - Read
Get membership category list
Returns a membership category list.
GET /membership/v1/memberships/categories - Read
Get membership custom field category details
Returns list of membership custom field category details.
GET /membership/v1/memberships/customfields/categories/details - Read
Get membership custom field category values
Returns list of membership custom field category values.
GET /membership/v1/memberships/customfields/categories/{category_name}/values - Read
Get membership custom fields
Returns the membership custom fields.
GET /membership/v1/memberships/{member_junction_id}/customfields - Read
Get membership default benefits list
Returns the membership default benefits list.
GET /membership/v1/memberships/categories/{membership_category_id}/benefits - Read
Get membership detail based on membership
Returns membership detail by member junction ID.
GET /membership/v1/memberships/{member_junction_id}/membershipdetails - Read
Get membership fundraisers list
Returns the membership assigned fundraisers list.
GET /membership/v1/memberships/{memberjunction_id}/fundraisers - Read
Get membership history list
Returns the membership history list by member junction ID.
GET /membership/v1/memberships/{member_junction_id}/transactions - Read
Get membership junction IDs for a constituent.
Return membership junction IDs by constituent ID
GET /membership/v1/constituents/{constituent_id}/membershipjunctionids - Read
Get membership junction IDs for a gift.
Return membership junction IDs by gift ID
GET /membership/v1/memberships/gifts/{gift_id}/membershipjunctionids - Read
Get membership renewal notice information
Returns the membership renewal notice information.
GET /membership/v1/memberships/categories/{membership_category_id}/renewalnotices - Read
Get membership subcategory list based on category.
Returns a list of membership subcategories by category ID.
GET /membership/v1/memberships/categories/{membership_category_id}/subcategories - Read
Get membership summary based on membership
Returned membership summary by member junction ID
GET /membership/v1/memberships/{member_junction_id}/membershipsummary - Read
Get single-transaction detail (PREVIEW)
Returns the full detail for a single membership transaction, aggregating membership details, fundraisers, gift of membership, benefits and linked gifts. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /membership/v1/memberships/{member_junction_id}/transactions/{transaction_id} - Read
Get the available gift amount
Returns the remaining available gift amount
GET /membership/v1/memberships/gifts/{gift_id}/availableamount - Write
Add a linked gift for membership
Add link to gift
POST /membership/v1/memberships/{member_junction_id}/addlinktogift - Write
Add membership cards
Add list of membership card
POST /membership/v1/memberships/{member_junction_id}/membershipcard - Write
Add membership custom fields
Add membership custom fields.
POST /membership/v1/memberships/{member_junction_id}/customfields - Write
Add membership endpoint
Creates a membership endpoint.
POST /membership/v1/constituents/{constituent_id}/membership - Write
Add membership endpoint
Creates a membership endpoint.
POST /membership/v1/constituents/{constituent_id}/v2/membership - Write
Add membership fundraiser
Add list of fundraiser
POST /membership/v1/memberships/{member_junction_id}/fundraiser - Write
Downgrade a membership during cycle
Downgrades a membership during cycle. Only Active memberships can be downgraded.
POST /membership/v1/memberships/{member_junction_id}/downgrade - Write
Drop a membership
Drops a membership. Only Active or Lapsed memberships can be dropped.
POST /membership/v1/memberships/{member_junction_id}/drop - Write
Edit a linked gift for membership
Edit the applied amount for a linked gift on a membership.
PATCH /membership/v1/memberships/{member_junction_id}/linkedgifts/{gift_id} - Write
Edit a membership card
Edits a membership card with the specified changes. **Note:** Depending on the type of update, you may need to include additional fields in the request body. For example: - To change the **Valid From** or **Valid To** dates, include `card_expires`. - To change the **name on the card**, include `card_member` and `editable`.
PATCH /membership/v1/memberships/{member_junction_id}/membershipcards/{membership_card_id} - Write
Edit membership custom field
Edit membership custom field.
PATCH /membership/v1/memberships/{member_junction_id}/customfield/{custom_field_id} - Write
Edit membership detail endpoint
Edit membership detail.
PATCH /membership/v1/memberships/{member_junction_id}/editmembershipdetails - Write
Rejoin a dropped membership
Rejoins a dropped membership. Only Dropped memberships can be rejoined.
POST /membership/v1/memberships/{member_junction_id}/rejoin - Write
Renew a membership
Renews a membership. Supports renewal at the same level, upgrade, or downgrade.
POST /membership/v1/memberships/{member_junction_id}/renew - Write
Update gift of membership
Update the gift of membership.
PATCH /membership/v1/memberships/{member_junction_id}/updatemembershipgift - Write
Upgrade a membership during cycle
Upgrades a membership during cycle. Only Active memberships can be upgraded.
POST /membership/v1/memberships/{member_junction_id}/upgrade - Destructive
Delete a linked gift for membership
Removes a linked gift from a membership.
DELETE /membership/v1/memberships/{member_junction_id}/linkedgifts/{gift_id} - Destructive
Delete a membership
Deletes a membership.
DELETE /membership/v1/memberships/{member_junction_id} - Destructive
Delete a membership card
Deletes a membership card. Note: The primary member card cannot be deleted.
DELETE /membership/v1/memberships/{member_junction_id}/membershipcards/{membership_card_id} - Destructive
Delete a membership custom field
Deletes a membership custom field.
DELETE /membership/v1/memberships/{member_junction_id}/customfield/{custom_field_id} - Destructive
Delete a membership fundraiser
Deletes a membership fundraiser.
DELETE /membership/v1/memberships/{member_junction_id}/fundraiser/{fundraiser_id} - Destructive
Delete a membership transaction (PREVIEW)
Deletes a single membership transaction, applying the Delete Historic Information eligibility rules. When the transaction is the current Joined transaction, the entire membership record is deleted. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /membership/v1/memberships/{member_junction_id}/transactions/{transaction_id}
NXT Data Integration
- Read
Get a campaign
Returns details about a campaign.
GET /nxt-data-integration/v1/re/campaigns/{id} - Read
Get a code table
Returns details about a code table.
GET /nxt-data-integration/v1/re/codetables/{id} - Read
Get a constituent record id from constituent id
Returns a constituent system record id mapping for a given constituent id.
GET /nxt-data-integration/v1/re/constituentidmap/{constituentid} - Read
Get a constituent record id from import id
Returns a constituent system record id mapping for a given import id.
GET /nxt-data-integration/v1/re/importidmap/constituent/{importid} - Read
Get a country
Returns details about a country.
GET /nxt-data-integration/v1/re/countries/{id} - Read
Get a custom field category
Returns details about a custom field category.
GET /nxt-data-integration/v1/re/customfieldcategories/{id} - Read
Get a fund
Returns details about a fund.
GET /nxt-data-integration/v1/re/funds/{id} - Read
Get a gift note
Returns gift note details.
GET /nxt-data-integration/v1/re/gifts/notes/{id} - Read
Get a gift note list
Returns a list of gift note details.
GET /nxt-data-integration/v1/re/gifts/{gift_id}/notes - Read
Get a gift record id from gift lookup id
Returns a gift system record id mapping for a given gift lookup id.
GET /nxt-data-integration/v1/re/giftidmap/{giftlookupid} - Read
Get a gift record id from import id
Returns a gift system record id mapping for a given import id.
GET /nxt-data-integration/v1/re/importidmap/gift/{importid} - Read
Get a gift tribute by ID
Returns details about a tribute with the given ID.
GET /nxt-data-integration/v1/re/gifttribute/{giftTributeId} - Read
Get a gift tribute by import ID
Returns details about a tribute with the given import ID.
GET /nxt-data-integration/v1/re/gifttribute/importid/{importId} - Read
Get a name format configuration
Returns details about a name format configuration.
GET /nxt-data-integration/v1/re/nameformatconfigurations/{id} - Read
Get a name format configuration field
Returns details about a name format configuration field.
GET /nxt-data-integration/v1/re/nameformatconfigurations/fields/{id} - Read
Get a phone type
Returns details about a phone type.
GET /nxt-data-integration/v1/re/phonetypes/{id} - Read
Get a table entry
Returns details about a table entry.
GET /nxt-data-integration/v1/re/codetables/{code_table_id}/tableentries/{id} - Read
Get a tax declaration
Returns a Gift Aid tax declaration.
GET /nxt-data-integration/v1/re/giftaid/taxdeclarations/{id} - Read
Get a tribute
Returns details about a tribute.
GET /nxt-data-integration/v1/re/tribute/{id} - Read
Get a tribute by import id
Returns details about a tribute.
GET /nxt-data-integration/v1/re/tribute/importid/{importid} - Read
Get all gift tributes
Returns a collection of gift tributes.
GET /nxt-data-integration/v1/re/gifttribute - Read
Get an appeal
Returns details about an appeal.
GET /nxt-data-integration/v1/re/appeals/{id} - Read
Get appeal list
Returns a list of appeals.
GET /nxt-data-integration/v1/re/appeals - Read
Get campaign list
Returns a list of campaigns.
GET /nxt-data-integration/v1/re/campaigns - Read
Get code table list
Returns a list of code tables.
GET /nxt-data-integration/v1/re/codetables - Read
Get constituent list (search)
Searches for constituent records using the given filter criteria.
GET /nxt-data-integration/v1/re/constituents/customsearch - Read
Get constituent relationships for fund
Returns constituent relationships for the given fund identifier.
GET /nxt-data-integration/v1/re/relationships/constituents/fund/{fundId} - Read
Get constituents who gave to a fund
Gets constituent records that have given a gift to a specific fund.
GET /nxt-data-integration/v1/re/constituents/fund/{fundId} - Read
Get country list
Returns a list of countries.
GET /nxt-data-integration/v1/re/countries - Read
Get custom field category list
Returns a list of custom field categories.
GET /nxt-data-integration/v1/re/customfieldcategories - Read
Get fund list
Returns a list of funds.
GET /nxt-data-integration/v1/re/funds - Read
Get fund relationships for constituent
Returns fund relationships for the given constituent identifier.
GET /nxt-data-integration/v1/re/relationships/funds/constituent/{constituentId} - Read
Get funds by constituent
Returns a list of funds associated with a given constituent.
GET /nxt-data-integration/v1/re/funds/constituent/{constituentId} - Read
Get information about a user
Returns details about a user record.
GET /nxt-data-integration/v1/re/users/{id} - Read
Get installed country
Returns the installed country. Possible values: USA, UK, Canada, Spain, Australia, NewZealand
GET /nxt-data-integration/v1/re/installedcountry - Read
Get name format configuration fields list
Returns a list of name format configuration fields.
GET /nxt-data-integration/v1/re/nameformatconfigurations/fields - Read
Get name format configuration list
Returns a list of name format configurations.
GET /nxt-data-integration/v1/re/nameformatconfigurations - Read
Get phone types list
Returns a list of phone types.
GET /nxt-data-integration/v1/re/phonetypes - Read
Get serial number
Returns the serial number.
GET /nxt-data-integration/v1/re/serialnumber - Read
Get table entries list
Returns a list of table entries.
GET /nxt-data-integration/v1/re/codetables/{code_table_id}/tableentries - Read
Get tax declarations list for a constituent
Returns a list of Gift Aid tax declarations for a given constituent.
GET /nxt-data-integration/v1/re/giftaid/constituents/{id}/taxdeclarations - Read
Get tribute acknowledgees by tribute id
Returns a list of tribute acknowledgees for the given tribute.
GET /nxt-data-integration/v1/re/tribute/{tributeId}/acknowledgees - Read
Get tribute list
Returns a list of tribute.
GET /nxt-data-integration/v1/re/tribute - Read
Get tributes by constituent id
Returns a list of tributes for the given constituent.
GET /nxt-data-integration/v1/re/tribute/constituent/{constituentId} - Read
List gift tribute acknowledgees
List the acknowledgees for a gift tribute.
GET /nxt-data-integration/v1/re/gifttribute/{giftTributeId}/acknowledgees - Read
List gift tributes
List the tributes for a gift.
GET /nxt-data-integration/v1/re/gifttribute/gift/{giftId} - Write
Create a campaign
Creates a new campaign.
POST /nxt-data-integration/v1/re/campaigns - Write
Create a code table
Creates a new code table.
POST /nxt-data-integration/v1/re/codetables - Write
Create a constituent appeal
Creates a new constituent appeal.
POST /nxt-data-integration/v1/re/constitappeals - Write
Create a country
Creates a new country.
POST /nxt-data-integration/v1/re/countries - Write
Create a custom field category
Creates a new custom field category.
POST /nxt-data-integration/v1/re/customfieldcategories - Write
Create a fund
Creates a new fund.
POST /nxt-data-integration/v1/re/funds - Write
Create a gift note
Creates a note for a gift.
POST /nxt-data-integration/v1/re/gifts/notes - Write
Create a gift tribute
Creates a new gift tribute.
POST /nxt-data-integration/v1/re/gifttribute - Write
Create a name format configuration
Creates a new name format configuration.
POST /nxt-data-integration/v1/re/nameformatconfigurations - Write
Create a name format configuration field
Creates a new name format configuration field.
POST /nxt-data-integration/v1/re/nameformatconfigurations/fields - Write
Create a phone type
Creates a new phone type.
POST /nxt-data-integration/v1/re/phonetypes - Write
Create a table entry
Creates a new table entry.
POST /nxt-data-integration/v1/re/codetables/{code_table_id}/tableentries - Write
Create a tax declaration
Creates a Gift Aid tax declaration.
POST /nxt-data-integration/v1/re/giftaid/taxdeclarations - Write
Create a tribute
Creates a new tribute.
POST /nxt-data-integration/v1/re/tribute - Write
Create a tribute acknowledgee
Creates a new tribute acknowledgee. A null relationship ID indicates a self-acknowledgee.
POST /nxt-data-integration/v1/re/tribute/acknowledgee - Write
Create an appeal
Creates a new appeal.
POST /nxt-data-integration/v1/re/appeals - Write
Edit a campaign
Edit the details about a campaign.
PATCH /nxt-data-integration/v1/re/campaigns/{id} - Write
Edit a code table
Edit the details about a code table.
PATCH /nxt-data-integration/v1/re/codetables/{id} - Write
Edit a constituent appeal
Edits a constituent appeal.
PATCH /nxt-data-integration/v1/re/constitappeals/{id} - Write
Edit a country
Edit the details about a country.
PATCH /nxt-data-integration/v1/re/countries/{id} - Write
Edit a custom field category
Edit the details about a custom field category.
PATCH /nxt-data-integration/v1/re/customfieldcategories/{id} - Write
Edit a fund
Edit the details about a fund.
PATCH /nxt-data-integration/v1/re/funds/{id} - Write
Edit a gift note
Edits a note for a gift.
PATCH /nxt-data-integration/v1/re/gifts/notes/{id} - Write
Edit a gift tribute
Update the details about a gift tribute.
PATCH /nxt-data-integration/v1/re/gifttribute/{giftTributeId} - Write
Edit a gift tribute acknowledgee
Update the details about a gift tribute acknowledgee.
PATCH /nxt-data-integration/v1/re/gifttribute/acknowledgees/{giftTributeAcknowledgeeId} - Write
Edit a name format configuration
Edit the details about a name format configuration.
PATCH /nxt-data-integration/v1/re/nameformatconfigurations/{id} - Write
Edit a name format configuration field
Edit the details about a name format configuration field.
PATCH /nxt-data-integration/v1/re/nameformatconfigurations/fields/{id} - Write
Edit a phone type
Edit the details about a phone type.
PATCH /nxt-data-integration/v1/re/phonetypes/{id} - Write
Edit a table entry
Edit the details about a table entry.
PATCH /nxt-data-integration/v1/re/codetables/{code_table_id}/tableentries/{id} - Write
Edit a tax declaration
Edit a Gift Aid tax declaration.
PATCH /nxt-data-integration/v1/re/giftaid/taxdeclarations/{id} - Write
Edit an appeal
Edit the details about an appeal.
PATCH /nxt-data-integration/v1/re/appeals/{id} - Destructive
Delete a campaign
Deletes a campaign.
DELETE /nxt-data-integration/v1/re/campaigns/{id} - Destructive
Delete a code table
Delete a user defined code table.
DELETE /nxt-data-integration/v1/re/codetables/{id} - Destructive
Delete a constituent
Deletes a constituent. The constituent cannot have any gifts or actions.
DELETE /nxt-data-integration/v1/re/constituents/{id} - Destructive
Delete a constituent appeal
Deletes a constituent appeal.
DELETE /nxt-data-integration/v1/re/constitappeals/{id} - Destructive
Delete a country
Deletes a country.
DELETE /nxt-data-integration/v1/re/countries/{id} - Destructive
Delete a custom field category
Deletes a custom field category.
DELETE /nxt-data-integration/v1/re/customfieldcategories/{id} - Destructive
Delete a fund
Deletes a fund.
DELETE /nxt-data-integration/v1/re/funds/{id} - Destructive
Delete a gift note
Deletes a note for a gift.
DELETE /nxt-data-integration/v1/re/gifts/notes/{id} - Destructive
Delete a gift tribute
Deletes a gift tribute.
DELETE /nxt-data-integration/v1/re/gifttribute/{giftTributeId} - Destructive
Delete a name format configuration
Deletes a name format configuration.
DELETE /nxt-data-integration/v1/re/nameformatconfigurations/{id} - Destructive
Delete a name format configuration field
Deletes a name format configuration field.
DELETE /nxt-data-integration/v1/re/nameformatconfigurations/fields/{id} - Destructive
Delete a phone type
Deletes a phone type.
DELETE /nxt-data-integration/v1/re/phonetypes/{id} - Destructive
Delete a proposal
Deletes a proposal.
DELETE /nxt-data-integration/v1/re/proposals/{id} - Destructive
Delete a table entry
Deletes a table entry.
DELETE /nxt-data-integration/v1/re/codetables/{code_table_id}/tableentries/{id} - Destructive
Delete a tax declaration
Deletes a Gift Aid tax declaration.
DELETE /nxt-data-integration/v1/re/giftaid/taxdeclarations/{id} - Destructive
Delete a tribute
Deletes a tribute.
DELETE /nxt-data-integration/v1/re/tribute/{id} - Destructive
Delete an appeal
Deletes an appeal.
DELETE /nxt-data-integration/v1/re/appeals/{id}
Payments
- Read
Card
Returns information about a stored credit card.
GET /payments/v1/cards/{card_token} - Read
Checkout transaction
Returns information about a transaction that has been previously authorized by Blackbaud Checkout.
GET /payments/v1/checkout/transactions/{authorization_token} - Read
Direct debit account
Returns information about a stored direct debit account.
GET /payments/v1/directdebitaccounts/{account_token} - Read
Disbursement list
Gets the list of disbursements.
GET /payments/v1/disbursements?payment_configuration_id={payment_configuration_id} - Read
Disbursement transactions
Gets the list of transactions associated with the given disbursement.
GET /payments/v1/disbursements/{disbursementId}/transactions?payment_configuration_id={payment_configuration_id}&page={page} - Read
Payment configuration
Returns information about a payment configuration.
GET /payments/v1/paymentconfigurations/{payment_configuration_id} - Read
Payment configuration list
Returns a set of payment configurations.
GET /payments/v1/paymentconfigurations - Read
Public key
Gets the client's public key. See the Blackbaud Checkout integration guide to learn more.
GET /payments/v1/checkout/publickey - Read
Reader list
Returns the list of readers.
GET /payments/v1/readers?payment_configuration_id={payment_configuration_id} - Read
Security token
Gets the security token and the amount of time (in seconds) before the token is set to expire
GET /payments/v1/checkout/securitytoken/{payment_configuration_id} - Read
Transaction
Returns information about a transaction.
GET /payments/v1/transactions/{transaction_id} - Read
Transaction batch (PREVIEW)
Returns the status of a batch of card transactions or direct debit transactions, and when the status is complete, returns a list of results. Contact Support for permission to use this endpoint. ***This endpoint is in PREVIEW and may be subject to change.***
GET /payments/v1/batches/{batch_id} - Read
Uncaptured terminal transaction list (PREVIEW)
Returns information about a list of terminal transactions that require capture. ***This endpoint is in PREVIEW and may be subject to change.***
GET /payments/v1/transactions/terminal/uncaptured?payment_configuration_id={payment_configuration_id} - Write
Card token
Securely stores credit or debit card information and returns a token to use in future transactions. For credit cards, tokens will be registered in Credit Card Updater for enrolled customers.
POST /payments/v1/cardtokens - Write
Card transaction batch (PREVIEW)
Creates, uploads, and processes a batch of back office credit card and debit card transactions. Contact Support for permission to use this endpoint. ***This endpoint is in PREVIEW and may be subject to change.***
POST /payments/v1/batches/cardtransactionbatch - Write
Checkout transaction
Creates a transaction that has been previously authorized by Blackbaud Checkout. See the Blackbaud Checkout integration guide to learn more.
POST /payments/v1/checkout/transaction - Write
Connection token (PREVIEW)
Create a connection token that later facilitates a Card Present transaction via a Terminal point-of-sale device. ***This endpoint is in PREVIEW and may be subject to change.***
POST /payments/v1/terminal/connectiontokens - Write
Direct debit account token
Create a direct debit account token.
POST /payments/v1/directdebitaccounttokens - Write
Direct debit transaction batch (PREVIEW)
Creates, uploads, and processes a batch of back office direct debit transactions. Contact Support for permission to use this endpoint. ***This endpoint is in PREVIEW and may be subject to change.***
POST /payments/v1/batches/directdebittransactionbatch - Write
Grant (PREVIEW)
Creates a grant. ***This endpoint is in PREVIEW and may be subject to change.***
POST /payments/v1/grants - Write
Refund
Refund a processed transaction or void an authorized transaction
POST /payments/v1/refunds - Write
Terminal transaction (PREVIEW)
Create a terminal transaction. ***This endpoint is in PREVIEW and may be subject to change.***
POST /payments/v1/transactions/terminal - Write
Transaction
Create a transaction.
POST /payments/v1/transactions - Write
Transaction capture
Captures an authorized transaction.
POST /payments/v1/transactions/{transaction_id}/capture
Prospect
- Read
Get a prospect classification (PREVIEW)
Returns the prospect classification of a constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/constituents/{constituent_id}/prospectclassification - Read
Get a prospect status (PREVIEW)
Returns the current prospect status of a constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/constituents/{constituent_id}/prospectstatus - Read
Get a prospect status history record (PREVIEW)
Returns a single prospect status history record. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/prospectstatushistories/{id} - Read
Get prospect contribution summary (PREVIEW)
Returns the contribution summary for a constituent, including philanthropic, political, and other giving totals. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/constituents/{constituent_id}/prospect/contributionsummary - Read
Get prospect financial data summary (PREVIEW)
Returns the financial data summary (aggregated amounts by type) for a constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/constituents/{constituent_id}/prospect/financialdata/summary - Read
Get prospect giving preferences (PREVIEW)
Returns the giving preferences for a constituent, including interests and causes they will not give to. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/constituents/{constituent_id}/prospect/givingpreferences - Read
Get prospect other gifts (PREVIEW)
Returns a paginated list of gifts to other organizations for a constituent, with an optional giving type filter. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/constituents/{constituent_id}/prospect/othergifts - Read
Get the constituent identifier for a prospect (PREVIEW)
Translates a prospect ID to its associated constituent ID. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/prospects/{prospect_id}/constituent - Read
Get the prospect identifier for a constituent (PREVIEW)
Translates a constituent ID to its associated prospect ID. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/constituents/{constituent_id}/prospect - Read
List constituent prospect statuses (PREVIEW)
Returns a constituent's prospect status history. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/constituents/{constituent_id}/prospectstatushistories - Read
List prospect financial data assets (PREVIEW)
Returns a paginated list of financial data assets for a constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/constituents/{constituent_id}/prospect/financialdata/assets - Read
List prospect financial data types (PREVIEW)
Returns the available financial data types for the tenant. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/prospect/financialdata/types - Read
List prospect information sources (PREVIEW)
Returns the available information sources for the tenant. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /prospect/v1/prospect/financialdata/informationsources - Write
Create a prospect financial data asset (PREVIEW)
Creates a new financial data asset for a constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /prospect/v1/constituents/{constituent_id}/prospect/financialdata/assets - Write
Edit a prospect financial data asset (PREVIEW)
Updates an existing financial data asset for a constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /prospect/v1/constituents/{constituent_id}/prospect/financialdata/assets/{asset_id} - Write
Edit a prospect status history record (PREVIEW)
Updates a prospect status history record. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /prospect/v1/prospectstatushistories/{id} - Write
Update a prospect classification (PREVIEW)
Updates the prospect classification of a constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /prospect/v1/constituents/{constituent_id}/prospectclassification - Write
Update a prospect status (PREVIEW)
Updates the current prospect status of a constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /prospect/v1/constituents/{constituent_id}/prospectstatus - Destructive
Delete a prospect financial data asset (PREVIEW)
Deletes a financial data asset for a constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /prospect/v1/constituents/{constituent_id}/prospect/financialdata/assets/{asset_id} - Destructive
Delete a prospect status history record (PREVIEW)
Deletes a prospect status history record. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /prospect/v1/prospectstatushistories/{id}
Query
- Read
Available field search (PREVIEW)
Searches for available fields. **DEPRECATED** — Use the v2 endpoint instead. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /query/querytypes/{query_type_id}/availablefields/search?product={product}&module={module} - Read
Available field search (PREVIEW)
Searches for available fields. (PREVIEW) ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /query/v2/querytypes/{query_type_id}/availablefields/search?product={product}&module={module} - Read
Available fields tree (Node)
Gets the list of nodes and fields that are children of the specified query type and node in the available fields tree. **DEPRECATED** — Use the v2 endpoint instead.
GET /query/querytypes/{query_type_id}/nodes/{node_id}/availablefields?product={product}&module={module} - Read
Available fields tree (Node) (PREVIEW)
Gets the list of nodes and fields that are children of the specified query type and node in the available fields tree. (PREVIEW) ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /query/v2/querytypes/{query_type_id}/nodes/{node_id}/availablefields?product={product}&module={module} - Read
Available fields tree (Root)
Gets the list of nodes at the root of the available fields tree for a query type. **DEPRECATED** — Use the v2 endpoint instead.
GET /query/querytypes/{query_type_id}/availablefields?product={product}&module={module} - Read
Available fields tree (Root) (PREVIEW)
Gets the list of nodes at the root of the available fields tree for a query type. (PREVIEW) ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /query/v2/querytypes/{query_type_id}/availablefields?product={product}&module={module} - Read
Available fields tree for summary field (Node)
Gets the list of nodes and fields that are children of the specified summary field and node in the available fields tree. **DEPRECATED** — Use the v2 endpoint instead.
GET /query/summaryfields/{summary_field_id}/nodes/{node_id}/availablefields?product={product}&module={module} - Read
Available fields tree for summary field (Node) (PREVIEW)
Gets the list of nodes and fields that are children of the specified summary field and node in the available fields tree. (PREVIEW) ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /query/v2/summaryfields/{summary_field_id}/nodes/{node_id}/availablefields?product={product}&module={module} - Read
Available fields tree for summary field (Root)
Gets the list of nodes at the root of the available fields tree for summary field. **DEPRECATED** — Use the v2 endpoint instead.
GET /query/summaryfields/{summary_field_id}/availablefields?product={product}&module={module} - Read
Available fields tree for summary field (Root) (PREVIEW)
Gets the list of nodes at the root of the available fields tree for summary field. (PREVIEW) ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /query/v2/summaryfields/{summary_field_id}/availablefields?product={product}&module={module} - Read
Default filters for a parameterized summary field
Gets the list of default filters to apply for the specified summary field that is a parameterized summary type.
GET /query/summaryfields/{summary_field_id}/defaultfilters?product={product}&module={module} - Read
Get current user options.
Get current user options.
GET /query/configuration/useroptions?product={product}&module={module} - Read
Get lookup values
Gets the list of lookup values for a field.
GET /query/queryfields/{query_field_id}/lookupvalues?product={product}&module={module} - Read
Gets query categories.
Gets query categories.
GET /query/categories?product={product}&module={module} - Read
Query
Gets a query by ID.
GET /query/queries/{id}?product={product}&module={module} - Read
Query execution job status
Gets information about a background query execution job. Jobs and query results will be available for approximately 30 days after creation. For RE requests, the Analysis - Query - Export permission is required to use this endpoint.
GET /query/jobs/{id}?product={product}&module={module} - Read
Query list
Gets a list of queries.
GET /query/queries?product={product}&module={module} - Read
Query list (V2) (PREVIEW)
Gets a list of queries leveraging a continuation token for paging results. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /query/v2/queries?product={product}&module={module} - Read
Query type list
Gets the list of available query types.
GET /query/querytypes?product={product}&module={module} - Write
Adds a query category.
Adds a query category.
POST /query/categories?product={product}&module={module} - Write
Available fields tree (Nodes)
Gets the list of nodes and fields that are children of the specified query type and nodes in the available fields tree. **DEPRECATED** — Use the v2 endpoint instead.
POST /query/querytypes/{query_type_id}/nodes/availablefields?product={product}&module={module} - Write
Available fields tree (Nodes) (PREVIEW)
Gets the list of nodes and fields that are children of the specified query type and nodes in the available fields tree. (PREVIEW) ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /query/v2/querytypes/{query_type_id}/nodes/availablefields?product={product}&module={module} - Write
Edit a query category.
Edit a query category.
PATCH /query/categories/{id}?product={product}&module={module} - Write
Edit current user options.
Edit current user options.
PATCH /query/configuration/useroptions?product={product}&module={module} - Write
Query
Edit a query.
PATCH /query/queries/{id}?product={product}&module={module} - Write
Query
Adds a query.
POST /query/queries?product={product}&module={module} - Write
Query execution job (Ad-hoc)
Creates a background job to execute a query provided with the request. For RE requests, the Analysis - Query - Export permission is required to use this endpoint.
POST /query/queries/execute?product={product}&module={module} - Write
Query execution job (by ID)
Creates a background job to execute a query specified by ID. For RE requests, the Analysis - Query - Export permission is required to use this endpoint.
POST /query/queries/executebyid?product={product}&module={module} - Write
Refresh static query execution job
Creates a background job to refresh the saved keys for a static query specified by ID.
POST /query/queries/refreshstaticquery?product={product}&module={module} - Destructive
Cancel query execution job (PREVIEW)
Updates the job status to cancelling. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /query/jobs/{id}/cancel?product={product}&module={module} - Destructive
Deletes a query category
Deletes a query category.
DELETE /query/categories/{id}?product={product}&module={module} - Destructive
Query
Delete a query by ID.
DELETE /query/queries/{id}?product={product}&module={module}
Receivables
- Read
Get a billing item
This gets a billing item by ID.
GET /receivables/v1/billingitems/{id} - Read
Get a charge
This gets a charge by ID.
GET /receivables/v1/charges/{id} - Read
Get a client
This gets a client by ID.
GET /receivables/v1/clients/{id} - Read
Get a credit
This gets a credit by ID.
GET /receivables/v1/credits/{id} - Read
Get a list of charges by page
This returns a list of charges.
GET /receivables/v1/charges - Read
Get a list of clients by page
This returns a list of clients.
GET /receivables/v1/clients - Read
Get a list of credits by page
This returns a list of credits.
GET /receivables/v1/credits - Read
Get a list of invoices by page
This returns a list of invoices.
GET /receivables/v1/invoices - Read
Get a list of payments by page
This returns a list of payments.
GET /receivables/v1/payments - Read
Get a list of recurring invoices by page
This returns a list of recurring invoices.
GET /receivables/v1/recurringinvoices - Read
Get a list of refunds by page
This returns a list of refunds.
GET /receivables/v1/refunds - Read
Get a list of returns by page
This returns a list of returns.
GET /receivables/v1/returns - Read
Get a payment
This gets a payment by ID.
GET /receivables/v1/payments/{id} - Read
Get a recurring invoice
This gets a recurring invoice by ID.
GET /receivables/v1/recurringinvoices/{id} - Read
Get a recurring invoice line item
This gets a recurring invoice line item by ID.
GET /receivables/v1/recurringinvoices/{recurring_invoice_id}/lineitems/{line_item_id} - Read
Get a refund
This gets a refund by ID.
GET /receivables/v1/refunds/{id} - Read
Get a return
This gets a return by ID.
GET /receivables/v1/returns/{id} - Read
Get a return line item
This gets a return line item by ID.
GET /receivables/v1/returns/{return_id}/lineitems/{line_item_id} - Read
Get an invoice
This gets an invoice by ID.
GET /receivables/v1/invoices/{id} - Read
Get an invoice line item
This gets the invoice line item by invoice ID.
GET /receivables/v1/invoices/{invoice_id}/lineitems/{line_item_id} - Read
Get line items from a recurring invoice
This gets the line items from a recurring invoice.
GET /receivables/v1/recurringinvoices/{recurring_invoice_id}/lineitems - Read
Get line items from a return
This gets the line items from a return.
GET /receivables/v1/returns/{return_id}/lineitems - Read
Get line items from an invoice
This gets the invoice line items from an invoice.
GET /receivables/v1/invoices/{invoice_id}/lineitems - Read
List of billing items by page
This returns a list of billing items limited by page size.
GET /receivables/v1/billingitems
Standard Reports
- Read
Get a report job (PREVIEW)
Returns a report job. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /rxr-mngmt/reports/reportjobs/{job_id} - Read
Get recent report jobs (PREVIEW)
Returns report jobs executed in the last 7 days by the current user ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /rxr-mngmt/reports/reportjobs - Read
Get report instances (PREVIEW)
Gets a list of report instances of the specified type ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /rxr-mngmt/reports/{report_type}/reportinstances - Read
Get report types (PREVIEW)
Gets a list of supported report types ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /rxr-mngmt/reports/reporttypes - Write
Start a report execution job (PREVIEW)
Starts a report execution and returns the IDs of the report jobs ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /rxr-mngmt/reports/executereport
School
- Read
Academics assignments by section
Returns a collection of assignments for the specified ```section_id```. Requires at least one of the following roles in the Education Management system: Academic Group Manager Student Teacher Pending Teacher
GET /school/v1/academics/sections/{section_id}/assignments - Read
Academics assignments for student
Returns assignments for a student that are assigned or due within the date range specified. If no ```end_date``` is supplied it defaults to 31 days past the ```start_date``` Requires at least one of the following roles in the Education Management system: Student Parent
GET /school/v1/academics/{student_id}/assignments?start_date={start_date} - Read
Academics course requests
Course requests for all of the offering types that allow requests are returned, including Academics, Activities, Advisories and Athletics. Requires the following role in the Education Management system: Schedule Manager
GET /school/v1/academics/courserequests - Read
Academics courses
Returns a collection of academic courses, filtered by department and/or school level. Requires at least one of the following roles in the Education Management system: Academic Group Manager Platform Manager
GET /school/v1/academics/courses - Read
Academics cycles by section
Returns a collection of cycles for the specified ```section_id```. Requires the following role in the Education Management system: Academic Group Manager
GET /school/v1/academics/sections/{section_id}/cycles - Read
Academics departments
Returns a collection of academic departments. Requires at least one of the following roles in the Education Management system: Academic Group Manager Platform Manager Any Manager Role
GET /school/v1/academics/departments - Read
Academics graded assignments for student
Returns the graded assignments for the specified ```student_id``` and their ```section_id```. Requires at least one of the following roles in the Education Management system: Student Parent
GET /school/v1/academics/{student_id}/{section_id}/gradedassignments?marking_period_id={marking_period_id} - Read
Academics master schedule
Returns a collection of Master Schedule days within the date range provided. Requires at least one of the following roles in the Education Management system: Academic Group Manager Schedule Manager SKY API Basic
GET /school/v1/academics/schedules/master?level_num={level_num}&start_date={start_date}&end_date={end_date} - Read
Academics rosters
Returns the academic rosters for a selected year. Uses current school year by default. Requires the following role in the Education Management system: Schedule Manager Academic Group Manager
GET /school/v1/academics/rosters - Read
Academics schedule set
Returns details about the specified ```schedule_set_id```. Requires at least one of the following roles in the Education Management system: Academic Group Manager Schedule Manager
GET /school/v1/academics/schedules/sets/{schedule_set_id} - Read
Academics schedule sets by level
Returns a collection of Schedule Sets for the specified ```level_num```. Requires at least one of the following roles in the Education Management system: Academic Group Manager Schedule Manager
GET /school/v1/academics/schedules/sets?level_num={level_num} - Read
Academics sections by school level
Returns a collection of academic sections for the specified school level. Requires the following role in the Education Management system: Academic Group Manager
GET /school/v1/academics/sections?level_num={level_num} - Read
Academics sections by teacher
Returns a collection of sections for the specified ```teacher_id```. Requires at least one of the following roles in the Education Management system: Academic Group Manager Teacher
GET /school/v1/academics/teachers/{teacher_id}/sections - Read
Academics sections for student
Returns a collection of sections for the specified ```student_id```. The user requesting the information must be the student, parent of the student or faculty member associated with the student. Note: The ```marking_period``` and ```cumulative_grade``` fields will only be returned if the user requesting has the appropriate access permissions. Users must have Grade access for the marking periods associated with the section to retrieve these fields. Requires at least one of the following roles in the Education Management system: Student Parent Faculty
GET /school/v1/academics/student/{student_id}/sections - Read
Academics special days
Returns a collection of special days. Requires at least one of the following roles in the Education Management system: Academic Group Manager Schedule Manager
GET /school/v1/academics/specialdays - Read
Academics student enrollment list
Returns a collection of course sections in which the provided student is enrolled. Requires at least one of the following roles in the Education Management system: Academic Group Manager Schedule Manager
GET /school/v1/academics/enrollments/{user_id} - Read
Academics Student Enrollments Changes
Returns a collection of students with enrollment changes on or after the date parameter. The maximum period of time that can be specified is 30 days from start_date, if end_date is not provided or is greater than 30 days from start_date it will be set to start_date + 30 days. Requires at least one of the following roles in the Education Management system: Schedule Manager Academic Group Manager
GET /school/v1/academics/enrollments/changes?start_date={start_date} - Read
Academics students by section
Returns a collection of students in the specified ```section_id```. Requires at least one of the following roles in the Education Management system: Academic Group Manager Teacher
GET /school/v1/academics/sections/{section_id}/students - Read
Activities rosters
Returns the activity rosters for a selected year. Uses current school year by default. Requires the following role in the Education Management system: Schedule Manager Activity Group Manager
GET /school/v1/activities/rosters - Read
Activities sections by school level
Returns a collection of activity sections for the specified school level. Requires the following role in the Education Management system: Activity Group Manager
GET /school/v1/activities/sections?level_num={level_num} - Read
Admissions candidates (Legacy)
Returns a collection of admissions candidates. Requires one of the following roles in the Education Management system: Admissions Manager Platform Manager SKY API Data Sync NOTE: The following fields have been deprecated and are no longer returned as of 01/01/2023. school_decision school_decision_type candidate_decision candidate_decision_type Use the school decision and candidate decision objects instead. NOTE: The filter for school_year_id has been replaced by school_year. The school_year_id filter has been deprecated and no longer functions as of 01/01/2023.
GET /school/v1/admissions/candidates - Read
Admissions checklist status (Legacy)
Returns a collection of admissions checklist statuses. Requires the following role in the Education Management system: Admissions Manager
GET /school/v1/admissions/checkliststatus - Read
Admissions checklists (Legacy)
Returns a collection of admissions checklists. Use the optional ```search_text``` to apply a case-insensitive search against check lists "name". Use the optional ```inactive``` to return only inactive checklists (default is both). Requires the following role in the Education Management system: Admissions Manager
GET /school/v1/admissions/checklists - Read
Admissions statuses (Legacy)
Returns a collection of admissions statuses. Requires one of the following roles in the Education Management system: Admissions Manager Platform Manager SKY API Data Sync
GET /school/v1/admissions/status - Read
Advisories rosters
Returns the Advisory rosters for a selected year. Uses current school year by default. Requires the following role in the Education Management system: Schedule Manager Advisory Group Manager
GET /school/v1/advisories/rosters - Read
Advisories sections by school level
Returns a collection of advisory sections for the specified school level Requires the following role in the Education Management system: Sky API Advisory Group Manager
GET /school/v1/advisories/sections?level_num={level_num} - Read
Athletics highlights by ID
Returns an athletic game's highlights for the specified ```highlight_id```. This ID can be obtained via the GET athletics schedules endpoint for a game if highlights exist for that game. If Public access is not added via group page access, the endpoint requires at least one of the following roles in the Education Management system to return content Athletic Group Manager Team Schedule Manager Schedule Manager Page Manager Coach Pending Coach
GET /school/v1/athletics/highlights/{highlight_id} - Read
Athletics locations
Returns a collection of athletic locations. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Team Schedule Manager Schedule Manager Coach Pending Coach
GET /school/v1/athletics/locations - Read
Athletics opponents
Returns a collection of athletic opponents. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Team Schedule Manager Page Manager Coach Pending Coach
GET /school/v1/athletics/opponents - Read
Athletics rosters
Returns the athletic rosters for a selected year. Uses current school year by default. Requires the following role in the Education Management system: Schedule Manager Athletic Group Manager
GET /school/v1/athletics/rosters - Read
Athletics schedules
Returns a collection of athletic games for the current school year. Use the ```start_date``` and/or ```end_date``` to filter to a specific timeframe. Returns data for a specific team by setting the ```team_id``` using the GET teams endpoint. Returns both games and practices by setting ```include_practice``` to true. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Team Schedule Manager Schedule Manager Coach Pending Coach
GET /school/v1/athletics/schedules - Read
Athletics sports
Returns a collection of athletic sports. Use the optional ```season_id``` to filter the results by season. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Schedule Manager Page Manager Coach Pending Coach
GET /school/v1/athletics/sports - Read
Athletics sports levels
Returns a collection of athletic sports levels. Requires at least one of the following roles in the Education Management system: Team Schedule Manager Coach Pending Coach Any Manager Role
GET /school/v1/athletics/sportslevels - Read
Athletics team roster
Returns a collection of players and coaches for the specified athletic team's ID. The ```team_id``` can be retrieved using the GET athletics teams endpoint. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Team Schedule Manager Coach Pending Coach
GET /school/v1/athletics/teams/{team_id}/roster - Read
Athletics teams
Returns a collection of athletic teams for the current school year. Use the optional ```school_year``` parameter to specify a different year. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Team Schedule Manager Coach Pending Coach
GET /school/v1/athletics/teams - Read
Athletics transportation types
Returns a collection of athletic transportation types. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Team Schedule Manager Schedule Manager Coach Pending Coach Any Manager Role
GET /school/v1/athletics/transportationtypes - Read
Athletics venues
Returns a collection of athletic venues. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Team Schedule Manager Coach Pending Coach
GET /school/v1/athletics/venues - Read
Attendance record
Returns a collection of student attendance records for the specified day. Please use this Attendance Setup Guide to verify your attendance settings. Requires the following role in the Education Management system: Attendance Manager
GET /school/v1/attendance?level_id={level_id}&day={day}&offering_type={offering_type} - Read
Calendar for User
Returns a list of events for the calling user. Requires one of the following roles in the Education Management system: Student Parent Teacher
GET /school/v1/events/calendar - Read
Community groups rosters
Returns the community group rosters for a selected year. Uses current school year by default. Requires the following role in the Education Management system: Schedule Manager Community Group Manager
GET /school/v1/communitygroups/rosters - Read
Content announcement categories
Returns a list of announcement categories for the user. Requires at least one of the following roles in the Education Management System: Parent Faculty Student
GET /school/v1/content/announcements/categories - Read
Content announcements
Returns a list of announcements for the user. Requires at least one of the following roles in the Education Management System: Parent Faculty Student
GET /school/v1/content/announcements - Read
Content events
Returns a list of events for the user. Requires at least one of the following roles in the Education Management System: Parent Faculty Student
GET /school/v1/content/events - Read
Content Events Categories
Returns a collection of Content Events Categories. Requires at least one of the following roles in the Education Management System: Parent Faculty Student
GET /school/v1/content/events/categories - Read
Content management announcement categories
Returns a collection of announcement categories. Requires at least one of the following roles in the Education Management System: Content Manager Content Editor
GET /school/v1/contentmanagement/announcements/categories - Read
Content management news categories
Returns a collection of news categories.. Requires at least one of the following roles in the Education Management System: Content Manager Content Editor
GET /school/v1/contentmanagement/news/categories - Read
Content management photo album categories
Returns a collection of photo categories. Requires at least one of the following roles in the Education Management System: Registration Manager Content Manager Content Editor Academic Group Manager Advisory Group Manager Activity Group Manager Athletic Group Manager Dorm Group Manager Community Group Manager
GET /school/v1/contentmanagement/photoalbums/categories - Read
Content management photos by album
Returns a list of photos for an album. Requires at least one of the following roles in the Education Management System: Content Manager Academic Group Manager Athletic Group Manager Activity Group Manager Advisory Group Manager Dorm Group Manager Community Group Manager
GET /school/v1/contentmanagement/photoalbums/{album_id} - Read
Content News Categories
Returns a collection of Content News Categories. Requires at least one of the following roles in the Education Management System: Parent Faculty Student
GET /school/v1/content/news/categories - Read
Content News Items
Returns a collection of Content News Items. Requires at least one of the following roles in the Education Management System: Parent Faculty Student
GET /school/v1/content/news/items - Read
Content Resource Board
Returns a collection of Resources. Requires at least one of the following roles in the Education Management System: Parent Faculty Student
GET /school/v1/content/resources - Read
Core buildings
Returns a collection of buildings. Requires the 'Team Schedule Manager', 'Coach', 'Athletic Group Manager' or 'Pending Coach' role in the K12 system.
GET /school/v1/venues/buildings - Read
Core custom fields
Returns a collection of admin custom fields. Requires at least one of the following roles in the Education Management system: Platform Manager
GET /school/v1/customfields - Read
Core grade levels
Returns a collection of core school grade levels. Requires at least one of the following roles in the Education Management system: Academic Group Manager Schedule Manager Platform Manager Any Manager Role
GET /school/v1/gradelevels - Read
Core offering types
Returns a collection of core school offering types. Requires at least one of the following roles in the Education Management system: Academic Group Manager Schedule Manager Platform Manager
GET /school/v1/offeringtypes - Read
Core roles
Returns a collection of core school user roles. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Any Manager Role
GET /school/v1/roles - Read
Core school levels
Returns a collection of core school levels. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Any Manager Role
GET /school/v1/levels - Read
Core sessions
Returns a collection of sessions for a higher education institution. Requires at least one of the following roles in the Education Management system: Academic Group Manager Platform Manager
GET /school/v1/sessions - Read
Core terms
Returns a collection of core school terms. Requires at least one of the following roles in the Education Management system: Academic Group Manager Schedule Manager Platform Manager Any Manager Role
GET /school/v1/terms - Read
Core time zone
Returns the current time zone set for the school. Requires at least one of the following roles in the Education Management system: Academic Group Manager Platform Manager Any Manager Role
GET /school/v1/timezone - Read
Core years
Returns a collection of core school years. Requires at least one of the following roles in the Education Management system: Academic Group Manager Schedule Manager Platform Manager Any Manager Role
GET /school/v1/years - Read
Degrees student degrees by ID
Returns a collection of degree/diplomas assigned to the student. Each degree/diploma has a collection of majors, minors and/or concentrations as appropriate for that degree or diploma. Requires the following role in the Education Management system: Degree Manager Diploma Manager Student Parent
GET /school/v1/degrees/studentdegrees/{student_id} - Read
Directories
Returns a collection of directories the logged in user has access to Requires at least one of the following roles in the Education Management System: Parent Faculty Student
GET /school/v1/directories - Read
Directories results
Returns a collection of directory results the logged in user has access to ```search``` is an optional search string to filter directory results. ```search_all``` allows the search string to be used for all fields. When set to ```false```, only searches name fields. defaults to ```true```. Requires at least one of the following roles in the Education Management System: Parent Faculty Student
GET /school/v1/directories/{directory_id} - Read
Dorms by school level
Requires at least one of the following roles in the Education Management system: Dorm Group Manager Dorm Supervisor Pending Dorm Supervisor
GET /school/v1/dorms/all?level_number={level_number} - Read
Dorms rosters
Returns the dorm rosters for a selected year. Uses current school year by default. Requires the following role in the Education Management system: Schedule Manager Dorm Group Manager
GET /school/v1/dorms/rosters - Read
Events categories
Returns a collection of event categories. Requires one of the following roles in the Education Management system: Content Manager Platform Manager
GET /school/v1/events/categories - Read
List of Lists
Returns a list of basic or advanced lists the authorized user has access to Requires the following role in the Education Management system: Page Manager Content Editor Teacher Coach Community Group Manager Mentor Manager Alumni Group Manager Athletic Group Manager Academic Group Manager System Group Manager Content Manager Community Group Owner Dorm Group Manager Activity Group Manager Advisory Group Manager Advisor Dorm Supervisor Activity Leader Pending Teacher Pending Advisor Pending Dorm Supervisor Pending Activity Leader Platform Manager SkyApi Data Sync
GET /school/v1/lists - Read
List Single
Returns a collection of results from a basic or advanced list. Note : The requested list must have access permissions enabled for a role listed below or the user requesting the list needs read permission to that list. Requires one of the following roles in the Education Management system: Page Manager Content Editor Teacher Coach Community Group Manager Mentor Manager Alumni Group Manager Athletic Group Manager Academic Group Manager System Group Manager Content Manager Community Group Owner Dorm Group Manager Activity Group Manager Advisory Group Manager Advisor Dorm Supervisor Activity Leader Pending Teacher Pending Advisor Pending Dorm Supervisor Pending Activity Leader Platform Manager SkyApi Data Sync Rate Limiting: Any successful calls made to the GET List Single endpoint will have no restrictions Any call resulting in an error to the GET List Single endpoint will trigger a temporary time-out on the Environment and BBID of the calls origin. This time-out/hold will be for 60 seconds. After that calls may resume. If calls are made to the endpoint while the time-out is in place the response back will be Status 429 too many requests and an error of "Limited by error rate" will appear.
GET /school/v1/lists/advanced/{list_id} - Read
Medical allergies for a student
Returns the medical allergies for a student. Requires at least one of the following roles in the Education Management system: Nurse
GET /school/v1/medical/users/{user_id}/allergies - Read
Medical allergies/conditions for a student (DEPRECATED)
Returns a list of allergies/conditions for the specified ```user_id```. Requires at least one of the following roles in the Education Management system: Nurse ***This endpoint is DEPRECATED and will no longer function as of 2024-09-01***
GET /school/v1/medical/users/{user_id}/allergiesconditions - Read
Medical athletic requirements for a student
Returns a collection of medical athletic requirements for a student. Requires at least one of the following roles in the Education Management system: Nurse Coach
GET /school/v1/medical/users/{user_id}/athleticrequirements - Read
Medical conditions for a student
Returns the medical conditions for a student. Requires at least one of the following roles in the Education Management system: Nurse
GET /school/v1/medical/users/{user_id}/conditions - Read
Medical immunizations for a student
Returns a collection of medical immunizations for the specified ```user_id```. Requires at least one of the following roles in the Education Management system: Nurse
GET /school/v1/medical/users/{user_id}/immunizations - Read
Medical medications for a student
Returns a list of medications for the specified ```user_id```. Requires at least one of the following roles in the Education Management system: Nurse
GET /school/v1/medical/users/{user_id}/medications - Read
Medical Security Roles
Returns the user roles available for additional access control when posting medical data like student allergies or student medication. The ```role_access``` object in those post endpoints takes in the role IDs returned here.
GET /school/v1/medical/securityroles - Read
Schedules - Meetings for a student
Returns a list of meetings for a given student for a date range. When ```end_date``` is supplied, a range of meetings between the given dates is returned. Default for ```end_date``` is 30 days past the ```start_date```. Requires at least one of the following roles in the Education Management system and group page access should be set for one of the roles: Student Parent Attendance Manager Schedule Manager
GET /school/v1/schedules/{student_id}/meetings?start_date={start_date} - Read
Schedules meetings
Returns a list of section meetings for a given date. When ```end_date``` is supplied a range of meetings between the given dates is returned. ```offering_types``` can take a single or multiple values as a comma delimited ```string``` of integers, defaults to 1 ```end_date``` cannot be more than 30 days past the ```start_date```. Default date range is 30 days. Academics: 1 Activities: 2 Advisory: 3 Athletics: 9 Requires at least one of the following roles in the Education Management system: Academics Group Manager Advisory Group Manager Platform Manager Activity Group Manager Athletic Group Manager Scheduling Manager
GET /school/v1/schedules/meetings?start_date={start_date} - Read
Test and Subtest types
Returns a collection of test and subtest types for a school. Requires the following role in the Education Management system: Grading Manager Any Manager Role
GET /school/v1/testscores/testtypes - Read
Test scores
Returns a collection of test scores. Requires one of the following role in the Education Management system: Grading Manager Admissions Manager
GET /school/v1/testscores/all - Read
Test scores by user ID
Returns a collection of test scores. Requires the following role in the Education Management system: Grading Manager
GET /school/v1/testscores?user_id={user_id} - Read
Types attendance types
Returns a collection of attendance types. Requires the following role in the Education Management system: SKY API Basic
GET /school/v1/types/attendancetypes - Read
Types countries
Returns all countries that are valid for use with addresses as well as the states or provinces for the countries. Requires the following role in the Education Management system: All school
GET /school/v1/types/countries - Read
Types excuse duration types
Returns a collection of excuse duration types. Requires the following role in the Education Management system: SKY API Basic
GET /school/v1/types/excusedurationtypes - Read
Types excused types
Returns a collection of excused types. Requires the following role in the Education Management system: SKY API Basic Any Manager Role
GET /school/v1/types/excusedtypes - Read
Types table types
Returns a collection of table types. System tables will have an ID that is a negative number (Example: -100) User defined tables will have an ID that is a positive number (Example: 100)
GET /school/v1/types/tables - Read
Types table values
Returns a collection of table values. Either ```tableId``` or ```tableName``` parameter is required, but not both. For example, If a ```tableId``` is provided, then any value provided for ```tableName``` will be ignored. In the case that the calling user does not have permissions to view the data being requested no results will be returned.
GET /school/v1/types/tablevalues - Read
User by ID
Returns data for the specified ```user_id```. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Admissions Manager Contact Card Manager
GET /school/v1/users/{user_id} - Read
Users address types
Returns a collection of address types. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Any Manager Role
GET /school/v1/users/addresstypes - Read
Users addresses by user ID
Returns a collection of addresses. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Admissions Manager Contact Card Manager
GET /school/v1/users/{user_id}/addresses - Read
Users audit by role ID
Returns a collection of audit information based on the specified ```role_id``` within the dates provided. Requires at least one of the following roles in the Education Management system: SKY API Data Sync
GET /school/v1/users/audit?role_id={role_id} - Read
Users BBID status by role(s).
Returns a paginated collection of users education management BBID status, limited to 1000 users per page. Use the last user's ID as the ```marker``` value to return the next set of results. Requires one of the following roles in the Education Management system: SKY API Data Sync Platform Manager
GET /school/v1/users/bbidstatus?base_role_ids={base_role_ids} - Read
Users by role(s)
Returns a paginated collection of users, limited to 100 users per page. Use the record number as the ```marker``` value to return the next set of results. For example: ```marker=101``` will return the second set of results. Results are dependent on the directory settings of each user. Requires at least one of the following roles in the Education Management system: Billing Clerk Password Manager Contact Card Manager Platform Manager Admissions Manager
GET /school/v1/users?roles={roles} - Read
Users changed by base role(s)
Returns a paginated collection of users that have been created or modified within the specified timeframe. The timeframe is from the start_date to the start_date plus seven days. Requires the following role in the Education Management system: SKY API Data Sync
GET /school/v1/users/changed?base_role_ids={base_role_ids}&start_date={start_date} - Read
Users Children of Parent
Returns a collection of children of the specified ```parent_id```. Requires the logged in ```user_id``` matches the specified ```parent_id```. Requires the following role in the Education Management system: Parent
GET /school/v1/users/{parent_id}/students - Read
Users custom fields list by base role(s)
Returns a paginated collection of users with custom admin fields, limited to 100 users per page. This includes both user custom fields and administration view only custom fields. Use the last user ```id``` number as the ```marker``` value to return the next set of results. For example: ```marker=23232323``` will return a second set of results beginning with the next user ID in the result set. Requires at least one of the following roles in the Education Management system: Platform Manager Admissions Manager Contact Card Manager
GET /school/v1/users/customfields?base_role_ids={base_role_ids} - Read
Users custom fields single
Returns a collection of custom fields for a single ```user_id```. This includes both user custom fields and administration view only custom fields. Requires at least one of the following roles in the Education Management system: Platform Manager Admissions Manager Contact Card Manager
GET /school/v1/users/{user_id}/customfields - Read
Users education by user
Returns a collection of education information for the specified ```user_id```. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Admissions Manager Contact Card Manager
GET /school/v1/users/{user_id}/education - Read
Users emergency contact changes
Returns a paginated collection of all emergency contacts for all users that have had changes since the specified ```start_date```. If no date is specified then this returns a paginated collection of all emergency contacts for all users. Use the last user's ID as the ```marker``` value to return the next set of results. Requires at least one of the following roles in the Education Management system: SKY API Data Sync
GET /school/v1/users/emergencycontacts/changed - Read
Users emergency contacts by user ID
Returns a collection of emergency contacts for the specified ```user_id```. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Admissions Manager Contact Card Manager
GET /school/v1/users/{user_id}/emergencycontacts - Read
Users employment by role(s)
Returns a paginated collection of users employment details based on base roles, limited to 1000 users per page. Use the last user's ID as the ```marker``` value to return the next set of results. Requires the following role in the Education Management system: SKY API Data Sync Platform Manager Admissions Manager Contact Card Manager
GET /school/v1/users/employment?base_role_ids={base_role_ids} - Read
Users employment by user ID
Returns the employment details for the specified ```user_id```. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Admissions Manager Contact Card Manager
GET /school/v1/users/{user_id}/employment - Read
Users enrollments by year
Returns a collection of users and their enrollments for a single school year. Requires at least one of the following roles in the Education Management system: Admissions manager Platform manager SKY API Data Sync
GET /school/v1/users/enrollments?school_year={school_year} - Read
Users extended by role(s)
Returns a paginated collection of extended user details, limited to 1000 users per page. Use the last user's ID as the ```marker``` value to return the next set of results. Requires the following role in the Education Management system: SKY API Data Sync
GET /school/v1/users/extended?base_role_ids={base_role_ids} - Read
Users extended by user
Returns extended user details for the specified ```user_id```. Requires the following role in the Education Management system: SKY API Data Sync
GET /school/v1/users/extended/{user_id} - Read
Users gender types
Returns a collection of gender types. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Any Manager Role
GET /school/v1/users/gendertypes - Read
Users Get Me
Returns information about the caller.
GET /school/v1/users/me - Read
Users occupations by user ID
Returns a collection of occupations for the specified ```user_id```. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Admissions Manager Contact Card Manager
GET /school/v1/users/{user_id}/occupations - Read
Users phone types
Returns a collection of phone types. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Any Manager Role
GET /school/v1/users/phonetypes - Read
Users phones by user
Returns a collection phone numbers for the specified ```user_id```. Requires at least one of the following roles in the Education Management system: Platform Manager Admissions Manager Contact Card Manager
GET /school/v1/users/{user_id}/phones - Read
Users relationships by user
Returns a collection of a relationships for the specified ```user_id```. Requires at least one of the following roles in the Education Management system: Payment Services Manager Integration Manager Contact Card Manager Platform Manager Admissions Manager
GET /school/v1/users/{user_id}/relationships - Write
Academics courses custom fields list create
Add custom field data to a course Requires at least one of the following roles in the Education Management system: Academic group manager Platform Manager
POST /school/v1/academics/courses/{course_id}/customfields/list - Write
Academics courses custom fields list update
Update the custom field data for a course Requires at least one of the following roles in the Education Management system: Academic group manager Platform Manager
PATCH /school/v1/academics/courses/{course_id}/customfields/list - Write
Academics enroll students into sections
Adds bulk enrollment data (students and/or teachers) for the specified section(s). Returns True if successful, otherwise false. Requires at least one of the following roles in the Education Management system: Academic Group Manager Schedule Manager
POST /school/v1/academics/sections/students - Write
Academics sections custom fields list create
Add custom field data to an academic section Requires at least one of the following roles in the Education Management system: Academic group manager Platform Manager
POST /school/v1/academics/sections/{section_id}/customfields/list - Write
Academics sections custom fields list update
Update the custom field data for an academic section Requires at least one of the following roles in the Education Management system: Academic group manager Platform Manager
PATCH /school/v1/academics/sections/{section_id}/customfields/list - Write
Admissions candidate create (Legacy)
Creates a new admissions candidate record. Returns the ID of the newly created candidate. Requires one of the following roles in the Education Management system: Admissions Manager Admissions Staff
POST /school/v1/admissions/candidates - Write
Athletics game create
Creates a new athletic game for the specified ```team_id```. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Team Schedule Manager Schedule Manager Coach Pending Coach
POST /school/v1/athletics/teams/{team_id}/schedule - Write
Athletics game result
Creates a result/score for the specified athletic game ``` schedule_id ```. Existing schedule IDs can be retrieved via the GET athletics schedules endpoint as well as after calling POST athletics game. NOTE: There are two types of game results: Team vs team scores (schedule_type: 0) and Team placement or team total points scores (schedule_type: 1). The score reporting for the two types is distinctly different. For team vs team scores Each opponent will list in the opponents array with a value for ```win_loss```, ```score``` and ```score_versus```. Example: ``` { "schedule_id": 1331482, "send_notification": false, "schedule_type": 0, "opponents": [ { "opponent_id": 41406, "win_loss": "Win", "score": "5", "score_versus": "2", }, { "opponent_id": 41407, "win_loss": "Loss", "score": "1", "score_versus": "3", } ] } ``` For team placement or team total points scores The Home team and each opponent will list in the opponents array with a value for ```score``` but only the home team will have a value for ```win_loss``` and ```score_versus``` can be omitted for all. The home team�s ```opponent_id``` will be -1 in the opponents array. Example: ``` { "schedule_id": 1331482, "send_notification": false, "schedule_type": 1, "opponents": [ { "opponent_id": -1, "score": "1st", "win_loss": "Win" }, { "opponent_id": 41406, "score": "2nd", "win_loss": "" }, { "opponent_id": 41407, "score": "3rd", "win_loss": "" } ] } ``` Requires at least one of the following roles in the Education Management system: Team Schedule Manager Page Manager Coach Pending Coach
POST /school/v1/athletics/result - Write
Athletics game update
Updates the game data for the specified ```team_id``` and athletic ```game_id```. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Team Schedule Manager Schedule Manager Coach Pending Coach
PATCH /school/v1/athletics/teams/{team_id}/schedule - Write
Athletics location create
Creates a new athletic location. The location can optionally be tied to an opponent using the ```opponent_id``` from the GET opponents endpoint. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Team Schedule Manager Schedule Manager Coach Pending Coach
POST /school/v1/athletics/locations - Write
Athletics opponent create
Creates a new athletic opponent. Requires at least one of the following roles in the Education Management system: Athletic Group Manager Team Schedule Manager Schedule Manager Page Manager Coach Pending Coach
POST /school/v1/athletics/opponents - Write
Athletics practice create
Creates a new athletic practice for the specified ```team_id```. Requires at least one of the following roles in the Education Management system: Team Schedule Manager Page Manager
POST /school/v1/athletics/teams/{team_id}/schedule/practice - Write
Athletics practice update
Updates the practice data for the specified athletic practice ```id```. Requires at least one of the following roles in the Education Management system: Athletic Group Manager
PATCH /school/v1/athletics/teams/{team_id}/schedule/practice - Write
Attendance by section update
Updates student attendance records for a specified section (academic, advisory, activity or athletic). Will mark the section as 'attendance taken' for the meeting. Students with no data will be considered present. To remove any existing attendance for a student, an explicit Present code must be included. Please use this Attendance Setup Guide to verify your attendance settings. Requires the following role in the Education Management system: Attendance Manager
POST /school/v1/attendance/sections/{section_id}/attendance - Write
Attendance record create
Creates a new attendance record for the specified student. Please use this Attendance Setup Guide to verify your attendance settings. Requires the following role in the Education Management system: Attendance Manager
POST /school/v1/attendance - Write
Attendance section attendance taken update
Updates the attendance taken status for all meetings on the date specified, up to the current time. This action has no affect on future dates. Please use this Attendance Setup Guide to verify your attendance settings. Requires the following role in the Education Management system: Attendance Manager
PATCH /school/v1/attendance/attendancetaken - Write
Content management announcements
Returns a collection of announcements. Requires at least one of the following roles in the Education Management System: Content Manager Content Editor Academic Group Manager Advisory Group Manager Activity Group Manager Athletic Group Manager Dorm Group Manager Community Group Manager
POST /school/v1/contentmanagement/announcements/list - Write
Content management news
Returns a collection of news. Requires at least one of the following roles in the Education Management System: Content Manager Content Editor Academic Group Manager Advisory Group Manager Activity Group Manager Athletic Group Manager Dorm Group Manager Community Group Manager
POST /school/v1/contentmanagement/news/list - Write
Content management photo albums
Returns a list of photo albums. Requires at least one of the following roles in the Education Management System: Content Manager Academic Group Manager Advisory Group Manager Activity Group Manager Athletic Group Manager Dorm Group Manager Community Group Manager
POST /school/v1/contentmanagement/photoalbums/list - Write
Event create
Creates a single or recurring event Registration Manager Content Manager Content Editor Academic Group Manager Advisory Group Manager Activity Group Manager Athletic Group Manager Dorm Group Manager Community Group Manager
POST /school/v1/events - Write
Events category create
Returns the ID of the created Events Category Requires one of the following roles in the Education Management system: Content Manager Platform Manager
POST /school/v1/events/categories - Write
Events list
Returns a collection of events. Requires at least one of the following roles in the Education Management System: Registration Manager Content Editor Content Editor Faculty Academic Group Manager Activity Group Manager Advisor Group Manager Dorm Group Manager Community Group Manager Athletic Group Manager
POST /school/v1/events/list - Write
Medical allergies create
Creates an allergy for a student. Returns the newly created ID. Requires one of the following roles in the Education Management system: Nurse
POST /school/v1/medical/allergies - Write
Medical allergies update
Update a medical allergy for a student. Requires one of the following roles in the Education Management system: Nurse
PATCH /school/v1/medical/allergies/{allergy_id} - Write
Medical allergies/conditions create (DEPRECATED)
Creates medical allergy/condition record for a student. Returns the newly created ID. Requires one of the following roles in the Education Management system: Nurse ***This endpoint is DEPRECATED and will no longer function as of 2024-09-01***
POST /school/v1/medical/allergiesconditions - Write
Medical athletic requirements update
Updates a medical athletic requirements for a student. Requires one of the following roles in the Education Management system: Nurse
POST /school/v1/medical/athleticclearance - Write
Medical conditions create
Creates a condition for a student. Returns the newly created ID. Requires one of the following roles in the Education Management system: Nurse
POST /school/v1/medical/conditions - Write
Medical conditions update
Update a medical condition for a student. Requires one of the following roles in the Education Management system: Nurse
PATCH /school/v1/medical/conditions/{condition_id} - Write
Medical immunizations update
Updates a medical immunization for a student. Requires one of the following roles in the Education Management system: Nurse
POST /school/v1/medical/immunizations - Write
Medical medication update
Updates a medical medication for a student. Requires one of the following roles in the Education Management system: Nurse
PATCH /school/v1/medical/medications/{medication_id} - Write
Medical medications create
Create a medication for a student. Returns the newly created ID. Requires one of the following roles in the Education Management system: Nurse
POST /school/v1/medical/medications - Write
Test Score create
Creates a test score for a student ```user_id``` Requires the following role in the Education Management system: Grading Manager
POST /school/v1/testscores/{user_id} - Write
Types table values create
Add a new table value to a table type. Allowed table types: Allergy, Condition, Admission
POST /school/v1/types/tablevalues - Write
User create
Creates a new user record. Returns the newly created ID. Requires at least one of the following roles in the Education Management system: Platform Manager Contact Card Manager
POST /school/v1/users - Write
User update
Updates the record of a single user. Note: Deleting/clearing data from a field requires the use of the ```fields_to_delete``` property described below Returns the ID of the user just updated upon success. Requires at least one of the following roles in the Education Management system: Platform Manager Contact Card Manager
PATCH /school/v1/users - Write
Users address create
Returns the ID of the address just created. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Contact Card Manager
POST /school/v1/users/{user_id}/addresses - Write
Users address update
Returns ID of the address just updated. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Contact Card Manager
PATCH /school/v1/users/{user_id}/addresses/{address_id} - Write
Users custom fields create
Creates an admin custom field for a user. Does not create any of the ten default custom fields, every user has those fields created for them by default. To update those fields see User Custom Field Values Update. Requires at least one of the following roles in the Education Management system: Platform Manager
POST /school/v1/users/{user_id}/customfields - Write
Users custom fields list create
Creates a list of admin custom field for a user. Does not create any of the ten default custom fields, every user has those fields created for them by default. To update those fields see User Custom Field Values Update. Requires at least one of the following roles in the Education Management system: Platform Manager
POST /school/v1/users/{user_id}/customfields/list - Write
Users custom fields list update
Updates a list of admin custom field for a user. Requires at least one of the following roles in the Education Management system: Platform Manager
PATCH /school/v1/users/{user_id}/customfields/list - Write
Users custom fields update
Updates an admin custom field for a user. Requires at least one of the following roles in the Education Management system: Platform Manager
PATCH /school/v1/users/{user_id}/customfields - Write
Users education create
Creates an education entry for a user. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Contact Card Manager
POST /school/v1/users/{user_id}/education - Write
Users education update
Updates an education entry for a user. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Contact Card Manager
PATCH /school/v1/users/{user_id}/education/{education_id} - Write
Users emergency contact non-user create
Creates a non-user emergency contact for the given user. Requires at least one of the following roles in the Education Management system: SKY API Data Sync
POST /school/v1/users/{user_id}/emergencycontacts/nonuser - Write
Users emergency contact user create
Activates an existing inactive or suggested emergency contact for a user. To add a new user emergency contact, add the correct relationship between users first. To add a non-user emergency contact please see the Emergency Contact Non-User Create route. Requires at least one of the following roles in the Education Management system: SKY API Data Sync
POST /school/v1/users/{user_id}/emergencycontacts/user - Write
Users employment update
Updates the employment information for a user. Requires the following role in the Education Management system: SKY API Data Sync SKY API Platform Manager
PATCH /school/v1/users/{user_id}/employment - Write
Users enrollment create
Creates the users enrollment record. Requires at least one of the following roles in the Education Management system: SKY API Data Sync
POST /school/v1/users/enroll - Write
Users occupation create
Creates an occupation record for the specified ```user_id```. Returns the ID of the occupation created. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Contact Card Manager
POST /school/v1/users/{user_id}/occupations - Write
Users occupation update
Updates an occupation entry for a user. Returns the ID of the occupation updated. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Contact Card Manager
PATCH /school/v1/users/{user_id}/occupations/{occupation_id} - Write
Users phone create
Creates a new phone record for the specified ```user_id```. Returns the ID of the phone number created. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Contact Card Manager
POST /school/v1/users/{user_id}/phones - Write
Users phone update
Updates an exising phone record for the specified ```user_id```. Returns the ID of the phone number updated.
PATCH /school/v1/users/{user_id}/phones/{phone_id} - Write
Users relationship create
Creates a relationship record for the specified ```user_id```. This doesn't create a user profile for the related individual. Returns 200 OK Requires at least one of the following roles in the Education Management system: Payment Services Manager Integration Manager Contact Card Manager Platform Manager
POST /school/v1/users/{user_id}/relationships - Write
Users relationship update
Updates a relationship record for the specified ```user_id```. Returns 200 OK Requires at least one of the following roles in the Education Management system: Contact Card Manager Platform Manager
PATCH /school/v1/users/{user_id}/relationships/{left_user_id} - Destructive
Athletics game delete
Removes an athletic ```game_id``` for the specified ```team_id```. Requires at least one of the following roles in the Education Management system: Team Schedule Manager Page Manager
DELETE /school/v1/athletics/teams/{team_id}/schedule/{game_id} - Destructive
Athletics practice delete
Removes the athletic ```practice_id``` for the specified ```team_id```. Requires at least one of the following roles in the Education Management system: Team Schedule Manager Page Manager
DELETE /school/v1/athletics/teams/{team_id}/schedule/practice/{practice_id} - Destructive
Events delete
Deletes an event and optionally deletes associated recurring events Requires at least one of the following roles in the Education Management system: Content Manager Content Editor Academic Group Manager Advisory Group Manager Activity Group Manager Athletic Group Manager Dorm Group Manager Community Group Manager Faculty
DELETE /school/v1/events/{event_id} - Destructive
Medical allergies delete
Delete a medical allergy for a student. Requires one of the following roles in the Education Management system: Nurse
DELETE /school/v1/medical/allergies/{allergy_id} - Destructive
Medical conditions delete
Delete a medical condition for a student. Requires one of the following roles in the Education Management system: Nurse
DELETE /school/v1/medical/conditions/{condition_id} - Destructive
Medical medications delete
Delete a medication for a student. Requires one of the following roles in the Education Management system: Nurse
DELETE /school/v1/medical/medications/{medication_id} - Destructive
Users address delete
Removes the specified address from the user. If the address is shared, other users linked to the address will not be affected. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Contact Card Manager
DELETE /school/v1/users/{user_id}/addresses/{address_id}/{address_type_id} - Destructive
Users education delete
Deletes an education entry for a user. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Contact Card Manager
DELETE /school/v1/users/{user_id}/education/{education_id} - Destructive
Users occupation delete
Deletes an occupation entry for a user. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Contact Card Manager
DELETE /school/v1/users/{user_id}/occupations/{occupation_id} - Destructive
Users phone delete
Removes the specified phone from the user. If the phone is shared, other users linked to the phone will not be affected. Requires at least one of the following roles in the Education Management system: SKY API Data Sync Platform Manager Contact Card Manager
DELETE /school/v1/users/{user_id}/phones/{phone_id}/{phone_type_id} - Destructive
Users relationship delete
Removes a relationship record from the specified ```user_id```. If the related individual is also a user, the user profile of that user is preserved. Individuals may need to review or update their emergency contacts. Requires at least one of the following roles in the Education Management system: Payment Services Manager Integration Manager Contact Card Manager Platform Manager
DELETE /school/v1/users/{user_id}/relationships?left_user={left_user}&relationship_type={relationship_type}
Statistical Unit
- Read
Count (Get)
Gets a specific count of a non-financial statistical unit.
GET /statistical-unit/v1/units/{unit_id}/counts/{count_id} - Read
Count (Search)
Searches for counts of a non-financial statistical unit.
GET /statistical-unit/v1/units/{unit_id}/counts - Read
Element (List)
Searches available elements. Elements categorize units. For example, you can break down a square footage unit by department to track, compare, and analyze the amount of office space different departments use. Elements are generic, which allows consuming applications to define their meaning in the context of an application. By convention, elements are defined as follows: Project - 1 Project type - 2 Project status - 3 Project division - 4 Project department - 5 Project location - 6 Grant type - 8 Grant status - 9 Account segment 1 - 10 Account segment 2 - 11 Account segment 3 - 12 Account segment 4 - 13 Account segment 5 - 14 Account segment 6 - 15 Account segment 7 - 16 Account segment 8 - 17 Account segment 9 - 18 Account segment 10 - 19 Transaction code 1 - 20 Transaction code 2 - 21 Transaction code 3 - 22 Transaction code 4 - 23 Transaction code 5 - 24
GET /statistical-unit/v1/elements - Read
Line items (Search)
Searches for line items of a particular count of a non-financial statistical unit.
GET /statistical-unit/v1/units/{unit_id}/counts/{count_id}/lineitems - Read
Unit (Get)
Gets details of a non-financial statistical unit.
GET /statistical-unit/v1/units/{unit_id} - Read
Unit (Search)
Searches for non-financial statistical units.
GET /statistical-unit/v1/units - Write
Count (Create)
Creates a count for a non-financial statistical unit.
POST /statistical-unit/v1/units/{unit_id}/counts - Write
Count (Edit)
Updates the date or line items of a count of a non-financial statistical unit.
PATCH /statistical-unit/v1/units/{unit_id}/counts/{count_id} - Write
Unit (Create)
Creates a non-financial statistical unit.
POST /statistical-unit/v1/units - Write
Unit (Edit)
Updates the name or description of a non-financial statistical unit.
PATCH /statistical-unit/v1/units/{unit_id} - Destructive
Count (Delete)
Deletes a count of a non-financial statistical unit.
DELETE /statistical-unit/v1/units/{unit_id}/counts/{count_id} - Destructive
Unit (Delete)
Deletes (marks as inactive) a non-financial statistical unit.
DELETE /statistical-unit/v1/units/{unit_id}
Enrichment
- Write
Identity Thread (Match) (PREVIEW)
Send up to 1000 records per request for identity thread matching. This API manages enrichment information and related entities, enabling users to pinpoint and track unique records across one or multiple databases to key individual or household accounts. To learn about how to set up your developer account and work with the SKY API, see the [Getting Started](https://developer.blackbaud.com/skyapi/docs/getting-started) guide. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /enrichment/v1/enrichment/identitythread/match
Billing Management
- Read
Batch summary (Get)
Gets a summary of a batch import, with its current status, mappings, processing exceptions and the number of transactions created.
GET /tms-bmapi/v1/batchimports/{id} - Read
Fee types (Get)
Returns information about the fee types that are allowed for batch imports.
GET /tms-bmapi/v1/types/fees - Read
Post to GL batch distributions (List) (PREVIEW)
Returns a page of up to 50 general ledger distributions belonging to a post to general ledger batch, in ascending order by their unique identifier. Sort by line_number client side if the batch's own line ordering matters for display. When a continuation_token is returned, pass it back unmodified to retrieve the following page, and keep going until no token is returned. A page may contain fewer distributions than the page size - even none at all - while still returning a token, so use the presence of the token rather than the number of distributions to decide whether to continue. A continuation_token is intended for continuing a traversal that is already in progress; it should not be stored and reused later. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /tms-bmapi/v1/generalledger/batches/{batch_id}/distributions - Read
Post to GL batches (List) (PREVIEW)
Returns a page of up to 50 post to general ledger batches, most recently created first. When a continuation_token is returned, pass it back unmodified to retrieve the following page, and keep going until no token is returned. A page may contain fewer batches than the page size - even none at all - while still returning a token, so use the presence of the token rather than the number of batches to decide whether to continue. A continuation_token is intended for continuing a traversal that is already in progress; it should not be stored and reused later. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /tms-bmapi/v1/generalledger/batches - Write
Charges batch (Create)
Creates an batch import request to create a batch of charges in Billing Management
POST /tms-bmapi/v1/batchimports/charges - Write
Credits batch (Create) (PREVIEW)
Creates an batch import request to create a batch of credits in Billing Management ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /tms-bmapi/v1/batchimports/credits - Write
Update GL batch post-run status (PREVIEW)
Allows a general ledger system to report the result of a post run for a post to general ledger batch, updating its status and recording the identifier for the run. Returns an error if the batch does not exist, has been deleted, or has already been posted. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /tms-bmapi/v1/generalledger/batches/{batch_id}/status
Volunteer
- Read
Get a job (PREVIEW)
Gets details for a specific volunteer job by its unique identifier ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /volunteer/v1/jobs/{job_id} - Read
Get emergency contact (PREVIEW)
Returns emergency contact information for the specified constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /volunteer/v1/constituents/{constituent_id}/emergencycontact - Read
List constituent volunteer assignments (PREVIEW)
Returns a page of assignments for the specified constituent ID. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /volunteer/v1/constituents/{constituent_id}/assignments - Read
List constituent volunteer interests (PREVIEW)
Returns a page of volunteer interests for the specified constituent ID. `count` is the total number of interests before paging. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /volunteer/v1/constituents/{constituent_id}/interests - Read
List constituent volunteer skills (PREVIEW)
Returns a page of volunteer skills for the specified constituent ID. `count` is the total before paging. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /volunteer/v1/constituents/{constituent_id}/skills - Read
List constituent volunteer timesheets (PREVIEW)
Returns a page of timesheets for the specified constituent ID. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /volunteer/v1/constituents/{constituent_id}/timesheets - Read
List constituent volunteer types (PREVIEW)
Returns a page of volunteer types for the specified constituent ID. `count` is the total number of types before paging. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /volunteer/v1/constituents/{constituent_id}/types - Read
List excluded volunteer custom fields (PREVIEW)
Returns the custom fields that exclude volunteers from the specified job. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /volunteer/v1/jobs/{job_id}/excludedcustomfields - Read
List included volunteer custom fields (PREVIEW)
Returns the custom fields that are required for inclusion in the specified job. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /volunteer/v1/jobs/{job_id}/includedcustomfields - Read
List job assignments (DEPRECATED)
Returns a filtered, sorted, paged list of volunteers assigned to the specified job. Search text is a case-insensitive contains match on the volunteer's display name. A start_date filter matches assignments whose start date is on or after it, and an end_date filter matches assignments whose end date is on or before it; assignments missing a filtered date are excluded. Deprecated: use GET /v1/volunteers/assignments with job_id instead. ***This endpoint is DEPRECATED and will no longer function as of 2026-11-06***
GET /volunteer/v1/jobs/{job_id}/volunteers - Read
List job custom fields (PREVIEW)
Returns the custom fields for the specified job. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /volunteer/v1/jobs/{job_id}/customfields - Read
List job skills (PREVIEW)
Returns a page of the skills and experience requirements for the specified job. Sorted by `sort_column` (display order by default). `count` is the total number of skills before paging. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
GET /volunteer/v1/jobs/{job_id}/skills - Write
Add constituent volunteer interest (PREVIEW)
Adds an interest for the specified constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /volunteer/v1/constituents/{constituent_id}/interests - Write
Add constituent volunteer skill (PREVIEW)
Adds a new skill/experience entry to the specified constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /volunteer/v1/constituents/{constituent_id}/skills - Write
Add constituent volunteer type (PREVIEW)
Adds a volunteer type for the specified constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
POST /volunteer/v1/constituents/{constituent_id}/types - Write
Edit a volunteer interest (PREVIEW)
Updates an existing volunteer interest entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /volunteer/v1/volunteers/interests/{volunteer_interest_id} - Write
Edit a volunteer skill (PREVIEW)
Updates an existing volunteer skill/experience entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /volunteer/v1/volunteers/skills/{volunteer_skill_id} - Write
Edit a volunteer type (PREVIEW)
Updates an existing volunteer type classification. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /volunteer/v1/volunteers/types/{volunteer_type_id} - Write
Edit emergency contact (PREVIEW)
Edits emergency contact information for the specified constituent. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
PATCH /volunteer/v1/constituents/{constituent_id}/emergencycontact - Destructive
Delete a volunteer interest (PREVIEW)
Deletes an existing volunteer interest entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /volunteer/v1/volunteers/interests/{volunteer_interest_id} - Destructive
Delete a volunteer skill (PREVIEW)
Deletes an existing volunteer skill/experience entry. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /volunteer/v1/volunteers/skills/{volunteer_skill_id} - Destructive
Delete a volunteer type (PREVIEW)
Deletes an existing volunteer type classification. ***This endpoint is in PREVIEW and may be changed or removed at any time.***
DELETE /volunteer/v1/volunteers/types/{volunteer_type_id}
Webhook
- Read
Get a subscription
Returns subscription information for a specific application and subscription ID. The subscription is scoped to the Blackbaud Environment authorized by your SKY API access token.
GET /webhook/subscriptions/{subscription_id} - Read
Get subscription list
Returns a list of subscriptions for your application. These subscriptions are scoped to the Blackbaud Environment authorized by your SKY API access token.
GET /webhook/subscriptions - Write
Create a subscription
Creates a subscription in your application. This subscription is scoped to the Blackbaud Environment authorized by your SKY API access token.
POST /webhook/subscriptions - Write
Create a subscription test payload
Sends a test event to your subscription's webhook URL. Use this event to verify that your subscription is configured correctly. This payload uses a special event type, 'com.blackbaud.utility.testpayload.v1', so that your webhook can identify the test.
POST /webhook/utilities/subscriptions/{subscription_id}/testpayload - Destructive
Remove a subscription
Removes a subscription in your application. The subscription removed is scoped to the Blackbaud Environment authorized by your SKY API access token.
DELETE /webhook/subscriptions/{subscription_id}
No operations match.
See How connections work for access and permissions, or browse all integrations.
Reference date: October 28, 2026. Blackbaud API docs.