All Resources
Constituents

The following operations are available for this resource.

Http Verb Operation
Get CRM/Constituents/{constituentId} Get the details of a Constituent using id.
GET Method: Get, URL: CRM/Constituents/{constituentId} Test

Get the details of a Constituent using id.
GetConstituent CRM/Constituents/{constituentId}/Detail?includeAffiliations={includeAffiliations} Get constituent details with addresses, electronicAddresses, salutations and phones. To exclude information about visible affiliations pass includeAffiliations="false"
GET Method: GetConstituent, URL: CRM/Constituents/{constituentId}/Detail?includeAffiliations={includeAffiliations} Test

Get constituent details with addresses, electronicAddresses, salutations and phones. To exclude information about visible affiliations pass includeAffiliations="false"
GetConstituentDevelopmentInfo CRM/Constituents/{constituentId}/DevelopmentInfo Get constituent information for fundraising.
GET Method: GetConstituentDevelopmentInfo, URL: CRM/Constituents/{constituentId}/DevelopmentInfo Test

Get constituent information for fundraising.
GetConstituents CRM/Constituents?constituentIds={constituentIds} Get multiple Constituents given a set of constituentIds.
GET Method: GetConstituents, URL: CRM/Constituents?constituentIds={constituentIds} Test

Get multiple Constituents given a set of constituentIds.
GetConstituentSnapshot CRM/Constituents/{constituentId}/Snapshot Get constituent details along with primary address, primary salutation, primary electronic address, phones and affiliates information.
GET Method: GetConstituentSnapshot, URL: CRM/Constituents/{constituentId}/Snapshot Test

Get constituent details along with primary address, primary salutation, primary electronic address, phones and affiliates information.
GetDefaultHeader CRM/Constituents/{constituentId}/Header/Default Return the default header for the constituent, including configured flexible header names and values.
GET Method: GetDefaultHeader, URL: CRM/Constituents/{constituentId}/Header/Default Test

Return the default header for the constituent, including configured flexible header names and values.
GetFlexHeader CRM/Constituents/{constituentId}/Header/Flex/{headerId} Get the details of a flex header for a constituent
GET Method: GetFlexHeader, URL: CRM/Constituents/{constituentId}/Header/Flex/{headerId} Test

Get the details of a flex header for a constituent
GetHeader CRM/Constituents/{constituentId}/Header/{headerId} Return constituent header details, including configured flexible header names and values.
GET Method: GetHeader, URL: CRM/Constituents/{constituentId}/Header/{headerId} Test

Return constituent header details, including configured flexible header names and values.
GetPrimaryHousehold CRM/Constituents/PrimaryHousehold?constituentId={constituentId} Get primary household constituent details for a provided constituentId.
GET Method: GetPrimaryHousehold, URL: CRM/Constituents/PrimaryHousehold?constituentId={constituentId} Test

Get primary household constituent details for a provided constituentId.
Search CRM/Constituents/Search?type={type}&q={q}&constituentGroups={constituentGroups}&dup={dup}&includeAffiliates={includeAffiliates}&constituencyIds={constituencyIds}&listId={listId}&ln={ln}&fn={fn}&constituentId={constituentId}&street={street}&post={post}&atype={atype}&op={op}&value={value}&key={key}&page={page}&pageSize={pageSize} Search for constituents using one of four possible search modes. Querystring parameters are valid based on the "type" parameter value. Single Line (type=fluent) Sample: CRM/Constituents/Search?type=fluent&q=Huff Single Line search type (or fluent) is the default search if not provided in querystring. Single line search works on string patterns in the passed search value ("q" param). Patterns are as follows: Value contains only alpha characters - interpreted as a last name search. To search with first name, pass comma then additional search value ("last, first"). Text enclosed in quotes is interpreted as a search for name ("ACE 123 Corporation"). value containing an @ symbol is interpreted as an email address. Value starting with # is interpreted as a phone number search. Value containing alpha and numeric characters is interpreted as a postal code. UK and other countries should omit spaces for postal code search values. Basic search type permits parameters constituentId, ln, fn, street, and post. Sample URL: CRM/Constituents/Search?type=basic&ln=Huff&fn=Frank&post=20746 Advanced search type permits parameters atype, op, and value. Sample URL: CRM/Constituents/Search?type=advanced&atype=Email&op=Like&value=%25@gmail.com Attribute search type permits parameters key, op, value. Sample URL: CRM/Constituents/Search?type=attribute&key=Board+Affiliation&op=Equals&value=Association+Member

