Announcements

APIDescription
GET api/v2.0/Announcements/GetAnnouncements?announcementTypeFilter={announcementTypeFilter}&communityKey={communityKey}&micrositeGroupTypeRouteDesignKey={micrositeGroupTypeRouteDesignKey}&sortOrder={sortOrder}&maxResults={maxResults}&includeAnnouncementsWithNoType={includeAnnouncementsWithNoType}

Returns a list of Announcements given the specified criteria.

GET api/v2.0/Announcements/GetAnnouncement?announcementKey={announcementKey}

Returns the details of the specified Announcement.

Authentication

APIDescription
GET api/v2.0/Authentication/GetLogin?username={username}&password={password}

Generates a Authentication Token for a given user.

POST api/v2.0/Authentication/Login

Generates a Authentication Token for the user with the specified credentials.

GET api/v2.0/Authentication/GetTenantDetail?communityUrl={communityUrl}

Returns information about a Tenant for a given Connected Community Site Url.

POST api/v2.0/Authentication/Widget

Used to Authenticate to the Widgets Platform

AutomationRules

APIDescription
GET api/v2.0/AutomationRules/GetActiveRulesByType

Retrieves a list of Automation Rules and associated data. Accessible only by Admin Users.

GET api/v2.0/AutomationRules/GetContactsByRuleScheduleKey?ruleScheduleKey={ruleScheduleKey}&integrationId={integrationId}

Retrieves a list of Contacts for which the specified RuleSchedule applies. Accessible only by Admin Users.

GET api/v2.0/AutomationRules/GetContactDataSubsetByRuleScheduleKey?ruleScheduleKey={ruleScheduleKey}&integrationId={integrationId}

Returns the requested subset of Contact Data.

Blogs

APIDescription
POST api/v2.0/Blogs/GetLatestEntries

Retrieves the Blog Entries that meet the filter conditions.

GET api/v2.0/Blogs/GetBlogEntriesByGrouping?groupingType={groupingType}&maxRecords={maxRecords}

Retrieves Blog Entries by the specified GroupingType.

POST api/v2.0/Blogs/CreateBlog

Create a new Blog.

POST api/v2.0/Blogs/PublishBlog?blogKey={blogKey}

Publishes a previously Saved Blog. If the Blog has already been Published, no changes are made.

POST api/v2.0/Blogs/UpdateBlog?blogKey={blogKey}

Update a Blog's Title, Text, Comment Permissions, View Permissions and Associated Community.

POST api/v2.0/Blogs/AddRelatedLink?blogKey={blogKey}

Adds the specified URL as a RelatedLink to the specified Blog.

GET api/v2.0/Blogs/GetBlogsByContactKey?contactKey={contactKey}

Retrieves all Published Blog Entries created by the Member with the specified ContactKey.

GET api/v2.0/Blogs/GetBlog?blogKey={blogKey}

Retrieves the specified Blog by its key. If the specified key does not match an existing BlogKey, no results will be returned. If the User making the request does not have view permissions for the specified Blog, no results will be returned.

POST api/v2.0/Blogs/RecommendBlog?blogKey={blogKey}

Adds a recommendation for the specified Blog.

DELETE api/v2.0/Blogs/DeleteBlogRecommendation?blogKey={blogKey}

Removes a previously made recommendation.

DELETE api/v2.0/Blogs/DeleteBlog?blogKey={blogKey}

Deletes a Blog.

POST api/v2.0/Blogs/AddComment?blogKey={blogKey}

Add a new Comment to a Blog.

POST api/v2.0/Blogs/UpdateComment?blogCommentKey={blogCommentKey}

Updates the specified Blog Comment with new Comment Text.

DELETE api/v2.0/Blogs/DeleteRelatedLink?relatedResourceKey={relatedResourceKey}

Deletes the specified RelatedLink.

DELETE api/v2.0/Blogs/DeleteComment?blogCommentKey={blogCommentKey}

Deletes the specified Blog Comment.

Communities

APIDescription
GET api/v2.0/Communities/GetMyCommunities?includeStatistics={includeStatistics}&includeHiddenCommunities={includeHiddenCommunities}

Returns a list of the Current User's joined Communities.

GET api/v2.0/Communities/GetViewableCommunities?includeStatistics={includeStatistics}

Returns a list of Communities the Current User can see.

GET api/v2.0/Communities/GetMyCommunityInvitations

Retrieve all Community Invitations.

POST api/v2.0/Communities/GetCommunityMembers

Retrieve a list of Members of the specified Community in LastName, FirstName order.

POST api/v2.0/Communities/InviteToCommunity?contactKey={contactKey}&communityKey={communityKey}

