Higher Logic API v2.0

Returns a list of Announcements given the specified criteria.

Returns the details of the specified Announcement.

Acts as a toggle for recommending an answer. A POST request will recommend while DELETE will remove the recommendation. An answer recommendation refers to the answer being "Helpful" in a Q and A thread.

Acts as a toggle for recommending an answer. A POST request will recommend while DELETE will remove the recommendation. An answer recommendation refers to the answer being "Helpful" in a Q and A thread.

Returns the details of the specified Answer.

Administrator-only endpoint to delete the specified answer.

Edit an existing answer

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

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

Used to Authenticate to the Widgets Platform

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

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

Returns a page of the requested Contact Data fields.

Returns a list of field names that can be requested via the GetContactData() Endpoint.

Returns the requested subset of Contact Data.

Retrieves the Blog Entries that meet the filter conditions.

Retrieves Blog Entries by the specified GroupingType.

Create a new Blog.

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

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

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

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

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.

Adds a recommendation for the specified Blog.

Removes a previously made recommendation.

Deletes a Blog.

Add a new Comment to a Blog.

Updates the specified Blog Comment with new Comment Text.

Deletes the specified RelatedLink.

Deletes the specified Blog Comment.

This will return a collection of comments for a particular item on the site. The content types that can have comments associated to it are Blogs, Documents, and Events

Returns the details of the specified Comment.

This will retrieve a paginated set of comments based on the commentKey provided. Using the afterCommentKey is recommended when continuing the default order of comments provided by the Get endpoint or other various endpoints. Either the afterCommentKey or the beforeCommentKey must be provided. If both keys are put in the request, the afterAnswerKey will take precedence.

Given the unique identifier of a specific community, this make sure that the current user can view the community, and return information pertaining to that community.

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

Returns a list of the specified User's joined Communities that the current user can view. If both a ContactKey and LegacyContactKey are specified, the ContactKey will be used. If neither parameter is specified, an error will be returned.

Returns a list of Communities the Current User can see.

Returns a list of Communities the Current User is not a member of, but is eligible to join.

Retrieve all Community Invitations.

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

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

Joins the current user to the Community identified by the specified Community Key.

Accept an invitation to a Community.

Reject an Invite to a Community.

Removes the Current Contact from the specified Community.

Returns information about the Currently Authenticated User.

Returns information about the Currently Authenticated User.

Returns Contact information for the specified contactKey.

Returns Contact information for the specified legacyContactKey.

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

If no afterContactKey or beforeContactKey is provided, then this endpoint will return the first specified set of contacts based on the limit provided. Ordered by LastName, FirstName. To continue a list, using the afterContactKey is recommended to continue to the next page. Using the beforeContactKey will return you the set of contacts in LastName, FirstName order that are prior to the contactKey provided. If both afterContactKey and beforeContactKey are provided, afterContactKey will take precedence.

Provides Contact search results to be used for adding @Mention functionality to Content.

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

Responds with the Currently Authenticated User's Global Email Opt-in/out settings.

Change Global Email preferences for 1 or more Contacts. * For use by Administrators only *. Individual users can updated their own Email Preferences via the "UpdateMyEmailPreferences" endpoint.

Accepts a Multipart MIME file via a POST Request. Uploads a profile image for the supplied user. * For use by Administrators only *.

Accepts a Multipart MIME file via a POST Request. Uploads a profile image for the Currently Authenticated User.

Change Global Email preferences for the Currently Authenticated User.

Stores the Current Date as the Acceptance Date.

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.

Returns Contact data for all Contact Records that match the specified criteria that the authenticated user has permissions to message. Searches: City, State/Province, Company Name, Company Title, First Name, Last Name, and Middle Name.

Returns Contact data for all Contact Records that with the given demographic

Returns a list of published items a given Contact has authored. The list includes Announcements, Blogs, Discussion Messages, Library Entries, Questions, and Answers.

Returns a list of all items the authenticated user has authored. The list includes Announcements, Blogs, Discussion Messages, Library Entries, Questions, and Answers.

This returns a feed of content published on the site based on the request parameters provided. This endpoint provides content/items in a generic pattern, so that users can display the items in the response as a feed of information pulling from the website. The feed can provide you with several different types of content, which you can filter down to using the request to fit your needs. This endpoint is relatively complex in terms of its capabilities in the request and response.

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

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

Returns a collection of all existing demographic categories

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

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

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

Get the available Demographic Types.

Get the available Demographic choices.

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

Get all demographic types that are visible on the main microsite profile

Edit a current DiscussionPost

Get the Discussion by its Unique Key.

Get a DiscussionPost by its Unique Key.

