Showpad

Showpad Channels API

The channels API from Showpad — 22 operation(s) for channels.

GitHub OpenAPI

Operations 29

GET /channels.json /channels.json #
POST /channels.json /channels.json #
GET /channels/count.json /channels/count.json #
GET /channels/description.json /channels/description.json #
GET /channels/experience-types.json /channels/experience-types.json #
GET /channels/experience-types/{experienceTypeId}/modules/{moduleName} /channels/experience-types/{experienceTypeId}/modules/{moduleName} #
GET /channels/overview.json /channels/overview.json #
GET /channels/{id1}/usergroups/{id2}.json /channels/{id1}/usergroups/{id2}.json #
GET /channels/{id1}/users/{id2}.json /channels/{id1}/users/{id2}.json #
GET /channels/{id}.json /channels/{id}.json #
PUT /channels/{id}.json /channels/{id}.json #
POST /channels/{id}.json /channels/{id}.json #
DELETE /channels/{id}.json /channels/{id}.json #
GET /channels/{id}/assets.json /channels/{id}/assets.json #
GET /channels/{id}/channelnodes.json /channels/{id}/channelnodes.json #
POST /channels/{id}/duplicate.json /channels/{id}/duplicate.json #
GET /channels/{id}/tag-categories.json /channels/{id}/tag-categories.json #
POST /channels/{id}/tag-categories.json /channels/{id}/tag-categories.json #
GET /channels/{id}/tags.json /channels/{id}/tags.json #
GET /channels/{id}/usergroups.json /channels/{id}/usergroups.json #
POST /channels/{id}/usergroups.json /channels/{id}/usergroups.json #
GET /channels/{id}/users.json /channels/{id}/users.json #
POST /channels/{id}/users.json /channels/{id}/users.json #

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/showpad/refs/heads/main/openapi/showpad-channels-api-openapi.yml

Other Resources

🔗
Versioning
https://developer.showpad.com/docs/apis/concepts/versions
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/showpad/refs/heads/main/errors/showpad-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/showpad/refs/heads/main/data-model/showpad-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/showpad-channels-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

showpad-channels-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Showpad Channels API
  version: '3'
  termsOfService: https://www.showpad.com/terms-of-service
  contact:
    name: Showpad
    email: support@showpad.com
    url: https://help.showpad.com/hc/en-us/requests/new
  x-audience: external-partner
servers:
- url: https://{subdomain}.showpad.biz/api/v3/
  description: Production server
  x-environment: production
  variables:
    subdomain:
      default: customer
      description: Showpad customer subdomain
security:
- oAuth: []
- bearerAuth: []
tags:
- name: channels
  description: ''