Allows the Current User to invite a specified Contact to a specified Community.

POST api/v2.0/Communities/AcceptInvitation

Accept an invitation to a Community.

DELETE api/v2.0/Communities/RejectInvitation?communityInvitationKey={communityInvitationKey}

Reject an Invite to a Community.

DELETE api/v2.0/Communities/LeaveCommunity?communityKey={communityKey}

Removes the Current Contact from the specified Community.

Contacts

APIDescription
POST api/v2.0/Contacts/WhoAmI

Returns information about the Currently Authenticated User.

GET api/v2.0/Contacts/GetWhoAmI

Returns information about the Currently Authenticated User.

GET api/v2.0/Contacts/GetContact?contactKey={contactKey}

Returns Contact information for the specified contactKey.

GET api/v2.0/Contacts/GetContact?legacyContactKey={legacyContactKey}

Returns Contact information for the specified legacyContactKey.

GET api/v2.0/Contacts/GetMyContacts

Returns a list of Contacts that are Friends of the Current User.

GET api/v2.0/Contacts/GetContactKeyByPrimaryEmail?emailAddress={emailAddress}

Used to find an active Contact by a primary email address. Can only be accessed by an Admin user.

POST api/v2.0/Contacts/AcceptCodeOfConduct

Stores the Current Date as the Acceptance Date.

GET api/v2.0/Contacts/SearchContacts?searchTerms={searchTerms}&searchAllAddresses={searchAllAddresses}&memberStatus={memberStatus}&searchOnlyCompanies={searchOnlyCompanies}&overrideOptOut={overrideOptOut}&contactStatusCode={contactStatusCode}&includeMiddleName={includeMiddleName}&limitToAcceptedTerms={limitToAcceptedTerms}

Returns Contact data for all Contact Records that match the specified criteria. Searches: City, State/Province, Company Name, Company Title, First Name, Last Name and optionally, Middle Name.

Demographics

Endpoints related to Demographics.

APIDescription
POST api/v2.0/Demographics/AddDemographicCategory

Add a new demographic category. Can only be accessed by an Admin user.

POST api/v2.0/Demographics/AddDemographicChoice

Add a new demographic choice. Can only be accessed by an Admin user.

POST api/v2.0/Demographics/SetContactDemographic?demographicKey={demographicKey}

Returns a collection of all existing demographic categories

DELETE api/v2.0/Demographics/RemoveContactDemographic?demographicKey={demographicKey}

Deletes the specified Demographic from the Current User's record.

DELETE api/v2.0/Demographics/RemoveFreeFormContactDemographic?demographicTypeKey={demographicTypeKey}

Deletes the specified Free-Form Demographic entry from the Current User's record.

POST api/v2.0/Demographics/SetFreeFormContactDemographic?demographicTypeKey={demographicTypeKey}&freeFormText={freeFormText}

Update an existing Free-Form Demographic entry or add a new one.

GET api/v2.0/Demographics/GetDemographicTypes

Get the available Demographic Types.

GET api/v2.0/Demographics/GetDemographicChoices

Get the available Demographic choices.

GET api/v2.0/Demographics/GetDemographicChoices?demographicTypeKey={demographicTypeKey}

Returns a list of all existing demographic choices for a given demographic category

Discussions

Operations to return Discussion-related data.

APIDescription
GET api/v2.0/Discussions/GetDiscussion?discussionKey={discussionKey}

Get the Discussion by its Unique Key.

GET api/v2.0/Discussions/GetDiscussionPost?discussionPostKey={discussionPostKey}

Get a DiscussionPost by its Unique Key.

GET api/v2.0/Discussions/GetSubscribedDiscussions

Get a list of Discussions to which the Current User is subscribed. Keep in mind that Community membership does not imply Discussion Subscription.

GET api/v2.0/Discussions/GetLatestDiscussionPosts?discussionKey={discussionKey}&maxToRetrieve={maxToRetrieve}&sortByScore={sortByScore}&scoreSortDirection={scoreSortDirection}

Retrieves the latest Discussion Posts for either a single discussion or all viewable discussions.

GET api/v2.0/Discussions/GetDiscussionPosts?discussionKey={discussionKey}&maxToRetrieve={maxToRetrieve}&includeStaff={includeStaff}&sortByScore={sortByScore}&scoreSortDirection={scoreSortDirection}

Retrieves latest discussion posts for either a single discussion or all viewable discussions. Exposes IncludeStaff parameter.

POST api/v2.0/Discussions/GetDiscussionPosts

Returns a list of Discussion Posts for the Current User.

