Script APIs

Server-side APIs available from automations, widgets, and themes through Velocity and server-side JavaScript.

Script API	Description
Activity Stream
core_v2_activityStory	Enables scripted content fragments to use Activity Stories
core_v2_activityStorySitePreference	Enables scripted content fragments to use Activity Story Site Preferences
core_v2_activityStoryUserPreference	Enables scripted content fragments to use Activity Story User Preferences
core_v2_statusMessage	Enables scripted content fragments to use StatusMessages
Articles
articles_v1_articleCategories	Exposes the article category api to widgets,themes and automation.
articles_v1_articleCollections	Exposes the article collection api to widgets,themes and automation.
articles_v1_articles	Exposes the articles api to widgets,themes and automation.
articles_v1_articleTypes	Exposes the article types api to widgets,themes and automation.
articles_v1_articleUrls	Exposes the article urls api to widgets, themes and automation.
articles_v1_articleVersionCategories	Exposes the article version category api to widgets,themes and automation.
articles_v1_articleVersions	Exposes the article history api to widgets,themes and automation.
articles_v1_categories	Exposes the article category api to widgets,themes and automation.
articles_v1_helpfulness	Exposes the article helpfulness api to widgets, themes and automation.
articles_v1_helpfulnessResponseTypes	Exposes the article helpfulness response options api to widgets, themes and automation.
articles_v1_permissions	Exposes the article permissions to widgets, themes and automations.
articles_v1_publishGroups	Exposes the article publish group api to widgets, themes and automation.
articles_v1_subscriptionTypes	Exposes the article subscription types to widgets, themes and automations.
Automation
context_v2_automationState	This extension is only available when rendering the implementation of an automation. It is not generally available for use by widgets, embeddables, or themes.
context_v2_automationTrigger	This extension is only available when rendering the implementation of an automation. It is not generally available for use by widgets, embeddables, or themes.
core_v2_automation	Enables scripted content fragments to interact with automations.
Blogs
core_v2_blog	Enables scripted content fragments to use Blogs
core_v2_blogConfiguration	Enables scripted content fragments to obtain site level blog configuration values.
core_v2_blogPermissions	Enables scripted content fragments to use blog permission identifiers.
core_v2_blogPost	Enables scripted content fragments to use BlogPosts
core_v2_blogPostSummary	Enables scripted content fragments to use BlogPostSummaries
core_v2_blogUrls	Enables scripted content fragments to render links to blog-related URLs.
Calendar
calendar_v1_calendars	Enables Scripted Content Fragments to use Calendars
calendar_v1_events	Calendar Event Utility methods for scripted widgets
calendar_v1_permissions	Enables Scripted Content Fragments to use calendar permission identifiers
calendar_v1_registrations	Calendar Event Registration Utility methods for scripted widgets
calendar_v1_resources	Enables Scripted Content Fragments to use Calendars Resources
calendar_v1_UI	Calendar Utility methods for scripted widgets
calendar_v1_urls	Enables Scripted Content Fragments to use Calendars Urls
Configuration
context_v2_propertyRule	This extension is only available when rendering a macro as a custom property rule for a configuration property. It is not generally available for use by widgets, embeddables, or automations.
context_v2_propertyTemplate	This extension is only available when rendering a macro as a custom property template for a configuration property. It is not generally available for use by widgets, embeddables, or automations.
Content Moderation
core_v2_abuseAppeal	Enables scripted content fragments to use AbuseAppeals
core_v2_abuseReport	Enables scripted content fragments to use AbuseReports
core_v2_abusiveContent	Enables scripted content fragments to use AbusiveContent
core_v2_reviewableContent	Enables scripted content fragments to interact with reviewable content.
Conversations
core_v2_conversation	Enables scripted content fragments to use Conversations
core_v2_conversationMessage	Enables scripted content fragments to use ConversationMessages
core_v2_replyMessage Obsolete	Enables scripted content fragments to use ReplyMessages
Conversion
core_v2_captureThreadToArticle	Enables forum threads to be captured to articles.
Email
context_v1_email	This extension is only available when rendering the implementation of an email. It is not generally available for use by widgets, themes, or automations.
context_v1_emailTemplate	This extension is only available when rendering the implementation of an email. It is not generally available for use by widgets, themes, or automations.
Embeddable
context_v2_embeddable	This extension is only available when rendering the implementation of an embeddable. It is not generally available for use by widgets, themes, or automations.
Forums
core_v2_forum	Enables scripted content fragments to use Forums
core_v2_forumConfiguration	Enables scripted content fragments to obtain site level forum configuration values.
core_v2_forumPermissions	Enables scripted content fragments to obtain forum permission identifiers.
core_v2_forumReply	Enables scripted content fragments to use ForumReplys
core_v2_forumReplyVote	Enables scripted content fragments to use Forum Reply Shares
core_v2_forumThread	Enables scripted content fragments to use ForumThreads
core_v2_forumThreadVote	Enables scripted content fragments to use Forum Thread Votes
core_v2_forumUrls	Enables scripted content fragments to render links to forum-related URLs.
Geocoding
geocoding_v1_core	Exposes geocoding functionality to scritped widgets(geocoding_v1_core)
Groups
core_v2_emailDigest	Enables scripted content fragments to use email digest
core_v2_group	Enables scripted content fragments to use Groups
core_v2_groupAvatar	Enables scripted content fragments to use group avatars
core_v2_groupContactRequest	Enables scripted content fragments to access Group Contact Requests
core_v2_groupPermissions	Enables scripted content fragments to use group permission identifiers.
core_v2_groupRoleMember	Enables scripted content fragments to use group members
core_v2_groupUrls	Enables scripted content fragments to render links to group-related URLs.
core_v2_groupUserMember	Enables scripted content fragments to use group members
Ideas
telligentIdeas_v1_challenges	Enables scripted content fragments to use Ideations
telligentIdeas_v1_ideaCategories	Exposes Idea Categories to widgets
telligentIdeas_v1_ideaPermissions	Enables scripted content fragments to use Ideas
telligentIdeas_v1_ideas	Enables scripted content fragments to use Ideas
telligentIdeas_v1_ideaStatuses	Exposes Idea Status Changes to widgets
telligentIdeas_v1_statuses	Enables scripted content fragments to use Idea Statuses
telligentIdeas_v1_urls	Enables scripted content fragments to use Idea Urls
telligentIdeas_v1_userVoteSummaries	Enables scripted content fragments to use user vote summaries.
telligentIdeas_v1_votes	Enables scripted content fragments to use Idea Votes
MediaGalleries
core_v2_gallery	Enables scripted content fragments to use Galleries
core_v2_media	Enables scripted content fragments to use Media
core_v2_mediaConfiguration	Enables scripted content fragments to obtain site level media configuration values.
core_v2_mediaPermissions	Enables scripted content fragments to obtain media gallery permission identifiers.
core_v2_mediaUrls	Enables scripted content fragments to render links to media-related URLs.
Recommendations
core_v2_contentRecommendation	Enables scripted content fragments to use content recommendations
core_v2_userRecommendation	Enables scripted content fragments to use user recommendations
Scoring
core_v2_authorQualityScore	Enables scripted content fragments to use Author Quality Scores
core_v2_contentQualityScore	Enables scripted content fragments to use Content Quality Scores
core_v2_groupAuthorQualityScore	Enables scripted content fragments to use Group Author Quality Scores
core_v2_leader	Enables scripted content fragments to use Leaders
core_v2_leaderboard	Enables scripted content fragments to use Leaderboards
core_v2_leaderboardUrls	Enables scripted content fragments to use LeaderboardUrls
core_v2_pointTransaction	Enables scripted content fragments to use PointTransactions
Search
core_v2_search	Enables scripted content fragments to retrieve search specific properties.
core_v2_searchCategory	Enables scripted content fragments to use Search Categories
core_v2_searchResult	Enables scripted content fragments to use Search
Services
core_v2_application	Enables scripted content fragments to use applications
core_v2_applicationMerge	Enables scripted content fragments to use the application merger
core_v2_applicationSubscription	Enables scripted content fragments to use application subscriptions
core_v2_bookmark	Enables scripted content fragments to use bookmarks
core_v2_calculatedScores	Enables scripted content fragments to get calculated scores.
core_v2_comments	Enables scripted content fragments to use Comments
core_v2_commentSummary
core_v2_commentVotes
core_v2_container	Enables scripted content fragments to use containers
core_v2_containerType	Enables scripted content fragments to use container types
core_v2_content	Enables scripted content fragments to use content
core_v2_contentConversion	Enables scripted content fragments to use content conversion
core_v2_contentPresence	Enables scripted content fragments to use presence
core_v2_contentSubscribers	Enables scripted content fragments to list content subscribers
core_v2_contentSubscription	Enables scripted content fragments to use content subscriptions
core_v2_contentType	Enables scripted content fragments to use content types
core_v2_contentViews	Enables scripted content fragments to use Content Views
core_v2_feature Obsolete	Enables scripted content fragments to use Features
core_v2_hashTag	Enables scripted content fragments to retrieve hash tags
core_v2_like	Enables scripted content fragments to use likes
core_v2_likedItem	Enables scripted content fragments to use liked items
core_v2_mention	Enables scripted content fragments to use mentions
core_v2_mentionable	Enables scripted content fragments to use mentionables
core_v2_notification	Enables scripted content fragments to use Notifications
core_v2_notificationCategory	Enables scripted content fragments to use notification categories.
core_v2_notificationDistributionType	Enables scripted content fragments to use Notification Distribution Types
core_v2_notificationType	Enables scripted content fragments to use Notification Types
core_v2_notificationUserPreference	Enables scripted content fragments to use Notification User Preferences
core_v2_ratedItem	Enables scripted content fragments to use rated items
core_v2_rating	Enables scripted content fragments to use ratings
core_v2_servicePresence	Enables scripted content fragments to use service presence
core_v2_systemNotification	Enables scripted content fragments to send system notifications
core_v2_taggedContent	Enables scripted content fragments to get tagged content.
core_v2_tags	Enables scripted content fragments to get tags.
core_v3_feature	Enables scripted content fragments to use Features
core_v3_permission	Enables scripted content fragments to use Permissions
Sitewide
core_v2_achievement	Enables scripted content fragments to use achievements
core_v2_achievementSummary	Enables scripted content fragments to use achievements
core_v2_apiKey	Enables scripted content fragments to use API keys
core_v2_applicationType	Enables scripted content fragments to use application types
core_v2_authentication	Enables scripted content fragments to perform authorization tasks and retrieve OAuth data.
core_v2_configuration	Enables scripted content fragments to read site configuration properties.
core_v2_customPage	Enables scripted content fragments to get custom page information.
core_v2_infoResult	Enables scripted content fragments to use Site Info
core_v2_message	Enables scripted content fragments to get message information.
core_v2_oauthClient	Enables scripted content fragments to use OAuth clients
core_v2_rssFeedItem	Enables scripted content fragments to load RSS Feed Items
core_v2_sitePermissions	Enables scripted content fragments to use site permission identifiers.
core_v2_urls	Enables scripted content fragments to render links to platform related URLs.
core_v2_userAchievement	Enables scripted content fragments to use user achievements
Theme
context_v2_themeBody	This extension is only available when rendering the body of a theme. Is is not generally available for use by widgets, embeddables, or automations.
context_v2_themeHeader	This extension is only available when rendering the header of a theme. Is is not generally available for use by widgets, embeddables, or automations.
UI
core_v2_customNavigation	Enables scripted content fragments to render custom navigation data.
core_v2_dynamicForm	Enables scripted content fragments to render and interact with the configured content editor.
core_v2_editableGroup	Enables scripted content fragments to be edited in groups.
core_v2_editor	Enables scripted content fragments to render and interact with the configured content editor.
core_v2_emoticon	Enables scripted content fragments to use Emoticons
core_v2_poll	Enables widgets to use Polls
core_v2_submittableEditor	Enables scripted content fragments to render and interact with a content editor supporting immediate submission.
core_v2_tourTip	Enables scripted content fragments to use Tour Tips
core_v2_ui	Enables scripted content fragments to render standardized UI elements.
Users
core_v2_follower	Enables scripted content fragments to use Followers
core_v2_following	Enables scripted content fragments to use Followings
core_v2_friendship	Enables scripted content fragments to use Friendships
core_v2_ldapGroups	Enables scripted content fragments to access LDAP Groups
core_v2_ldapUsers	Enables scripted content fragments to access LDAP Users
core_v2_nodePermission Obsolete	Enables scripted content fragments to use NodePermissions
core_v2_permission	Enables scripted content fragments to use Permissions
core_v2_rank Obsolete	Enables scripted content fragments to use Ranks
core_v2_role	Enables scripted content fragments to use Roless
core_v2_roleUsers	Enables scripted content fragments to use Roles Users
core_v2_user	Enables scripted content fragments to use Users
core_v2_userAvatar	Enables scripted content fragments to use user avatars
core_v2_userFile	Enables scripted content fragments to get user file information.
core_v2_userFolder	Enables scripted content fragments to get user folder information.
core_v2_userInvitation	Enables scripted content fragments to get user invitation information.
core_v2_userPermission	Enables scripted content fragments to check Permissions
core_v2_userPresence Obsolete	Enables scripted content fragments to use UserPresences
core_v2_userProfileField	Enables scripted content fragments to use User Profile Fields
core_v2_userProfileFieldGroup	Enables scripted content fragments to use User Profile Field Groups
core_v2_userValidation	Enables scripted content fragments to use UserValidations
core_v2_webhook	Enables scripted content fragments to use Webhook information
core_v2_webhookEvent	Enables scripted content fragments to use Webhook information
Utilities
context_v2_scheduledFile	This extension is only available when executing files scheduled with core_v2_widget.ScheduleFile() when the ProgressKey parameter is set. It is not generally available for use by widgets, automations, embeddables, or themes.
core_v2_cfs	Enables scripted content fragments to use Cfs
core_v2_email	Enables scripted content fragments to send email messages.
core_v2_encoding	Enables scripted content fragments to encode data for rendering.
core_v2_eventLog	Enables scripted content fragments to use EventLogs
core_v2_exceptionCategories	Enables scripted content fragments to identify exception categories when logging exceptions.
core_v2_exceptions	Enables scripted content fragments to log exceptions.
core_v2_http	Enables scripted content fragments to make HTTP requests.
core_v2_language	Enables scripted content fragments to retrieve localized text and format data.
core_v2_moderationTemplates	Enables scripted content fragments to retrieve moderation templates.
core_v2_page	Enables scripted content fragments to get page information and set the page title.
core_v2_process	Enables scripted content fragments to interact with the current execution process.
core_v2_theme	Enables scripted content fragments to get contextual and configuration data related to the theme.
core_v2_themeFooter	Enables scripted content fragments to interact with theme footers.
core_v2_themeHeader	Enables scripted content fragments to interact with theme headers.
core_v2_themePage	Enables scripted content fragments to interact with theme Pages.
core_v2_uploadedFile	Enables scripted content fragments to upload and retrieve temporary files.
core_v2_utility	Enables scripted content fragments to have access to useful utility methods
core_v2_widget	Enables scripted content fragments to get contextual and configuration data related to the current widget / content fragment.
Wikis
core_v2_wiki	Enables scripted content fragments to use Wikis
core_v2_wikiConfiguration	Enables scripted content fragments to obtain site level wiki configuration values.
core_v2_wikiFiles	Enables scripted content fragments to used embedded files in Wiki Posts
core_v2_wikiPage	Enables scripted content fragments to use WikiPages
core_v2_wikiPageCommentSubscriptions	Enables scripted content fragments to use WikiPageCommentSubscriptions
core_v2_wikiPageRevision	Enables scripted content fragments to use Wiki page revisions
core_v2_wikiPermissions	Enables scripted content fragments to obtain wiki permission identifiers.
core_v2_wikiToc	Enables scripted content fragments to use WikiTocs
core_v2_wikiUrls	Enables scripted content fragments to render links to Wiki-related URLs.

Recommended