Articles in this section

Available Gainsight CC APIs

When you configure an export, import, other type of flow step using the prebuilt Gainsight CC connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Gainsight CC API documentation. You can also create a composite endpoint for this application in HTTP mode.

Gamification, user, and search APIs

Resource

API endpoint

Export

Import

Federated search

Index content for federated search

X

Delete all content from federated search

X

Delete specific URLs from federated search

X

Gamification: Badges

Fetch list of badges

X

Delete a badge

X

Leaderboard

All time leaderboard

X

This week's leaderboard

X

User's position on the leaderboard

X

Points

Assign points

X

Get assigned points

X

Search

Search for content in the community

X

User

Fetches all users

X

Fetch a single user

X

Register a new user

X

Register users in bulk

X

Deletes an existing user

X

Add a role to a user

X

Bulk add roles to users

X

Bulk remove roles from users

X

Bulk award badges to users

X

Bulk revoke badges from users

X

Revoke a custom role from a user

X

Find user by field/value

X

Update a field in user's profile

X

Update a custom field in user's profile

X

Delete a custom field in user's profile

X

Find user by field/value and flag it for logout

X

User: Badges

Award a badge to an user

X

Revoke badge from user

X

Community and event APIs

Resource

API endpoint

Export

Import

Articles

List articles for a category

X

Create an article

X

Publish an article

X

Reply to an article

X

Like an article

X

Unlike an article

X

Edit the opening post content of an article

X

Edit the title of an article

X

Like a reply

X

Unlike a reply

X

Tag an article with moderator tags

X

Tag an article with tags

X

Edit the featured image of an article

X

Edit the public label of an article

X

Toggle the sticky state of an article

X

Open/close an article

X

Trash or restore an article

X

Find article by ID

X

Permanently delete a trashed article

X

Trash/restore a reply

X

Mark replies as highlighted or remove the highlight

X

Promote an existing reply to a new conversation

X

Move an article to a different category

X

Edit a reply

X

Edit the poll title

X

Edit the poll options

X

Show poll results

X

Delete poll attached to an article

X

Add a vote to a poll attached to the given article

X

Move an existing reply to an existing topic

X

Convert an article to a conversation

X

Change the author of an article

X

Approve a reply

X

Report an article reply

X

Resolve reported article reply

X

Set moderation label to article

X

Unset moderation label from article

X

Assign a moderator to article or articles

X

Unassign an article or articles

X

List articles

X

List replies for an article

X

Fetch a reply for an article

X

List of trashed articles

X

List draft articles

X

Categories

List unified content (topics) for a category

X

List categories

X

Find a category by ID

X

Conversations

List conversations for a category

X

Start a conversation

X

Like a conversation

X

Unlike a conversation

X

Edit the opening post content of a conversation

X

Tag a conversation with public tags

X

Reply to a conversation

X

Add a vote to a poll contained in a given conversation

X

Trash or restore a conversation

X

Open/close a conversation

X

Move a conversation to a different category

X

Convert a conversation to a question

X

Convert a conversation to an article

X

Convert a conversation to an idea

X

Copy a conversation to a category

X

Edit the title of a conversation

X

Tag a conversation with moderator tags

X

Toggle the sticky state of a conversation

X

Find conversation by ID

X

Permanently delete a trashed conversation

X

Trash/restore a reply

X

Mark replies as highlighted or remove the highlight

X

Promote an existing reply to a new conversation

X

Move reply to another topic

X

Like a reply

X

Unlike a reply

X

Edit a reply

X

Edit the poll title

X

Edit the poll options

X

Show poll results

X

Delete poll

X

Convert a conversation to a reply

X

Pin a reply

X

Unpin a reply

X

Approve a conversation

X

Approve a reply

X

Report a conversation

X

Report a conversation reply

X

Resolve reported conversation

X

Resolve reported conversation reply

X

Set moderation label to conversation

X

Unset moderation label from conversation

X

Assign a moderator to conversation or conversations

X

Unassign a conversation or conversations

X

List conversations

X

List trashed conversations

X

List replies for a conversation

X

Fetch a single reply for a conversation

X

Event types

Change the name for an event type

X

Delete and event type

X

List event types

X

Create an event type

X

Events

Create an event

X

Create an event as draft

X

Publish an event

X

Trash an event

X

Reschedule an event

X

Sign up to an event

X

Cancel sign up to an event

X

Edit an event title

X

Edit an event URL

X

Edit an event external registration URL

X

Edit an event content

X

Edit an event location

X

Edit an event image

X

Change the confirmation message

X

Update the featured topics lists

X

Change the event type for an event

X

Changes visibility for an event

X