GET api/v2.0/Discussions/GetDiscussionPosts?discussionThreadKey={discussionThreadKey}

Returns all Discussion Posts for the specified Discussion Thread.

GET api/v2.0/Discussions/GetLatestTopics?discussionKey={discussionKey}&maxToRetrieve={maxToRetrieve}

No documentation available.

POST api/v2.0/Discussions/SubmitDiscussionPost

Submit a new DiscussionPost to a Discussion.

POST api/v2.0/Discussions/UpdateSubscription

Update Discussion Subscription.

GET api/v2.0/Discussions/GetRecentThreads?discussionKey={discussionKey}&maxToRetrieve={maxToRetrieve}

Retrieves Discussion Thread details. The Threads are returned in descending order of the Last Approval Date for Posts within each Thread. So, Threads with more recent activity will be returned first in the list.

GET api/v2.0/Discussions/GetEligibleDiscussions

Get a List of Discussions to which the Current User is Eligible to subscribe.

POST api/v2.0/Discussions/PostToDiscussionWithCrossPost

No documentation available.

POST api/v2.0/Discussions/PostToDiscussionAnonymously

No documentation available.

POST api/v2.0/Discussions/PostToDiscussion

Post a Message to the specified Discussion.

POST api/v2.0/Discussions/ReplyToDiscussion

No documentation available.

POST api/v2.0/Discussions/ReplyToDiscussionAnonymously

Submit a Discussion Post using the System's Anonymous user. This functionality requires Anonymous Posting to be enabled at the system level.

POST api/v2.0/Discussions/SendMessageToDiscussionPostAuthor

Sends an Inbox Message Reply to a specified Discussion Post's Author.

POST api/v2.0/Discussions/SearchDiscussionPosts

Returns Discussion Post information that meet the search criteria.

POST api/v2.0/Discussions/RecommendDiscussionPost?discussionPostKey={discussionPostKey}

Adds a recommendation for the specified Discussion Post.

DELETE api/v2.0/Discussions/DeleteDiscussionPostRecommendation?discussionPostKey={discussionPostKey}

Removes a previously made recommendation.

Events

APIDescription
GET api/v2.0/Events/GetRegistrantDetails?calendarEventKey={calendarEventKey}&contactKey={contactKey}&emailAddress={emailAddress}&firstName={firstName}&lastName={lastName}&useLeadingWildcardSearch={useLeadingWildcardSearch}

Administrator-accessible only endpoint. Returns details about a Registrant for a given Calendar Event. The calendarEventKey parameter is required, along with either contactKey, emailAddress, or lastName.

GET api/v2.0/Events/GetEventType?EventTypeKey={EventTypeKey}

Returns an Event Type

GET api/v2.0/Events/GetEventTypes

Returns all Event Types

GET api/v2.0/Events/GetEventTypesList

Get a list of active event types

POST api/v2.0/Events/SaveEventType

Saves an Event Type

POST api/v2.0/Events/DeleteEventType?eventTypeKey={eventTypeKey}

Deletes an Event Type

POST api/v2.0/Events/RestoreEventType?eventTypeKey={eventTypeKey}

Restores a Deleted Event Type

GET api/v2.0/Events/GetEvent?eventKey={eventKey}

Retrieve details about a single Event.

GET api/v2.0/Events/GetUpcoming?maxRecords={maxRecords}

Returns all Current (beginning today) and Future Events.

POST api/v2.0/Events/SearchCurrentAndFutureEvents?includePastEvents={includePastEvents}&maxRecords={maxRecords}

Returns all Current (beginning today) and Future Events unless otherwise specified.

POST api/v2.0/Events/SearchEvents?maxRecords={maxRecords}

Get Event details. The retrieved Events can be filtered by the values passed in the eventFilter parameter.

GET api/v2.0/Events/GetEventEnabledCommunityList

Gets a collection of allowed communities for the current user that has an associated calendar.

EventSessions

APIDescription
GET api/v2.0/EventSessions/GetSession?sessionKey={sessionKey}

No documentation available.

ExternalActivity

Provides Mechanisms to Create, Modify, Delete External Activity records.

APIDescription
POST api/v2.0/ExternalActivity/Create

Create a new ExternalActivity record.

PUT api/v2.0/ExternalActivity/Update

DELETE api/v2.0/ExternalActivity/Delete?externalActivityKey={externalActivityKey}&legacyActivityKey={legacyActivityKey}

Friends

APIDescription
GET api/v2.0/Friends/GetPendingReceivedFriendRequests

Returns a List of FriendModel objects representing the pending Friend Requests that the Current User has RECEIVED.

