Higher Logic API v1.0

Higher Logic API Endpoint Documentation

Click on a specific Endpoint to see examples of Request and Response data and formatting.

Announcements

API	Description
GET api/v1.0/Announcements/GetAnnouncements?announcementTypeFilter={announcementTypeFilter}&communityKey={communityKey}&micrositeGroupTypeRouteDesignKey={micrositeGroupTypeRouteDesignKey}&sortOrder={sortOrder}&maxResults={maxResults}	Returns a list of Announcements given the specified criteria.
GET api/v1.0/Announcements/GetAnnouncement?announcementKey={announcementKey}	Returns the details of the specified Announcement.

Authentication

API	Description
POST api/v1.0/Authentication/Login	Generates a Authentication Token for the user with the specified credentials.
GET api/v1.0/Authentication/GetTenantDetail?communityUrl={communityUrl}	Returns information about a Tenant for a given Connected Community Site Url.
POST api/v1.0/Authentication/Widget	No documentation available.

Blogs

API	Description
POST api/v1.0/Blogs/GetLatestEntries	Retrieves the Blog Entries that meet the filter conditions.
GET api/v1.0/Blogs/GetBlogEntriesByGrouping?groupingType={groupingType}&maxRecords={maxRecords}	Retrieves Blog Entries by the specified GroupingType.
POST api/v1.0/Blogs/CreateBlog	Create a new Blog.
POST api/v1.0/Blogs/PublishBlog?blogKey={blogKey}	Publishes a previously Saved Blog. If the Blog has already been Published, no changes are made.
POST api/v1.0/Blogs/UpdateBlog?blogKey={blogKey}	Update a Blog's Title, Text, Comment Permissions, View Permissions and Associated Community.
POST api/v1.0/Blogs/AddRelatedLink?blogKey={blogKey}	Adds the specified URL as a RelatedLink to the specified Blog.
GET api/v1.0/Blogs/GetBlogsByContactKey?contactKey={contactKey}	Retrieves all Published Blog Entries created by the Member with the specified ContactKey.
GET api/v1.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/v1.0/Blogs/RecommendBlog?blogKey={blogKey}	Adds a recommendation for the specified Blog.
DELETE api/v1.0/Blogs/DeleteBlogRecommendation?blogKey={blogKey}	Removes a previously made recommendation.
DELETE api/v1.0/Blogs/DeleteBlog?blogKey={blogKey}	Deletes a Blog.
POST api/v1.0/Blogs/AddComment?blogKey={blogKey}	Add a new Comment to a Blog.
POST api/v1.0/Blogs/UpdateComment?blogCommentKey={blogCommentKey}	Updates the specified Blog Comment with new Comment Text.
DELETE api/v1.0/Blogs/DeleteRelatedLink?relatedResourceKey={relatedResourceKey}	Deletes the specified RelatedLink.
DELETE api/v1.0/Blogs/DeleteComment?blogCommentKey={blogCommentKey}	Deletes the specified Blog Comment.

Communities

API	Description
GET api/v1.0/Communities/GetMyCommunities?includeStatistics={includeStatistics}	Returns a list of the Current User's joined Communities.
GET api/v1.0/Communities/GetViewableCommunities?includeStatistics={includeStatistics}	Returns a list of Communities the Current User can see.
GET api/v1.0/Communities/GetMyCommunityInvitations	Retrieve all Community Invitations.
POST api/v1.0/Communities/GetCommunityMembers	Retrieve a list of Members of the specified Community in LastName, FirstName order.
GET api/v1.0/Communities/GetCommunityViewPermission?communityKey={communityKey}	Retrieve the view permission of a specific community
POST api/v1.0/Communities/InviteToCommunity?contactKey={contactKey}&communityKey={communityKey}	Allows the Current User to invite a specified Contact to a specified Community.
POST api/v1.0/Communities/AcceptInvitation	Accept an invitation to a Community.
DELETE api/v1.0/Communities/RejectInvitation?communityInvitationKey={communityInvitationKey}	Reject an Invite to a Community.
DELETE api/v1.0/Communities/LeaveCommunity?communityKey={communityKey}	Removes the Current Contact from the specified Community.

Contacts

