Showpad Channels API
The channels API from Showpad — 22 operation(s) for channels.
Operations 29
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which channels exist in our Showpad content library?”
“Can I list only hidden channels, or include template channels in the results?”
Tell an agent
List all channels.
List channels named {name}.
Ask an LLM
“How do I create a new channel for my sales team's content?”
“Can a newly created channel start out hidden from users?”
Tell an agent
Create a channel called {name}.
Create a channel named {name} with hidden set to {isHidden} and description {description}.
Ask an LLM
“How many channels do we have in total?”
“What's the number of personal channels versus shared ones?”
Tell an agent
Count all channels.
Count the channels with personal set to {isPersonal}.
Ask an LLM
“What fields does a channel object have and which calls apply to it?”
“Where can I see the schema and available API calls for channels?”
Tell an agent
Describe the channel model and its available API calls.
Show me the property definitions for the channel resource.
GET
/channels/experience-types.json
List installed experience types · /channels/experience-types.json
#
Ask an LLM
“Which experience types are installed in our Showpad instance?”
“What kinds of experiences can I build channels from?”
Tell an agent
List the installed experience types.
Show every experience type available for channels.
GET
/channels/experience-types/{experienceTypeId}/modules/{moduleName}
Get an experience type module's info · /channels/experience-types/{experienceTypeId}/modules/{moduleName}
#
Ask an LLM
“How do I look up the details of a specific module inside an experience type?”
“What information is exposed about an experience type's module?”
Tell an agent
Get the info for module {moduleName} of experience type {experienceTypeId}.
Show how the {moduleName} module is configured in experience type {experienceTypeId}.
Ask an LLM
“Can I get a summary of all experiences in one division?”
“What does the channel overview show for a given division?”
Tell an agent
Get the channel overview for division {divisionId}.
Show me an overview of the experiences in division {divisionId}.
GET
/channels/{id1}/usergroups/{id2}.json
Link or unlink a channel and group via GET · /channels/{id1}/usergroups/{id2}.json
#
Ask an LLM
“Is there a GET-based way to link or unlink a channel and a user group for clients that can't send POST?”
“Can I toggle a channel's user group assignment using the method override parameter?”
Tell an agent
Use method {method} to change the link between channel {id1} and user group {id2}.
Via the GET override, apply {method} to channel {id1} and group {id2}.
POST
/channels/{id1}/usergroups/{id2}/link.json
Grant a user group access to a channel · /channels/{id1}/usergroups/{id2}/link.json
#
Ask an LLM
“How do I give a user group access to a specific channel?”
“Can I assign an existing group to a channel by their IDs?”
Tell an agent
Link channel {id1} to user group {id2}.
Give user group {id2} access to channel {id1}.
POST
/channels/{id1}/usergroups/{id2}/unlink.json
Remove a user group from a channel · /channels/{id1}/usergroups/{id2}/unlink.json
#
Ask an LLM
“How do I take a user group's access away from a channel?”
“Can I detach a group from a channel without deleting the group?”
Tell an agent
Unlink user group {id2} from channel {id1}.
Remove group {id2}'s access to channel {id1}.
GET
/channels/{id1}/users/{id2}.json
Link or unlink a channel and user via GET · /channels/{id1}/users/{id2}.json
#
Ask an LLM
“Is there a GET-based override for linking or unlinking a single user and a channel?”
“Can I change one user's channel assignment with the method query parameter?”
Tell an agent
For individual user {id2}, send method {method} on the channel {id1} membership endpoint.
Through GET with method {method}, add or remove person {id2} on channel {id1}.
POST
/channels/{id1}/users/{id2}/link.json
Grant a user access to a channel · /channels/{id1}/users/{id2}/link.json
#
Ask an LLM
“How do I add an existing user directly to a channel?”
“Can I assign one person to a channel without putting them in a group?”
Tell an agent
Link channel {id1} to user {id2}.
Give user {id2} direct access to channel {id1}.
POST
/channels/{id1}/users/{id2}/unlink.json
Remove a user from a channel · /channels/{id1}/users/{id2}/unlink.json
#
Ask an LLM
“How do I remove a single user's direct access to a channel?”
“Can I unassign someone from a channel while keeping their account?”
Tell an agent
Unlink user {id2} from channel {id1}.
Take user {id2} off channel {id1}.
Ask an LLM
“How do I fetch the details of one channel by its ID?”
“What settings does a single channel have, like its view mode or hidden flag?”
Tell an agent
Get channel {id}.
Show me the details of channel {id}.
Ask an LLM
“How do I rename a channel or change its description with a PUT request?”
“Can I update a channel's cover focal point with PUT?”
Tell an agent
PUT an update renaming channel {id} to {name}.
Using PUT, set the default view mode of channel {id} to {defaultViewMode}.
Ask an LLM
“Can I update a channel with POST instead of PUT?”
“Is there a POST variant for hiding a channel or editing its details?”
Tell an agent
Via POST, set hidden to {isHidden} on channel {id}.
Using the POST update, change channel {id}'s description to {description}.
Ask an LLM
“How do I permanently delete a channel?”
“What happens when I remove a channel I no longer need?”
Tell an agent destructive · confirm first
Delete channel {id}.
Remove channel {id} from Showpad.
Ask an LLM
“Which assets are published in a particular channel?”
“Can I see only the downloadable files inside one channel?”
Tell an agent
List the assets in channel {id}.
Show the {filetype} files in channel {id}.
Ask an LLM
“How do I see the structure of sections and pages inside a channel?”
“Can I get the child nodes under a specific parent node in a channel?”
Tell an agent
List the channel nodes of channel {id}.
Show the nodes under parent node {parentNodeId} in channel {id}.
Ask an LLM
“How do I copy an existing channel to reuse its setup?”
“Can I add myself to the duplicated channel automatically?”
Tell an agent
Duplicate channel {id} into {targetResource}.
Copy channel {id} to {targetResource} and add me with {addCurrentUser}.
Ask an LLM
“How do I attach related resources to a channel using a Link list?”
“Can I connect several resources to one channel in a single call?”
Tell an agent
Link the resources {Link} to channel {id}.
Attach {Link} to channel {id} as related resources.
GET
/channels/{id}/tag-categories.json
Get an experience's tag categories · /channels/{id}/tag-categories.json
#
Ask an LLM
“Which tag categories are assigned to a given experience?”
“How do I check the tag category setup of a channel?”
Tell an agent
Get the tag categories for experience {id}.
Show which tag categories channel {id} uses.
POST
/channels/{id}/tag-categories.json
Set an experience's tag categories · /channels/{id}/tag-categories.json
#
Ask an LLM
“How do I change which tag categories an experience uses?”
“Can I replace the tag categories on a channel in one request?”
Tell an agent
Set the tag categories of experience {id} to {tagCategoryIds}.
Update channel {id} to use tag categories {tagCategoryIds}.
POST
/channels/{id}/unlink.json
Unlink related resources from a channel · /channels/{id}/unlink.json
#
Ask an LLM
“How do I detach several related resources from a channel at once?”
“Can I remove resource links from a channel using a Link list?”
Tell an agent
Unlink the resources {Link} from channel {id}.
Detach {Link} from channel {id}.
GET
/channels/{id}/usergroups.json
List user groups with access to a channel · /channels/{id}/usergroups.json
#
Ask an LLM
“Which user groups can see a particular channel?”
“Can I check if a synced group is assigned to a channel?”
Tell an agent
List the user groups on channel {id}.
Find the group named {name} among channel {id}'s user groups.
POST
/channels/{id}/usergroups.json
Create a user group inside a channel · /channels/{id}/usergroups.json
#
Ask an LLM
“How do I create a new group and add it to a channel in one step?”
“Can I give the new channel group a description and external ID?”
Tell an agent
Create a group called {name} on channel {id}.
Add a new group {name} with external ID {externalId} to channel {id}.
Ask an LLM
“Who has access to a specific channel?”
“Can I list only the active users of one channel or find someone by email?”
Tell an agent
List the users of channel {id}.
Check whether {email} is a user on channel {id}.
Ask an LLM
“How do I create a new user and add them to a channel at the same time?”
“What details are required to add a new person to a channel?”
Tell an agent
Create user {userName} ({firstName} {lastName}, {email}) in channel {id} with language {language} and active {isActive}.
Add a new user with email {email} to channel {id}.
Documentation
Documentation
https://developer.showpad.com/docs/apis/
APIReference
https://developer.showpad.com/docs/apis/references/v3
Authentication
https://developer.showpad.com/docs/apis/concepts/authentication
APIReference
https://developer.showpad.com/docs/apis/references/v4
Documentation
https://developer.showpad.com/docs/apis/users/SCIM