Campaign Manager Web API Help Page

Introduction

The CM WebAPI connects your internal application with your data in Campaign Manager. We're just getting started, and you can look forward to a host of new features as we move forward!

ElectionPeriod

API	Description
GET {version}/GetElectionPeriods	Get Election Periods

FECLookup

API	Description
POST {version}/FECData	Get FEC Data

FinancialReportFilter

API	Description
POST {version}/SaveFinancialReportFilter	Save Financial Report Filter
POST {version}/DeleteFinancialReportFilter	Delete Financial Report Filter
POST {version}/GetFinancialReportFilters	Get Most Recent 10 Filters

QRTReportParameterSelectedValue

API	Description
POST {version}/SetQRTParameterValuesForImport	Set QRT Paremeters values for the underlying Import Request
POST {version}/ExecuteProcedureForQRTImport	Execute QRT with the set parameters
GET {version}/QRTReportParameters/{id}	Get QRT Report Parameter Selected values

EventStatus

API	Description
GET {version}/GetEventStatuses	Get Event Statuses

Batch

API	Description
POST {version}/GetTransactionsByBatchId
POST {version}/GetBatchableTransactions
POST {version}/GetTransactionsByDepositId
POST {version}/GetDepositableTransactions
POST {version}/GetTransactionsByBatchIdDownload
POST {version}/GetTransactionsByDepositIdDownload

Activity

API	Description
GET {version}/GetAllToDoTasks?id={id}	Get All to-Do Tasks for a User
POST {version}/CompleteTask	Complete To-Do Task for a user
POST {version}/ProcessMassCommunication	Process Mass Communication

UserDefinedField

API	Description
GET {version}/GetUserDefinedFields	Get User Defined Fields

Entity

API	Description
POST {version}/Entity/GetEntityAffiliationList
POST {version}/Entity/GetContributionsToCommittees
POST {version}/EntitiesQuickSearch
POST {version}/CustomGreeting	Retrieves the custom greeting for the day

Disbursement

API	Description
POST {version}/UpdateDisbursementFromTranfer	Set QRT Paremeters values for the underlying Import Request
POST {version}/SaveTransactionDocuments	No documentation available.
GET {version}/GetTransactionDocuments?id={id}	No documentation available.
POST {version}/UpdateCheckStatus	No documentation available.
GET {version}/GetCheckDetail?transactionId={transactionId}	No documentation available.

AddressRedistribution

API	Description
POST {version}/GetAddressRedistributionsForIndividual	Get Individual Address Redistributions
POST {version}/GetAddressRedistributionsForCompanyLocation	Get Company Location Address Redistributions
POST {version}/GetAddressRedistributionsForPoliticalCommittee	Get Political Committee Address Redistributions

Lookup

API	Description
POST {version}/GetTransactionBatches	Get Batches
POST {version}/GetTransactionPeriods	Get Election Periods
POST {version}/GetTransactionEvents	Get Events
POST {version}/GetTransactionAccounts	Get Accounts
POST {version}/GetTransactionFilingCommittees	Get Filing Committtees
POST {version}/GetTransactionPaymentMethods	Get Payment Methods
POST {version}/GetComplianceAuthorityNames	Get Compliance Authority Names
POST {version}/GetTransactionEventJointActivities	Get Event Joint Activities
POST {version}/GetTransactionReceiptCodes	Get Receipt Codes
POST {version}/GetTransactionDisbursementCodes	Get Disbursement Codes
POST {version}/GetTransactionCategories	Get Transaction Categories
POST {version}/GetTransactionCategoryTypes	Get Transaction Category Types
POST {version}/GetStates	Get States
POST {version}/GetDeposits	Get Deposits
GET {version}/GetTransactionTypes
GET {version}/GetPrefixes	No documentation available.
GET {version}/GetSuffixes	No documentation available.
GET {version}/GetParties	No documentation available.
GET {version}/GetIndustries	No documentation available.
GET {version}/GetTemplates	No documentation available.
GET {version}/GetComplianceAuthorities	No documentation available.
GET {version}/GetDistrictLevels	No documentation available.
GET {version}/GetDistrictTypes	No documentation available.
GET {version}/GetPoliticalCommitteeTypes	No documentation available.
GET {version}/GetCompanyTypes	No documentation available.