paths:
  /channels.json:
    get:
      deprecated: false
      tags:
      - channels
      operationId: get_channels
      description: Generates a list of Channel items
      summary: /channels.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                required:
                - response
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
                            type: string
                          name:
                            type: string
                  response:
                    type: object
                    properties:
                      count:
                        description: Total number of results.
                        type: integer
                        format: int32
                        example: 20
                      items:
                        type: array
                        description: List of resources.
                        items:
                          type: object
                          properties:
                            id:
                              description: Unique identifier for the resource
                              type: string
                            resourcetype:
                              description: The type of resource
                              type: string
                            href:
                              description: Location of the resource
                              type: string
                              format: link
                            appLink:
                              description: The app link to this channel
                              type: string
                            assets:
                              description: The assets linked to this channel
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
                            background:
                              description: The background image linked to this channel
                              type:
                              - string
                              - 'null'
                              format: link
                            backgroundPosition:
                              description: Pivot point for the background
                              type: string
                            channelNodes:
                              description: The channel nodes linked to this channel
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
                            cover:
                              description: The cover image linked to this channel
                              type:
                              - string
                              - 'null'
                              format: link
                            coverFocalPoint:
                              description: The gravity point of the cover image. Consists of a X and a Y coordinate between 0 and 1, where the origin indicates top left and the coordinates(1,1) represent bottom right
                              type:
                              - string
                              - 'null'
                            createdAt:
                              description: The date that the user was created
                              type: string
                              format: date-time
                            currentChannelTemplateConfig:
                              description: The channel template config that is currently being used for this channel
                              type:
                              - object
                              - 'null'
                              properties:
                                id:
                                  type: string
                                href:
                                  type: string
                                  format: link
                            currentTemplateAsset:
                              description: The template app linked to this channel
                              type:
                              - string
                              - 'null'
                              format: link
                            division:
                              description: The division linked to this channel
                              type: object
                              properties:
                                id:
                                  type: string
                                href:
                                  type: string
                                  format: link
                            externalId:
                              description: External ID of the tag as used in the source application
                              type:
                              - string
                              - 'null'
                            isPersonal:
                              description: Set if the channel is a personal (my) channel
                              type: boolean
                            lockedUntil:
                              description: The date the channel will be unlocked (if null, the channel is unlocked)
                              type:
                              - string
                              - 'null'
                              format: date-time
                            logo:
                              description: The logo image linked to this channel
                              type:
                              - string
                              - 'null'
                              format: link
                            logoPosition:
                              description: The pivot point for the logo
                              type: string
                            name:
                              description: The name of the channel
                              type: string
                            description:
                              description: The description of the channel
                              type:
                              - string
                              - 'null'
                            isHidden:
                              description: Defines if the experience should be shown in the UI
                              type: boolean
                            hideEmptyFolders:
                              description: Defines if the folders should be hidden when they are empty
                              type: boolean
                            enableContentProfiles:
                              description: Defines if dynamic content profiles are enabled
                              type: boolean
                            defaultViewMode:
                              description: Defines the default view for the experience
                              type: string
                            rootChannelNode:
                              description: The root channel node linked to this channel
                              type: object
                              properties:
                                id:
                                  type: string
                                href:
                                  type: string
                                  format: link
                            status:
                              description: The state of the profile, is one of "active", "lockedForDuplication", "pendingForDuplication"
                              type: string
                            template:
                              description: Indicates the type of template the channel is using
                              type:
                              - string
                              - 'null'
                            type:
                              description: Indicates the type of the channel (classic or template)
                              type: string
                            updatedAt:
                              description: The date that the user was updated
                              type: string
                              format: date-time
                            usergroups:
                              description: The groups linked to this channel
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
                            users:
                              description: The users linked to this channel
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
      security:
      - bearerAuth: []
      - oAuth:
        - read_contentprofile_management
      parameters:
      - name: appLink
        description: The app link to this channel
        required: false
        in: query
        schema:
          type: string
      - name: defaultViewMode
        description: Defines the default view for the experience
        required: false
        in: query
        schema:
          type: string
      - name: describe_apis
        description: Describes the different api calls available together with the allowed parameters
        required: false
        in: query
        schema:
          type: boolean
      - name: describe_model
        description: Describes the data model behind the resource including properties and their description
        required: false
        in: query
        schema:
          type: boolean
      - name: description
        description: The description of the channel
        required: false
        in: query
        schema:
          type: string
      - name: expand
        description: Comma separated list of all expanded relationships that need to be retrieved.
        required: false
        in: query
        schema:
          type: string
      - name: externalId
        description: External ID of the tag as used in the source application
        required: false
        in: query
        schema:
          type: string
      - name: fields
        description: Comma separated list of all fields that need to be retrieved.
        required: false
        in: query
        schema:
          type: string
      - name: includeApps
        description: Include app channels
        required: false
        in: query
        schema:
          type: boolean
      - name: includeTemplateChannels
        description: Include template channels
        required: false
        in: query
        schema:
          type: boolean
      - name: isHidden
        description: Defines if the experience should be shown in the UI
        required: false
        in: query
        schema:
          type: boolean
      - name: isPersonal
        description: Set if the channel is a personal (my) channel
        required: false
        in: query
        schema:
          type: boolean
      - name: limit
        description: Sets the maximum number of returned items. The maximum limit is set to 1000. For example, if 'limit' is 0, only 0 items will be retrieved.
        required: false
        in: query
        schema:
          type: integer
          format: int32
          minimum: 0
          maximum: 1000
      - name: method
        description: '''method'' can be used by HTTP clients who are not able to set certain HTTP verbs such as a DELETE of a PUT'
        required: false
        in: query
        schema:
          type: string
          anyOf:
          - title: post
            type: string
      - name: name
        description: The name of the channel
        required: false
        in: query
        schema:
          type: string
      - name: offset
        description: Set the offset of the returned items.For example, if 'offset' is 5 and 'limit' is 10,  items 6 to 15 will be returned.
        required: false
        in: query
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: personalContentIncluded
        description: Whether or not to include personal content when querying for a user
        required: false
        in: query
        schema:
          type: boolean
      - name: sort
        description: The field you want to sort on. Adding a '-' in front of the field name allows you to sort descending. Allowed values are createdAt, name, updatedAt.
        required: false
        in: query
        schema:
          type: string
      - name: suppress_response_codes
        description: 'This forces the HTTP status code of the response to be set to 200 '
        required: false
        in: query
        schema:
          type: boolean
      - name: template
        description: Indicates the type of template the channel is using
        required: false
        in: query
        schema:
          type: string
      - name: type
        description: Indicates the type of the channel (classic or template)
        required: false
        in: query
        schema:
          type: string
    post:
      deprecated: false
      tags:
      - channels
      operationId: post_channels
      description: Create a Channel item
      summary: /channels.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                required:
                - response
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
                            type: string
                          name:
                            type: string
                  response:
                    type: object
                    properties:
                      id:
                        description: Unique identifier for the resource
                        type: string
                      resourcetype:
                        description: The type of resource
                        type: string
                      href:
                        description: Location of the resource
                        type: string
                        format: link
                      appLink:
                        description: The app link to this channel
                        type: string
                      assets:
                        description: The assets linked to this channel
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
                      background:
                        description: The background image linked to this channel
                        type:
                        - string
                        - 'null'
                        format: link
                      backgroundPosition:
                        description: Pivot point for the background
                        type: string
                      channelNodes:
                        description: The channel nodes linked to this channel
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
                      cover:
                        description: The cover image linked to this channel
                        type:
                        - string
                        - 'null'
                        format: link
                      coverFocalPoint:
                        description: The gravity point of the cover image. Consists of a X and a Y coordinate between 0 and 1, where the origin indicates top left and the coordinates(1,1) represent bottom right
                        type:
                        - string
                        - 'null'
                      createdAt:
                        description: The date that the user was created
                        type: string
                        format: date-time
                      currentChannelTemplateConfig:
                        description: The channel template config that is currently being used for this channel
                        type:
                        - object
                        - 'null'
                        properties:
                          id:
                            type: string
                          href:
                            type: string
                            format: link
                      currentTemplateAsset:
                        description: The template app linked to this channel
                        type:
                        - string
                        - 'null'
                        format: link
                      division:
                        description: The division linked to this channel
                        type: object
                        properties:
                          id:
                            type: string
                          href:
                            type: string
                            format: link
                      externalId:
                        description: External ID of the tag as used in the source application
                        type:
                        - string
                        - 'null'
                      isPersonal:
                        description: Set if the channel is a personal (my) channel
                        type: boolean
                      lockedUntil:
                        description: The date the channel will be unlocked (if null, the channel is unlocked)
                        type:
                        - string
                        - 'null'
                        format: date-time
                      logo:
                        description: The logo image linked to this channel
                        type:
                        - string
                        - 'null'
                        format: link
                      logoPosition:
                        description: The pivot point for the logo
                        type: string
                      name:
                        description: The name of the channel
                        type: string
                      description:
                        description: The description of the channel
                        type:
                        - string
                        - 'null'
                      isHidden:
                        description: Defines if the experience should be shown in the UI
                        type: boolean
                      hideEmptyFolders:
                        description: Defines if the folders should be hidden when they are empty
                        type: boolean
                      enableContentProfiles:
                        description: Defines if dynamic content profiles are enabled
                        type: boolean
                      defaultViewMode:
                        description: Defines the default view for the experience
                        type: string
                      rootChannelNode:
                        description: The root channel node linked to this channel
                        type: object
                        properties:
                          id:
                            type: string
                          href:
                            type: string
                            format: link
                      status:
                        description: The state of the profile, is one of "active", "lockedForDuplication", "pendingForDuplication"
                        type: string
                      template:
                        description: Indicates the type of template the channel is using
                        type:
                        - string
                        - 'null'
                      type:
                        description: Indicates the type of the channel (classic or template)
                        type: string
                      updatedAt:
                        description: The date that the user was updated
                        type: string
                        format: date-time
                      usergroups:
                        description: The groups linked to this channel
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
                      users:
                        description: The users linked to this channel
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
      security:
      - bearerAuth: []
      - oAuth:
        - write_contentprofile_management
      parameters:
      - name: Link
        description: A comma-separated list of '<resourceID>; rel="ResourceType"'
        required: false
        in: header
        schema:
          type: string
      - name: describe_apis
        description: Describes the different api calls available together with the allowed parameters
        required: false
        in: query
        schema:
          type: boolean
      - name: describe_model
        description: Describes the data model behind the resource including properties and their description
        required: false
        in: query
        schema:
          type: boolean
      - name: expand
        description: Comma separated list of all expanded relationships that need to be retrieved.
        required: false
        in: query
        schema:
          type: string
      - name: fields
        description: Comma separated list of all fields that need to be retrieved.
        required: false
        in: query
        schema:
          type: string
      - name: suppress_response_codes
        description: 'This forces the HTTP status code of the response to be set to 200 '
        required: false
        in: query
        schema:
          type: boolean
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                isHidden:
                  type: boolean
                name:
                  type: string
                defaultViewMode:
                  type: string
                description:
                  type: string
                externalId:
                  type: string
                type:
                  type: string
              required:
              - isHidden
              - name
          application/json:
            schema:
              type: object
              properties:
                isHidden:
                  type: boolean
                name:
                  type: string
                defaultViewMode:
                  type: string
                description:
                  type: string
                externalId:
                  type: string
                type:
                  type: string
              required:
              - isHidden
              - name
  /channels/count.json:
    get:
      deprecated: false
      tags:
      - channels
      operationId: get_channels_count
      description: Retrieve the number of Channel items
      summary: /channels/count.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
                            type: string
                          name:
                            type: string
                  response:
                    type: object
                    properties:
                      count:
                        type: integer
                        format: int32
      security:
      - bearerAuth: []
      - oAuth:
        - read_contentprofile_management
      parameters:
      - name: appLink
        description: The app link to this channel
        required: false
        in: query
        schema:
          type: string
      - name: defaultViewMode
        description: Defines the default view for the experience
        required: false
        in: query
        schema:
          type: string
      - name: describe_apis
        description: Describes the different api calls available together with the allowed parameters
        required: false
        in: query
        schema:
          type: boolean
      - name: describe_model
        description: Describes the data model behind the resource including properties and their description
        required: false
        in: query
        schema:
          type: boolean
      - name: description
        description: The description of the channel
        required: false
        in: query
        schema:
          type: string
      - name: externalId
        description: External ID of the tag as used in the source application
        required: false
        in: query
        schema:
          type: string
      - name: includeApps
        description: Include app channels
        required: false
        in: query
        schema:
          type: boolean
      - name: includeTemplateChannels
        description: Include template channels
        required: false
        in: query
        schema:
          type: boolean
      - name: isHidden
        description: Defines if the experience should be shown in the UI
        required: false
        in: query
        schema:
          type: boolean
      - name: isPersonal
        description: Set if the channel is a personal (my) channel
        required: false
        in: query
        schema:
          type: boolean
      - name: name
        description: The name of the channel
        required: false
        in: query
        schema:
          type: string
      - name: personalContentIncluded
        description: Whether or not to include personal content when querying for a user
        required: false
        in: query
        schema:
          type: boolean
      - name: suppress_response_codes
        description: 'This forces the HTTP status code of the response to be set to 200 '
        required: false
        in: query
        schema:
          type: boolean
      - name: template
        description: Indicates the type of template the channel is using
        required: false
        in: query
        schema:
          type: string
      - name: type
        description: Indicates the type of the channel (classic or template)
        required: false
        in: query
        schema:
          type: string
  /channels/description.json:
    get:
      deprecated: false
      tags:
      - channels
      operationId: get_channels_description
      description: Generates information about the Channel model and available apis
      summary: /channels/description.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
       

# --- truncated at 32 KB (243 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/showpad/refs/heads/main/openapi/showpad-channels-api-openapi.yml