Search for constituents using one of four possible search modes. Querystring parameters are valid based on the "type" parameter value.
ConvertGroupToIndividual CRM/Constituents/{constituentId}/ConvertToIndividual Convert existing household to an individual.
POST Method: ConvertGroupToIndividual, URL: CRM/Constituents/{constituentId}/ConvertToIndividual Test

Convert existing household to an individual.
ConvertIndividualToHousehold CRM/Constituents/{constituentId}/ConvertToHousehold Convert existing individual constituent to a household.
POST Method: ConvertIndividualToHousehold, URL: CRM/Constituents/{constituentId}/ConvertToHousehold Test

Convert existing individual constituent to a household.
ConvertIndividualToOrganization CRM/Constituents/{constituentId}/ConvertToOrganization Convert existing individual constituent to an organization.
POST Method: ConvertIndividualToOrganization, URL: CRM/Constituents/{constituentId}/ConvertToOrganization Test

Convert existing individual constituent to an organization.
CreateConstituent CRM/Constituents/Detail Create a new constituent with addresses, electronicAddresses, salutations and phones.
POST Method: CreateConstituent, URL: CRM/Constituents/Detail Test

Create a new constituent with addresses, electronicAddresses, salutations and phones.
CreateConstituentUsingSnapshot CRM/Constituents/Snapshot Create a constituent optionally with primary address, primary salutation, primary electronic address, primary & general phones and affiliates information.
POST Method: CreateConstituentUsingSnapshot, URL: CRM/Constituents/Snapshot Test

Create a constituent optionally with primary address, primary salutation, primary electronic address, primary & general phones and affiliates information.
SchedulePurge CRM/Constituents/{constituentId}/Purge/Schedule Schedule a constituent to be purged. This only marks a constituent for purge, but does not actually purge the constituent. If constituent has open transactions or an order for a future performance, a bad request will be returned indicating open transactions. Pass IgnoreWarnings = true in request to bypass and schedule.
POST Method: SchedulePurge, URL: CRM/Constituents/{constituentId}/Purge/Schedule Test

Schedule a constituent to be purged. This only marks a constituent for purge, but does not actually purge the constituent. If constituent has open transactions or an order for a future performance, a bad request will be returned indicating open transactions. Pass IgnoreWarnings = true in request to bypass and schedule.
SearchByCardNumber CRM/Constituents/Search/ByCardNumber Search for constituents by card number.
POST Method: SearchByCardNumber, URL: CRM/Constituents/Search/ByCardNumber Test

Search for constituents by card number.
SwapConstituentA1A2 CRM/Constituents/{constituentId}/Snapshot/SwapA1A2 Swaps A1/A2 names on a household account and regenerates its salutation.
POST Method: SwapConstituentA1A2, URL: CRM/Constituents/{constituentId}/Snapshot/SwapA1A2 Test

Swaps A1/A2 names on a household account and regenerates its salutation.
UnschedulePurge CRM/Constituents/{constituentId}/Purge/Unschedule Unschedule a constituent that has been previously set to be purged. If a purge has been completed, an error will be returned.
POST Method: UnschedulePurge, URL: CRM/Constituents/{constituentId}/Purge/Unschedule Test

Unschedule a constituent that has been previously set to be purged. If a purge has been completed, an error will be returned.
Update CRM/Constituents/{constituentId} Update a constituent. Only the information about constituent can be updated. If addresses, electronicAddresses, salutations or phones data are passed, they will be ignored.
PUT Method: Update, URL: CRM/Constituents/{constituentId} Test

Update a constituent. Only the information about constituent can be updated. If addresses, electronicAddresses, salutations or phones data are passed, they will be ignored.