Contact

API	Description
POST {version}/DeleteContactFilter	Delete Contact Filter
POST {version}/GetContactFilters	Get Contact Filters
POST {version}/GetFilterOptionDefinitions	Get Filter Option Definitions
POST {version}/GetAllFilterColumns	Get All Available Filter Columns
POST {version}/GetFilterDefinitionSubOptionData	Get Filter Sub Option Source Data
POST {version}/SaveContactFilter	Save Contact Filter
POST {version}/GetFilterResults	Get Filter Results
POST {version}/GetEntitiesFromExpression	Get Entities From Expression
POST {version}/CloneFilter	Clone Filter and associated Tables
POST {version}/GetFilterFromExpression	Get Filter From Expression
POST {version}/ManipulateTags	Add/Remove Tags to Entities
POST {version}/AddEvent	Add Event to Entities
POST {version}/AddNote	Add Note to Entities

QRTReport

API	Description
GET {version}/GetReportActions?id={id}	Get QRT Report Actions
POST {version}/TakeActionOnQRT	Updates Records

ConnectionType

API	Description
GET {version}/GetConnectionTypes	Get Connection Types

QRTChart

API	Description
GET {version}/QRTCharts	Get QRT Chart Definitions
POST {version}/AddChartAsUserPreference	Add Chart as User Preference
POST {version}/DeleteChartAsUserPreference	Delete Chat as User Preference
POST {version}/MoveRows	Move Chart Rows as per user Preference

CreateDatabase

API	Description
POST {version}/CreateDatabase	No documentation available.

SystemMessage

API	Description
GET {version}/GetAllSystemMessages	Get High Importance System Messages

ImportQueue

API	Description
POST {version}/ImportQueue	Inserts a record into the Import Queue. Expects an object in the request body which consists of an ImportQueueRecord and an optional list of CodeNames.
POST {version}/UpdateImportQueue	No documentation available.
POST {version}/GetImportedRecords	Get Imported Records
POST {version}/ImportQueueBulkUpdate	Bulk Update Import Queue Record/Records
POST {version}/ProcessImportQueues	Process Import Queue Record/Records
POST {version}/ImportQueueUpdate	Update Import Queue Record
POST {version}/DeleteImportQueues	Delete Import Queues
POST {version}/GetImportQueues	Get All Import Queues filter by Criteria
POST {version}/GetImportQueueSources	Get All Import Queue Sources
POST {version}/GetImportQueueMatches	Get All Import Queue Sources
POST {version}/GetAmountForImportQueueMatches	Get All Import Queue Sources

ImportSetting

API	Description
POST {version}/DeleteImportSetting	Delete Import Setting
POST {version}/GetImportSettings	Get Import Settings
POST {version}/SaveImportSetting	Save Import Setting

ComplianceReport

API	Description
GET {version}/GetComplianceReportPage	Get Compliance Report Page

User

API	Description
GET {version}/GetActiveUsers	Get Active Users
POST {version}/LogActivityAndCreateCustomGreetingSetting	Log user activity
POST {version}/DbSelectorDatabases
POST {version}/DbSelectorAggregates
POST {version}/DbSelectorUpdateFavorite
POST {version}/LogApiCall

Transaction

API	Description
POST {version}/GetPaginatedTransactionsForEntity	Get Paginated Transactions For an Entity
POST {version}/GetFinancialSearchResults
POST {version}/GetFinancialSearchOnDemand
POST {version}/CalculateAndSaveSplits	Inserts a JFC Splits for a Transaction
POST {version}/DeleteSplitsAssociatedWithTheTransaction	Deletes a JFC Splits for a Transaction
POST {version}/FilingDateCheck
POST {version}/GetProfileTransactionsDownload
POST {version}/GetRegisterTransactions
POST {version}/GetRegisterTransactionsDownload
POST {version}/GetRegisterTotals
POST {version}/GetDistributedLevelsForTransaction	Get Levels for a Transaction which are distributed
GET {version}/GetAllTransactionsIntermediary
GET {version}/GetAllSupportedOpposedIndividuals
POST {version}/MassDeleteTransactions
POST {version}/MassUpdateTransactions
POST {version}/FinancialSearchResultsDownload
POST {version}/GetAccountDetails
POST {version}/SaveAccount
POST {version}/SaveAccountSignature
POST {version}/SaveAccountLogo
GET {version}/GetTransactionDetails?transactionId={transactionId}