Retrieves details about all threads that have been updated since a specified date. Accessible only by Admin users.

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

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

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

Returns a list of Discussion Posts for the Current User.

Returns all Discussion Posts for the specified Discussion Thread.

This returns information for a specified discussion post, as well as information about its context within the thread. Returning both parent hierarchical information as well as direct children discussion posts.

Administrator access only. Returns a list of field names that can be requested via the GetPagedDiscussionPosts() Endpoint.

Administrator-only endpoint. Provides a customizable and paged list of Discussion Post Properties. The paging mechanism is a 'continuationToken' that is comprised of a DateTime and DiscussionPostId that informs the query engine which DiscussionPost was last retrieved. The Response will include a standard 'Link' Header that will include rel="next" to denote the Uri to be utilized for the next page in the sequence. Paging relies on the continuationToken property to determine the next set of requested DiscussionPosts, as page size may vary depending upon the "maxRecords" value requested by the client.

No documentation available.

Submit a new DiscussionPost to a Discussion.

Update Discussion Subscription.

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.

Returns a specified number of messages using the afterReplyDiscussionPostKey or beforeReplyDiscussionPostKey as a starting point. If both keys are put in the request, the afterReplyDiscussionPostKey will take precedence.

POST request follows the specified discussion thread - DELETE removes the follow.

POST request follows the specified discussion thread - DELETE removes the follow.

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

No documentation available.

No documentation available.

Post a Message to the specified Discussion.

Post a reply to the specified Discussion Post.

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

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

Returns Discussion Post information that meet the search criteria.

Adds a recommendation for the specified Discussion Post.

Marks the specified Discussion Post as the best answer. Will replace any previously set best answer for the thread. Can only be called by the creator of the thread, or a site or community admin.

Deletes the specified discussion post. If a message has replies, the body will be updated to: "This post was removed" and the message will be anonymized to preserve the thread structure. All documents attached to the message will be deleted. Only administrators can remove/delete messages.

Removes a previously made recommendation.

Get the tags for a thread by discussion thread key

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.

Administrator-accessible only endpoint. Returns Registrant Data for a given Calendar Event and optionally a modified datetime can be passed in to only get updated registrants.

Administrator-accessible only endpoint. Returns Paged Registrant Data for a given Calendar Event.

Returns an Event Type

Returns all Event Types

Get a list of active event types

Saves an Event Type

Deletes an Event Type

Restores a Deleted Event Type

Retrieve details about a single Event.

Returns all Current (beginning today) and Future Events.

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

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

Returns all events that count toward attendance tracking for the given community.

Returns all recent events that the contact has attended.

Returns a list of contacts that participated in the last x community events. The event has to be in the 'done state' to count as a recent meeting.

Returns a list of contacts that participated in the indicated event. The event has to be in the 'done state' to count as a recent meeting.

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

RSVPs the current user to the designated event. For events with a registration type of RSVP only, not valid for other registrations. Registering for a parent repeating event also registers you for all following occurrences.

Removes the current user's RSVP to the designated event. For events with a registration type of RSVP only, not valid for other registrations. Removing RSVP for a parent repeating event also removes registration for all following occurrences.

No documentation available.

Create a new ExternalActivity record.

Add External Announcement Items to the Search Results.

Add External Library Items to the Search Results.

Add External Library Items to the Search Results.

Add External Communities to the Search Results.

Add External Courses/Webinars to the Search Results.

Add External Blog Items to the Search Results.

Add External Calendar Event Items to the Search Results.

Add External Navigation Items to the Search Results.

Add External Volunteer Opportunity Items to the Search Results.

Add External Glossary Items to the Search Results.

No documentation available.

No documentation available.

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

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

Gets a List of FriendModel objects representing the Friend Requests that the Current User has SENT which have been accepted.

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

Accepts a Friend Request.

Rejects a Friend Request.

Cancels a Friend Request. Using the current contact and the contactKey of the person the request was sent to

Removes a Friend Relationship from the Current User.

Gets the details of an idea.

Create a new idea.

Returns a specified number of ideas in a particular status, optionally using the afterIdeaKey or beforeIdeaKey as a starting point. Ideas are ordered by creation date, most recent to least recent. If both keys are included, afterIdeaKey will take precedence.

Returns a specified number of ideas in a particular category, optionally using the afterIdeaKey or beforeIdeaKey as a starting point. Ideas are ordered by creation date, most recent to least recent. If both keys are included, afterIdeaKey will take precedence.

Add categories to an idea.

Get active statuses that can be applied to an idea.

Get active categories that an idea can be associated to.

Update the status of an idea.