GET api/v2.0/Friends/GetPendingSentFriendRequests

Returns a List of FriendModel objects representing the pending Friend Requests that the Current User has SENT.

GET api/v2.0/Friends/GetAcceptedFriendRequests?daysBack={daysBack}

Returns a list of Accepted Friend Request records.

POST api/v2.0/Friends/PostFriendRequest?contactKey={contactKey}

Sends a friend request from the Current User to the specified Contact.

POST api/v2.0/Friends/AcceptFriendRequest?friendRequestRecordKey={friendRequestRecordKey}

Accepts a Friend Request.

POST api/v2.0/Friends/RejectFriendRequest?friendRequestRecordKey={friendRequestRecordKey}

Rejects a Friend Request.

POST api/v2.0/Friends/UnFriend?contactKey={contactKey}

Removes a Friend Relationship from the Current User.

Messaging

APIDescription
GET api/v2.0/Messaging/GetInboxMessages?firstRecord={firstRecord}&maxRecords={maxRecords}

Retrieves all Inbox Messages for the Current User.

GET api/v2.0/Messaging/GetSentMessages?firstRecord={firstRecord}&maxRecords={maxRecords}

Retrieves Mailbox Messages sent by the current user.

POST api/v2.0/Messaging/SendMessageToContact

Sends a new Message to the specified Contact.

POST api/v2.0/Messaging/ReplyToMessage

Submits a new Discussion Post in Reply to a specified Mailbox Message.

POST api/v2.0/Messaging/MarkMessageAsRead?messageKey={messageKey}

Changes the specified Mailbox Message Read Status to True.

GET api/v2.0/Messaging/MarkMessageAsRead?messageKey={messageKey}

Changes the specified Mailbox Message Read Status to True.

POST api/v2.0/Messaging/DeleteMessages

Deletes Mailbox Messages from the Authenticated User's Inbox.

POST api/v2.0/Messaging/MarkMessageAsUnRead?messageKey={messageKey}

Changes the specified Mailbox Message Read Status to False.

GET api/v2.0/Messaging/MarkMessageAsUnRead?messageKey={messageKey}

Changes the specified Mailbox Message Read Status to False.

GET api/v2.0/Messaging/GetUnreadMessageCounts

Returns a key-value pair of ContactKey and Unread Message Count. Includes Inbox Messages, Friend Requests and Community Invitations.

POST api/v2.0/Messaging/SendMessageToDiscussionPostAuthor

Sends a private Mailbox Message to the Author of a DiscussionPost.

RegistrantClass

APIDescription
GET api/v2.0/RegistrantClass/GetRegistrantClasses?Active={Active}

Get a list of Registrant Classes

ResourceLibrary

APIDescription
GET api/v2.0/ResourceLibrary/GetLibraryList

Returns a list of Libraries that the Current User is Allowed to View/Join.

GET api/v2.0/ResourceLibrary/GetLibraryDocument?documentKey={documentKey}

Returns Document details for the specified DocumentKey.

GET api/v2.0/ResourceLibrary/GetMyLibraryDocuments?maxRecords={maxRecords}

Returns Document Entries created by the Current User.

POST api/v2.0/ResourceLibrary/GetLibraryDocuments

Returns Library Documents according to the optional filter values. Results are returned in Descending Date order.

POST api/v2.0/ResourceLibrary/AddComment?documentKey={documentKey}

Add a new Comment to a Document.

POST api/v2.0/ResourceLibrary/UpdateComment?documentCommentKey={documentCommentKey}

Updates the specified Document Comment with new Comment Text.

DELETE api/v2.0/ResourceLibrary/DeleteComment?documentCommentKey={documentCommentKey}

Deletes the specified Document Comment.

DELETE api/v2.0/ResourceLibrary/DeleteLibraryDocument?documentKey={documentKey}

Deletes the specified Library Document.

POST api/v2.0/ResourceLibrary/AddRelatedLink?documentKey={documentKey}

Adds the specified URL as a RelatedLink to the specified Document.

POST api/v2.0/ResourceLibrary/GetFavorites

No documentation available.

POST api/v2.0/ResourceLibrary/AddToFavorites?documentKey={documentKey}

Add the specified Document to the Authenticated User's Favorite List.

DELETE api/v2.0/ResourceLibrary/RemoveFromFavorites?documentKey={documentKey}

Remove the specified Document from the Authenticated User's Favorite List.

DELETE api/v2.0/ResourceLibrary/DeleteRelatedLink?relatedLinkKey={relatedLinkKey}

Deletes the specified RelatedLink.

POST api/v2.0/ResourceLibrary/RecommendDocument?documentKey={documentKey}