Merge

API	Description
POST {version}/DeleteAllExcludedEntities	Delete All Excluded Entities
POST {version}/ExcludeEntitiesFromMerge	Exclude Entities From Merge
POST {version}/MassMerge
POST {version}/DownloadMergeGroups	Downloads merge matches with duplicate records.
POST {version}/GetCompareData	Gets additional data for merge comparison

CallSheet

API	Description
POST {version}/SaveCallSheetTemplate	Save Call Sheet Template
POST {version}/FulfilEmailMeetingRequest	Sends Email/Meeting Request with Call Sheet as attachment
POST {version}/DeleteCallSheetTemplate	Delete Call Sheet Template
GET {version}/GetCallSheetTemplates	Get Call Sheet Templates
GET {version}/GetCallSheetTemplateDetails?id={id}	Get Call Sheet Template Details
GET {version}/GetCallSheetResults?QueryType={QueryType}&QueryId={QueryId}&TemplateId={TemplateId}&BasePath={BasePath}&OrderBy={OrderBy}&NoOfEntities={NoOfEntities}&AddTags={AddTags}&RemoveTags={RemoveTags}&Entities={Entities}&TemplateName={TemplateName}	Get Call Sheet Results
POST {version}/GenerateCallSheetsForEntities	Generate Call Sheet for Entities

ImportTemplate

API	Description
GET {version}/ImportTemplate/{id}	Get Import Template Definition
GET {version}/GetImportTemplateFields?id={id}	Get Import Template Fields
GET {version}/GetUserImportTemplates	Get User Import Templates
POST {version}/SaveUserImportTemplates	Save User Import Templates
GET {version}/GetImportTemplates	Get Import Templates

EntityGroup

API	Description
GET {version}/GetTags	Get Tags

QB

API	Description
POST {version}/QBManipulateTags	Add/Remove Tags to Entities

Provisioning

API	Description
GET {version}/IsClientNameUnique	Validate if Client Name is Unique
POST {version}/CreateSecurityConfiguration	Create Security Configuration

TwoFactor

API	Description
POST {version}/TwoFactorDomainCheck
POST {version}/SaveTwoFactorOperator
POST {version}/TurnOnDbTwoFactorSetting
POST {version}/RemoveTwoFactorSetting
POST {version}/GetTwoFactorSettings
POST {version}/GetTwoFactorSettingsAuthorized

ExternalSource

API	Description
POST {version}/CreatedEntityFromExternalSource	Create an Entity from the External Source
GET {version}/ExternalSource/{id}	Get External Source Record

CallSheetExport

API	Description
POST {version}/CallSheetExport	Get Call Sheet Export as PDF

FilingCommittee

API	Description
GET {version}/GetFilingCommittees	Get Filing Committees
GET {version}/GetJointFilingCommitteesCount	Get Count of Joint Filing Committees
POST {version}/JointFundraisingToolMenuVisibility	SPRINT 88 RELATED. MOVE THIS OUT EVENTUALLY.

Account

API	Description
GET {version}/GetAccounts	Get Accounts

SPF

API	Description
GET {version}/IsDomainValid?fromEmail={fromEmail}	Is Domain Valid for the Email

Tag

API	Description
POST {version}/ManageTagsForEntities	Create an Entity from the External Source

Note

API	Description
GET {version}/GetSystemNote	Get System Note
POST {version}/SaveSystemNote	Save System Note

EntityGroupCategory

API	Description
GET {version}/GetTagCategories	Get Tag categories

Event

API	Description
GET {version}/GetEvents	Get Events

ImportManager

API	Description
POST {version}/GetImportManagerRecords	Get Import Manager Records
POST {version}/UpdateImportManagerRecord	Update Import Manager Record
POST {version}/GetImportDetails	No documentation available.