API	Description
POST api/v1.0/Contacts/WhoAmI	Returns information about the Currently Authenticated User.
GET api/v1.0/Contacts/GetWhoAmI	Returns information about the Currently Authenticated User.
GET api/v1.0/Contacts/GetContact?contactKey={contactKey}	Returns Contact information for the specified contactKey.
GET api/v1.0/Contacts/GetContact?legacyContactKey={legacyContactKey}	Returns Contact information for the specified legacyContactKey.
GET api/v1.0/Contacts/GetMyContacts	No documentation available.
POST api/v1.0/Contacts/AcceptCodeOfConduct	Stores the Current Date as the Acceptance Date.
GET api/v1.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.

Discussions

API	Description
GET api/v1.0/Discussions/GetDiscussion?discussionKey={discussionKey}	Get the Discussion by its Unique Key.
GET api/v1.0/Discussions/GetDiscussionPost?discussionPostKey={discussionPostKey}	Get a DiscussionPost by its Unique Key.
GET api/v1.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/v1.0/Discussions/GetLatestDiscussionPosts?discussionKey={discussionKey}&maxToRetrieve={maxToRetrieve}	Retrieves the latest Discussion Posts for either a single discussion or all viewable discussions.
POST api/v1.0/Discussions/SubmitDiscussionPost	Submit a new DiscussionPost to a Discussion.
POST api/v1.0/Discussions/UpdateSubscription	Update Discussion Subscription.
POST api/v1.0/Discussions/GetDiscussionPosts	Returns a list of Discussion Posts for the Current User.
GET api/v1.0/Discussions/GetEligibleDiscussions	Get a List of Discussions to which the Current User is Eligible to subscribe.
POST api/v1.0/Discussions/PostToDiscussionWithCrossPost	No documentation available.
POST api/v1.0/Discussions/PostToDiscussionAnonymously	No documentation available.
POST api/v1.0/Discussions/PostToDiscussion	Post a Message to the specified Discussion.
POST api/v1.0/Discussions/ReplyToDiscussion	No documentation available.
POST api/v1.0/Discussions/ReplyToDiscussionAnonymously	No documentation available.
POST api/v1.0/Discussions/SendMessageToDiscussionPostAuthor	Sends an Inbox Message Reply to a specified Discussion Post's Author.
POST api/v1.0/Discussions/SearchDiscussionPosts	Returns Discussion Post information that meet the search criteria.

Events

API	Description
GET api/v1.0/Events/GetEventType?EventTypeKey={EventTypeKey}	Returns an Event Type
GET api/v1.0/Events/GetEventTypes	Returns all Event Types
GET api/v1.0/Events/GetEventTypesList	Get a list of active event types
POST api/v1.0/Events/SaveEventType	Saves an Event Type
POST api/v1.0/Events/DeleteEventType?eventTypeKey={eventTypeKey}	Deletes an Event Type
POST api/v1.0/Events/RestoreEventType?eventTypeKey={eventTypeKey}	Restores a Deleted Event Type
GET api/v1.0/Events/GetEvent?eventKey={eventKey}	Retrieve details about a single Event.
GET api/v1.0/Events/GetUpcoming?maxRecords={maxRecords}	Returns all Current (beginning today) and Future Events.
POST api/v1.0/Events/SearchEvents?maxRecords={maxRecords}	Get Event details. The retrieved Events can be filtered by the values passed in the eventFilter parameter.
GET api/v1.0/Events/GetEventEnabledCommunityList	Gets a collection of allowed communities for the current user that has an associated calendar.

EventSessions

API	Description
GET api/v1.0/EventSessions/GetSession?sessionKey={sessionKey}	No documentation available.

Friends

API	Description
GET api/v1.0/Friends/GetPendingReceivedFriendRequests	Returns a List of FriendModel objects representing the pending Friend Requests that the Current User has RECEIVED.
GET api/v1.0/Friends/GetPendingSentFriendRequests	Returns a List of FriendModel objects representing the pending Friend Requests that the Current User has SENT.
GET api/v1.0/Friends/GetAcceptedFriendRequests?daysBack={daysBack}	Returns a list of Accepted Friend Request records.
POST api/v1.0/Friends/PostFriendRequest?contactKey={contactKey}	Sends a friend request from the Current User to the specified Contact.
POST api/v1.0/Friends/AcceptFriendRequest?friendRequestRecordKey={friendRequestRecordKey}	Accepts a Friend Request.
POST api/v1.0/Friends/RejectFriendRequest?friendRequestRecordKey={friendRequestRecordKey}	Rejects a Friend Request.
POST api/v1.0/Friends/CancelFriendRequest?contactKey={contactKey}	Cancels a Friend Request. Using the current contact and the contactKey of the person the request was sent to
POST api/v1.0/Friends/UnFriend?contactKey={contactKey}	Removes a Friend Relationship from the Current User.