Adds a recommendation for the specified Document.

DELETE api/v2.0/ResourceLibrary/DeleteDocumentRecommendation?documentKey={documentKey}

Removes a previously made recommendation.

POST api/v2.0/ResourceLibrary/UploadDocumentFile?documentKey={documentKey}

* Obsolete * Non-functioning method.

POST api/v2.0/ResourceLibrary/PostDocumentAttachments?documentKey={documentKey}

Accepts Multipart MIME files via a POST Request.

System

APIDescription
GET api/v2.0/System/GetApiDetails

Returns name and parameter type descriptions for the public API endpoints.

GET api/v2.0/System/GetCodeOfConduct

Get the Code of Conduct Details.

POST api/v2.0/System/GetCommunityMemberUpdates

Allows an Admin User to View Members who have Joined and Left Communities in the Specified timeframe.

Volunteer

Endpoints related to the Volunteer Module.

APIDescription
POST api/v2.0/Volunteer/AddToPoolByContactKey?contactKey={contactKey}

Add a new user to the General Volunteer Pool. Can only be accessed by an Admin user.

POST api/v2.0/Volunteer/AddToPoolByLegacyKey?legacyContactKey={legacyContactKey}

Add a new user to the General Volunteer Pool. Can only be accessed by an Admin user.

DELETE api/v2.0/Volunteer/RemoveFromPoolByContactKey?contactKey={contactKey}

Removes the specified Contact from the General Volunteer Pool. Can only be accessed by an Admin user.

DELETE api/v2.0/Volunteer/RemoveFromPoolByLegacyContactKey?legacyContactKey={legacyContactKey}

Removes the specified Contact from the General Volunteer Pool. Can only be accessed by an Admin user.

POST api/v2.0/Volunteer/VolunteerForOpportunityByContactKey?volunteerOpportunityKey={volunteerOpportunityKey}&contactKey={contactKey}&comments={comments}

Volunteer a Contact for a specific Volunteer Opportunity. Can only be accessed by an Admin user.

POST api/v2.0/Volunteer/VolunteerForOpportunity?volunteerOpportunityKey={volunteerOpportunityKey}&comments={comments}

Volunteer for a specific Volunteer Opportunity.

POST api/v2.0/Volunteer/VolunteerForOpportunityByLegacyContactKey?volunteerOpportunityKey={volunteerOpportunityKey}&legacyContactKey={legacyContactKey}&comments={comments}

Volunteer a Contact for a specific Volunteer Opportunity. Administrative access is required.

DELETE api/v2.0/Volunteer/WithdrawFromOpportunity?volunteerOpportunityKey={volunteerOpportunityKey}&comments={comments}

Removes the requesting user from a Volunteer Opportunity. If successful, responds with a 204 (no content). If the current user is not currently listed as a Volunteer for the specified Volunteer Opportunity, responds with a 404 (not found).

DELETE api/v2.0/Volunteer/WithdrawFromOpportunityByContactKey?volunteerOpportunityKey={volunteerOpportunityKey}&contactKey={contactKey}&comments={comments}

Removes the requesting user from a Volunteer Opportunity. If successful, responds with a 204 (no content). If the current user is not currently listed as a Volunteer for the specified Volunteer Opportunity, responds with a 404 (not found). Can only be accessed by an Admin user.

DELETE api/v2.0/Volunteer/WithdrawFromOpportunityByLegacyContactKey?volunteerOpportunityKey={volunteerOpportunityKey}&legacyContactKey={legacyContactKey}&comments={comments}

Removes the requesting user from a Volunteer Opportunity. If successful, responds with a 204 (no content). If the current user is not currently listed as a Volunteer for the specified Volunteer Opportunity, responds with a 404 (not found). Can only be accessed by an Admin user.

GET api/v2.0/Volunteer/GetVolunteerOpportunityList

Returns a list of active Volunteer Opportunities in the system.

GET api/v2.0/Volunteer/GetVolunteerList?volunteerOpportunityKey={volunteerOpportunityKey}

Accessible only by Super Admin, Community Admin (if the Volunteer Opportunity is associated with a Community), and Volunteer Admins only. Returns information about all Volunteers for a specified Volunteer Opportunity.

GET api/v2.0/Volunteer/GetUpcomingVolunteerOpportunities?opportunityTypeKey={opportunityTypeKey}&communityKey={communityKey}&maxToRetrieve={maxToRetrieve}

Returns Upcoming VolunteerOpportunies for Current User.

GET api/v2.0/Volunteer/GetVolunteerOpportunityTypeList

Returns a list of Volunteer Opportunity Types.