Find event by ID

X

List events

X

Find event attendees by event ID

X

Ideas

Submit an idea

X

Vote an idea

X

Unvote an idea

X

Edit the opening post content of an idea

X

Tag an idea with public tags

X

Reply to an idea

X

Trash or restore an idea

X

Open/close an idea

X

Edit the title of an idea

X

Tag an idea with moderator tags

X

Toggle the sticky state of an idea

X

Find idea by ID

X

Permanently delete a trashed idea

X

Trash/restore a reply

X

Mark replies as highlighted or remove the highlight

X

Promote an existing reply to a new conversation

X

Move reply to another topic

X

Like a reply

X

Unlike a reply

X

Edit a reply

X

Merge votes into another idea

X

Set moderation label to idea

X

Unset moderation label from idea

X

Assign a moderator to an idea or ideas

X

Unassign an idea or ideas

X

Create ideastatus

X

Edit ideastatus

X

Permanently delete an idea status

X

Reorder idea statuses

X

Pin a reply

X

Unpin a reply

X

Assign an idea status to an idea

X

Attach an idea with product areas

X

Change an idea status type

X

Convert an idea to a question

X

Convert an idea to a conversation

X

Approve an idea

X

Approve a reply

X

Report an idea

X

Report an idea reply

X

Resolve reported idea

X

Resolve reported idea reply

X

List ideas

X

List trashed ideas

X

List idea statuses

X

List replies for an idea

X

Fetch a single reply for an idea

X

Moderator tags

Delete moderator tags

X

List moderator tags

X

Product areas

Create product area

X

Rename product area

X

Delete product area

X

Assign product areas to ideas

X

List product areas

X

Product updates

Create a product update

X

Publish a product update

X

Reply to a product update

X

Like a product update

X

Unlike a product update

X

Edit the opening post content of a product update

X

Edit the title of a product update

X

Like a reply

X

Unlike a reply

X

Tag a product update with moderator tags

X

Tag a product update with tags

X

Attach a product update with product areas

X

Edit the featured image of a product update

X

Edit the public label of a product update

X

Toggle the sticky state of a product update

X

Open/close a product update

X

Trash or restore a product update

X

Find product update by ID

X

Permanently delete a trashed product update

X

Trash/restore a reply

X

Mark replies as highlighted or remove the highlight

X

Promote an existing reply to a new conversation

X

Edit a reply

X

Edit the poll title

X

Edit the poll options

X

Show poll results

X

Delete poll attached to a product update

X

Add a vote to a poll attached to the given product update

X

Move an existing reply to an existing topic

X

Change the author of a product update

X

Approve a reply

X

Report a product update reply

X

Resolve reported product update reply

X

Set moderation label to product update

X

Unset moderation label from product update

X

Assign a moderator to productupdate or productupdates

X

Unassign a product update or product updates

X

List product updates

X

List replies for a product update

X

Fetch a reply for a product update

X

List of trashed product updates

X

List draft product updates

X

Public tags

Create public tag

X

Rename public tag

X

Delete public tag

X

Merge public tags

X

List public tags

X

Questions

List questions for a category

X

Ask a question

X

Tag a question with public tags

X

Reply to a question

X

Add a vote to a poll contained in a given question

X

Like a question

X

Unlike a question

X

Mark a reply to a question as the answer

X

Remove an answer from a question

X

Mark replies as highlighted or remove the highlight

X

Promote an existing reply to a new conversation

X

Trash or restore a question

X

Open/close a question

X

Convert a question to a conversation

X

Convert a question to an idea

X

Move a question to a different category

X

Edit the title of a question

X

Tag a question with moderator tags

X

Edit the opening post content of a question

X

Toggle the sticky state of a question

X

Move an existing reply to an existing topic

X

Trash/restore a reply

X

Find question by ID

X

Permanently delete a trashed question

X

Edit a reply

X

Like a reply

X

Unlike a reply

X

Edit the poll title

X

Edit the poll options

X

Show poll results

X

Delete poll attached to a question

X

Convert a question to a reply

X

Approve a question

X

Approve a reply

X

Report a question

X

Report a question reply

X

Resolve reported question

X

Resolve reported question reply

X

Set moderation label to question

X

Unset moderation label from question

X

Assign a moderator to question or questions

X

Unassign a question or questions

X

List replies for a question

X

Fetch a single reply for a question

X

List questions

X

List trashed questions

X

Unified content (topics)

List unified content (topics)

X

Search by term across unified content

X

Webhooks

Subscribe URL to webhook event

X

Unsubscribe URL from webhook event

X

Unsubscribe all URLs from webhook event

X

List of events webhook subscriptions for a given event

X