Retrieves the specified Mailbox Message

Retrieves the most recent Inbox Messages for the Current User.

Retrieves the most recent Mailbox Messages sent by the current user.

Sends a new Message to the specified Contact.

Submits a new reply to a specified Mailbox Message to the original message's author.

Changes the specified Mailbox Message Read Status to True.

Changes the specified Mailbox Message Read Status to True.

Marks the specified Mailbox Messages as 'Read'.

Deletes Mailbox Messages from the Authenticated User's Inbox.

Changes the specified Mailbox Message Read Status to False.

Changes the specified Mailbox Message Read Status to False.

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

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

Records page visit data for the current page. Called back from the web if PageVisits are being recorded..

Submit a new question

Submit a new answer

Get a question thread, including the root question and it's first 10 associated answers.

Acts as a toggle for recommending a question. A POST request will recommend while DELETE will remove the recommendation. A question recommendation refers to "I have this question too" listed under a question in a Q&A thread.

Acts as a toggle for recommending a question. A POST request will recommend while DELETE will remove the recommendation. A question recommendation refers to "I have this question too" listed under a question in a Q&A thread.

POST request follows the specified question - DELETE removes the follow.

POST request follows the specified question - DELETE removes the follow.

Returns a specified number of answers using the afterAnswerKey or beforeAnswerKey as a starting point. If both keys are put in the request, the afterAnswerKey will take precedence.

Administrator-only endpoint to delete the specified question. All answers associated with the question must be deleted prior to the deletion of the question.

Edit an existing question

Get a list of Registrant Classes

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

Returns a list of libraries that the Current user is allowed to view/join. This will return a truncated version of the library data.

Returns Document details for the specified DocumentKey.

Acts as a toggle for following a resource library entry. A POST request will follow while DELETE will remove the follow.

Acts as a toggle for following a resource library entry. A POST request will follow while DELETE will remove the follow.

Returns Document Entries created by the Current User.

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

Returns Document Attachment Details for the specified Document.

Add a new Comment to a Document.

Updates the specified Document Comment with new Comment Text.

Deletes the specified Document Comment.

Deletes the specified Library Document.

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

Returns a list of Favorited Documents.

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

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

Deletes the specified RelatedLink.

Adds a recommendation for the specified Document.

Removes a previously made recommendation.

Returns Document Attachment Details for the specified Document Attachment.

Removes the specified document attachment from the parent document.

Creates a document and its attachments in the specified library. Accepts Multipart MIME files via a POST Request. Files must be smaller than 2 GB. In the form data you must include a DocumentName. If posting to a library associated with a topic community, TopicTagKeys must included at least one valid key. You may also include a Description for the document. The name field of each file will override the file name.

Accepts Multipart MIME files via a POST Request.

Initiate a file upload for use in associating files to resource library entries. A small file (<= 5MiB) can be uploaded with a single PUT request using the upload URL contained in the response. Files larger than this threshold must be partitioned into smaller parts/chunks and those chunks uploaded individually via PUT requests with the upload URLs contained in the response.

Complete a multipart upload once all parts have been uploaded. Reconstitutes the file from the uploaded parts in the file repository.

Abort an in-process multipart upload.

Using the ObjectKey returned when initiated the upload, creates a resource library entry once the file upload is complete and has been reconstituted (if necessary).

Appends one or more document attachments to an existing resource library entry using a previously uploaded file. Uses the ObjectKey returned when the upload was initiated once the file upload is complete and has been reconstituted (if necessary). Only valid on Documents (library entries) with a standard, copyright, or attachment entry type.

Edits the metadata of an existing/published library entry.

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

Get the Code of Conduct Details.

Using a Tenant's main microsite, this endpoint will grab Urls that allow a user to navigate to various important sections of their profile

Get the mobile app settings configured by a tenant's administrator. If not set, values default to those of the main microsite.

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

Returns a set of currently existing tags that have been used throughout the tenant in the past based on the search term provided. This endpoint will provide the tags within their tag groups, as well as metadata about each tag. This will also include the markup necessary to include in the body of content created via the api to properly associate the tags to the content. Important Note: Some tags are reserved for admin use only, and there is a property on each tag that specifies if the current user can use the tag or not in content.

Allows Administrators to automatically approve a Volunteer Application by the ContactKey of the Volunteer Applicant and the VolunteerOpportunityKey.

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

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

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

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

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

Volunteer for a specific Volunteer Opportunity.

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

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).

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.

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.

Returns a list of active Volunteer Opportunities in the system.

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.

Returns Upcoming VolunteerOpportunies for Current User.

Returns a list of Volunteer Opportunity Types.