Messaging

API	Description
GET api/v1.0/Messaging/GetInboxMessages?firstRecord={firstRecord}&maxRecords={maxRecords}	Retrieves all Inbox Messages for the Current User.
GET api/v1.0/Messaging/GetSentMessages?firstRecord={firstRecord}&maxRecords={maxRecords}	Retrieves Mailbox Messages sent by the current user.
POST api/v1.0/Messaging/SendMessageToContact	Sends a new Message to the specified Contact.
POST api/v1.0/Messaging/ReplyToMessage	Submits a reply to a specified Mailbox Message.
POST api/v1.0/Messaging/MarkMessageAsRead?messageKey={messageKey}	Changes the specified Mailbox Message Read Status to True.
GET api/v1.0/Messaging/MarkMessageAsRead?messageKey={messageKey}	Changes the specified Mailbox Message Read Status to True.
POST api/v1.0/Messaging/MarkMessageAsUnRead?messageKey={messageKey}	Changes the specified Mailbox Message Read Status to False.
GET api/v1.0/Messaging/MarkMessageAsUnRead?messageKey={messageKey}	Changes the specified Mailbox Message Read Status to False.
GET api/v1.0/Messaging/GetUnreadMessageCounts	Returns a key-value pair of ContactKey and Unread Message Count. Includes Inbox Messages, Friend Requests and Community Invitations.
POST api/v1.0/Messaging/SendMessageToDiscussionPostAuthor	Sends a private reply to the Author of a DiscussionPost.

RegistrantClass

API	Description
GET api/v1.0/RegistrantClass/GetRegistrantClasses?Active={Active}	Get a list of Registrant Classes
POST api/v1.0/RegistrantClass/MarkRegistrantAttendance?registrantKey={registrantKey}&attended={attended}	No documentation available.

ResourceLibrary

API	Description
GET api/v1.0/ResourceLibrary/GetLibraryList	Returns a list of Libraries that the Current User is Allowed to View/Join.
GET api/v1.0/ResourceLibrary/GetLibraryDocument?documentKey={documentKey}	Returns Document details for the specified DocumentKey.
GET api/v1.0/ResourceLibrary/GetMyLibraryDocuments?maxRecords={maxRecords}	Returns Document Entries created by the Current User.
POST api/v1.0/ResourceLibrary/GetLibraryDocuments	Returns Library Documents according to the optional filter values. Results are returned in Descending Date order.
POST api/v1.0/ResourceLibrary/AddComment?documentKey={documentKey}	Add a new Comment to a Document.
POST api/v1.0/ResourceLibrary/UpdateComment?documentCommentKey={documentCommentKey}	Updates the specified Document Comment with new Comment Text.
DELETE api/v1.0/ResourceLibrary/DeleteComment?documentCommentKey={documentCommentKey}	Deletes the specified Document Comment.
DELETE api/v1.0/ResourceLibrary/DeleteLibraryDocument?documentKey={documentKey}	Deletes the specified Library Document.
POST api/v1.0/ResourceLibrary/AddRelatedLink?documentKey={documentKey}	Adds the specified URL as a RelatedLink to the specified Document.
POST api/v1.0/ResourceLibrary/GetFavorites	Returns a list of Favorited Documents.
POST api/v1.0/ResourceLibrary/AddToFavorites?documentKey={documentKey}	Add the specified Document to the Authenticated User's Favorite List.
DELETE api/v1.0/ResourceLibrary/RemoveFromFavorites?documentKey={documentKey}	Remove the specified Document from the Authenticated User's Favorite List.
DELETE api/v1.0/ResourceLibrary/DeleteRelatedLink?relatedLinkKey={relatedLinkKey}	Deletes the specified RelatedLink.
POST api/v1.0/ResourceLibrary/RecommendDocument?documentKey={documentKey}	Adds a recommendation for the specified Document.
DELETE api/v1.0/ResourceLibrary/DeleteDocumentRecommendation?documentKey={documentKey}	Removes a previously made recommendation.

System

API	Description
GET api/v1.0/System/GetApiDetails	Returns name and parameter type descriptions for the public API endpoints.
GET api/v1.0/System/GetCodeOfConduct	Get the Code of Conduct Details.