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: type: string name: type: string response: type: object security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - 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 /channels/experience-types.json: get: deprecated: false tags: - channels operationId: get_channels_experience-types description: Get the list of installed experience types summary: /channels/experience-types.json responses: default: description: successful operation content: application/json: schema: type: object security: - bearerAuth: [] - oAuth: - read_contentprofile_management /channels/experience-types/{experienceTypeId}/modules/{moduleName}: get: deprecated: false tags: - channels operationId: get_channels_experience-types_experiencetypeid_modules_modulename description: Get the module info of experience type summary: /channels/experience-types/{experienceTypeId}/modules/{moduleName} responses: default: description: successful operation content: application/json: schema: type: object security: - bearerAuth: [] - oAuth: - read_contentprofile_management /channels/overview.json: get: deprecated: false tags: - channels operationId: get_channels_overview description: Get overview of channels summary: /channels/overview.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 name: description: The name of the channel type: string createdAt: description: The date that the user was created type: string format: date-time updatedAt: description: The date that the user was updated type: string format: date-time appLink: description: The app link to this channel 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 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' background: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string downloadUrl: description: The url this background can be downloaded from type: string isDefault: description: Whether the background is a default icon provided by Showpad type: boolean division: description: The division this background belongs to type: string format: link assetId: description: The unique identifier of the asset linked to this background. type: string currentTemplateAsset: type: - object - 'null' description: The template app linked to this channel properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string createdAt: description: The date that the file was created type: string format: date-time uploadedAt: description: The date that the file was uploaded type: string format: date-time description: description: Custom description about the file type: - string - 'null' href: description: Location of the asset type: string division: description: The location of the divisions related to this asset type: object properties: href: type: string format: link id: type: string downloadLink: description: Link where the file can be downloaded. type: - string - 'null' shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: - string - 'null' shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: - integer - 'null' format: int32 externalId: description: External ID of the asset as used in the source application type: - string - 'null' fileSize: description: Size of the file in bytes type: integer format: int32 filetype: description: Type of file type: string processedDownloadLink: description: Link where the processed file can be downloaded type: string isAnnotatable: description: Set to true if you want to allow tablet users to share to annotate this file type: boolean isSensitive: description: Set to true if you do not want this file to be visible in Kiosk mode on the tablet type: boolean isShareable: description: Set to true if you want to allow users to share this file with other people type: boolean isDownloadable: description: Set to true if you want to allow recipients to be able to download this file type: boolean isDivisionShared: description: Set to true if you want to share this file across divisions type: boolean useOptimized: description: Set to true if you want to use the optimized version of this file type: boolean name: description: Display name of the file type: string url: description: Url to link to type: - string - 'null' originalName: description: Original name of the file type: string previewDownloadLink: description: Link where the preview of the file can be downloaded. type: string thumbnailDownloadLink: description: Link where the thumbnail of the file can be downloaded. type: string tags: description: The location of the tags related to this asset type: object properties: href: type: string format: link assetView: description: The location of the asset view related to this asset type: object properties: id: type: string href: type: string format: link updatedAt: description: The date that the file was updated type: string format: date-time views: description: The number of views by tablet users on this file type: integer format: int32 appLink: description: Link to asset inside application type: string liked: description: The asset was liked by the current user type: boolean likesCount: description: Count of people who have liked an asset type: integer format: int32 standardId: description: Standard ID with version (e.g. ph-135.v1) type: string externalDate: description: An external date of the asset as used in the source application type: - string - 'null' format: date archivedAt: description: The date that the file was sent to trash type: - string - 'null' format: date expiresAt: description: The expiry date of the asset type: - string - 'null' format: date releasedAt: description: The release date of the asset type: - string - 'null' format: date draftedAt: description: The draft date of the asset type: - string - 'null' format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: - array - 'null' items: type: string pageCount: description: The number of pages the document has, if applicable type: - integer - 'null' format: int32 onlyShareEntireDocument: description: Whether or not we can only share the entire document type: boolean isPersonal: description: Whether or not the asset is a 'personal' asset - in your own division type: boolean isMarketing: description: Whether or not the asset is a 'marketing' asset - not a personal division type: boolean externalServiceId: description: External Service ID of the asset as used in the source application type: - string - 'null' currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: - string - 'null' format: link channelTemplateConfigId: description: Channel template config ID type: - string - 'null' format: link slug: description: The slug of the asset (valid and unique UUIDv4) type: string hideLabel: description: Set to true if you want to hide the label for this asset type: boolean isEditable: description: Set true if the asset can be edited in the Showpad Edit App type: boolean sourceAsset: description: The original asset from which this asset was created from type: - string - 'null' format: link sourceAssetName: description: The original asset name from which this asset was created from type: string sourceAssetLink: description: The link to the original asset type: string videoLength: description: Length of the video type: - integer - 'null' format: int32 duration: description: Duration of the media type: - integer - 'null' format: int32 wordCount: description: The number of words the asset contains, if applicable type: - integer - 'null' format: int32 allowRenderExternal: description: Indicates if a url asset should be opened in a new window, or rendered inside showpad (iframe) type: boolean downloadableInternal: description: Indicates type of content that can be downloaded by internal users type: - array - 'null' items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: - array - 'null' items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: - string - 'null' fileUuid: description: The Uuid of the current file type: - string - 'null' version: description: The version of asset as an integer type: integer format: int32 parentAssetId: description: The ID of the parent asset if it exist type: - string - 'null' oAuth2ClientId: description: The OAuth2 client that can manage the asset via an external service type: string cover: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string downloadUrl: description: The url this background can be downloaded from type: string isDefault: description: Whether the background is a default icon provided by Showpad type: boolean division: description: The division this background belongs to type: string format: link assetId: description: The unique identifier of the asset linked to this background. type: string thumbnailDownloadLink: description: The link for the thumbnail image type: - string - 'null' format: link security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: divisionId description: Division where to get experiences required: true in: query schema: type: string /channels/{id1}/usergroups/{id2}.json: get: deprecated: false tags: - channels operationId: get_channels_id1_usergroups_id2 description: Link or unlink a channel with ID = 'id1' to a usergroup with ID = 'id2' summary: /channels/{id1}/usergroups/{id2}.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 security: - bearerAuth: [] - oAuth: - write_contentprofile_management - write_user_management parameters: - name: id1 description: ID of the Channel item required: true in: path schema: type: string - name: id2 description: ID of the Usergroup item required: true in: path schema: type: string - 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: true in: query schema: type: string anyOf: - title: link type: string - title: unlink 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: 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 /channels/{id1}/usergroups/{id2}/link.json: post: deprecated: false tags: - channels operationId: link_channels_id1_usergroups_id2_link description: Link a channel with ID = 'id1' to a usergroup with ID = 'id2' summary: /channels/{id1}/usergroups/{id2}/link.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 security: - bearerAuth: [] - oAuth: - write_contentprofile_management - write_user_management parameters: - name: id1 description: ID of the Channel item required: true in: path schema: type: string - name: id2 description: ID of the Usergroup item required: true in: path 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: 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 /channels/{id1}/usergroups/{id2}/unlink.json: post: deprecated: false tags: - channels operationId: unlink_channels_id1_usergroups_id2_unlink description: Unlink a channel with ID = 'id1' from a usergroup with ID = 'id2' summary: /channels/{id1}/usergroups/{id2}/unlink.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 security: - bearerAuth: [] - oAuth: - write_contentprofile_management - write_user_management parameters: - name: id1 description: ID of the Channel item required: true in: path schema: type: string - name: id2 description: ID of the Usergroup item required: true in: path 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: 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 /channels/{id1}/users/{id2}.json: get: deprecated: false tags: - channels operationId: get_channels_id1_users_id2 description: Link or unlink a channel with ID = 'id1' to a user with ID = 'id2' summary: /channels/{id1}/users/{id2}.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 security: - bearerAuth: [] parameters: - name: id1 description: ID of the Channel item required: true in: path schema: type: string - name: id2 description: ID of the User item required: true in: path schema: type: string - 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: true in: query schema: type: string anyOf: - title: link type: string - title: unlink 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: 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 /channels/{id1}/users/{id2}/link.json: post: deprecated: false tags: - channels operationId: link_channels_id1_users_id2_link description: Link a channel with ID = 'id1' to a user with ID = 'id2' summary: /channels/{id1}/users/{id2}/link.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 security: - bearerAuth: [] - oAuth: - write_contentprofile_management - write_user_management parameters: - name: id1 description: ID of the Channel item required: true in: path schema: type: string - name: id2 description: ID of the User item required: true in: path 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: 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 /channels/{id1}/users/{id2}/unlink.json: post: deprecated: false tags: - channels operationId: unlink_channels_id1_users_id2_unlink description: Unlink a channel with ID = 'id1' from a user with ID = 'id2' summary: /channels/{id1}/users/{id2}/unlink.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 security: - bearerAuth: [] - oAuth: - write_contentprofile_management - write_user_management parameters: - name: id1 description: ID of the Channel item required: true in: path schema: type: string - name: id2 description: ID of the User item required: true in: path 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: 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 /channels/{id}.json: get: deprecated: false tags: - channels operationId: get_channels_id description: Retrieve Channel item with ID='id' summary: /channels/{id}.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: - read_contentprofile_management parameters: - name: id description: ID of the Channel item required: true in: path 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 enum: - background - logo - rootChannelNode - currentTemplateAsset - cover - division - access - name: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - 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: get type: string - title: post type: string - title: put type: string - title: delete type: string - title: link type: string - title: unlink 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 put: deprecated: false tags: - channels operationId: put_channels_id description: Update the Channel item with ID='id' summary: /channels/{id}.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: id description: ID of the Channel item required: true in: path schema: type: string - 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 enum: - background - logo - rootChannelNode - currentTemplateAsset - cover - division - access - 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: coverFocalPoint: type: string defaultViewMode: type: string description: type: string externalId: type: string isHidden: type: boolean name: type: string application/json: schema: type: object properties: coverFocalPoint: type: string defaultViewMode: type: string description: type: string externalId: type: string isHidden: type: boolean name: type: string post: deprecated: false tags: - channels operationId: post_channels_id description: Update the Channel item with ID='id' summary: /channels/{id}.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: id description: ID of the Channel item required: true in: path schema: type: string - 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 enum: - background - logo - rootChannelNode - currentTemplateAsset - cover - division - access - 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: coverFocalPoint: type: string defaultViewMode: type: string description: type: string externalId: type: string isHidden: type: boolean name: type: string application/json: schema: type: object properties: coverFocalPoint: type: string defaultViewMode: type: string description: type: string externalId: type: string isHidden: type: boolean name: type: string delete: deprecated: false tags: - channels operationId: delete_channels_id description: Delete the Channel item with ID='id' summary: /channels/{id}.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 security: - bearerAuth: [] - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Channel item required: true in: path 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: 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 /channels/{id}/assets.json: get: deprecated: false tags: - channels operationId: get_channels_id_assets description: Get all assets that belong to the channel with ID='id' summary: /channels/{id}/assets.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 createdAt: description: The date that the file was created type: string format: date-time uploadedAt: description: The date that the file was uploaded type: string format: date-time description: description: Custom description about the file type: - string - 'null' href: description: Location of the asset type: string division: description: The location of the divisions related to this asset type: object properties: href: type: string format: link id: type: string downloadLink: description: Link where the file can be downloaded. type: - string - 'null' shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: - string - 'null' shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: - integer - 'null' format: int32 externalId: description: External ID of the asset as used in the source application type: - string - 'null' fileSize: description: Size of the file in bytes type: integer format: int32 filetype: description: Type of file type: string processedDownloadLink: description: Link where the processed file can be downloaded type: string isAnnotatable: description: Set to true if you want to allow tablet users to share to annotate this file type: boolean isSensitive: description: Set to true if you do not want this file to be visible in Kiosk mode on the tablet type: boolean isShareable: description: Set to true if you want to allow users to share this file with other people type: boolean isDownloadable: description: Set to true if you want to allow recipients to be able to download this file type: boolean isDivisionShared: description: Set to true if you want to share this file across divisions type: boolean useOptimized: description: Set to true if you want to use the optimized version of this file type: boolean name: description: Display name of the file type: string url: description: Url to link to type: - string - 'null' originalName: description: Original name of the file type: string previewDownloadLink: description: Link where the preview of the file can be downloaded. type: string thumbnailDownloadLink: description: Link where the thumbnail of the file can be downloaded. type: string tags: description: The location of the tags related to this asset type: object properties: href: type: string format: link assetView: description: The location of the asset view related to this asset type: object properties: id: type: string href: type: string format: link updatedAt: description: The date that the file was updated type: string format: date-time views: description: The number of views by tablet users on this file type: integer format: int32 appLink: description: Link to asset inside application type: string liked: description: The asset was liked by the current user type: boolean likesCount: description: Count of people who have liked an asset type: integer format: int32 standardId: description: Standard ID with version (e.g. ph-135.v1) type: string externalDate: description: An external date of the asset as used in the source application type: - string - 'null' format: date archivedAt: description: The date that the file was sent to trash type: - string - 'null' format: date expiresAt: description: The expiry date of the asset type: - string - 'null' format: date releasedAt: description: The release date of the asset type: - string - 'null' format: date draftedAt: description: The draft date of the asset type: - string - 'null' format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: - array - 'null' items: type: string pageCount: description: The number of pages the document has, if applicable type: - integer - 'null' format: int32 onlyShareEntireDocument: description: Whether or not we can only share the entire document type: boolean isPersonal: description: Whether or not the asset is a 'personal' asset - in your own division type: boolean isMarketing: description: Whether or not the asset is a 'marketing' asset - not a personal division type: boolean externalServiceId: description: External Service ID of the asset as used in the source application type: - string - 'null' currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: - string - 'null' format: link channelTemplateConfigId: description: Channel template config ID type: - string - 'null' format: link slug: description: The slug of the asset (valid and unique UUIDv4) type: string hideLabel: description: Set to true if you want to hide the label for this asset type: boolean isEditable: description: Set true if the asset can be edited in the Showpad Edit App type: boolean sourceAsset: description: The original asset from which this asset was created from type: - string - 'null' format: link sourceAssetName: description: The original asset name from which this asset was created from type: string sourceAssetLink: description: The link to the original asset type: string videoLength: description: Length of the video type: - integer - 'null' format: int32 duration: description: Duration of the media type: - integer - 'null' format: int32 wordCount: description: The number of words the asset contains, if applicable type: - integer - 'null' format: int32 allowRenderExternal: description: Indicates if a url asset should be opened in a new window, or rendered inside showpad (iframe) type: boolean downloadableInternal: description: Indicates type of content that can be downloaded by internal users type: - array - 'null' items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: - array - 'null' items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: - string - 'null' fileUuid: description: The Uuid of the current file type: - string - 'null' version: description: The version of asset as an integer type: integer format: int32 parentAssetId: description: The ID of the parent asset if it exist type: - string - 'null' oAuth2ClientId: description: The OAuth2 client that can manage the asset via an external service type: string security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: id description: ID of the Channel item required: true in: path schema: type: string - name: archivedAt description: The date that the file was sent to trash required: false in: query schema: type: string format: date - 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: externalId description: External ID of the asset as used in the source application required: false in: query schema: type: string - name: externalServiceId description: External Service ID of the asset 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: filetype description: Type of file required: false in: query schema: type: string anyOf: - title: 3d-model type: string - title: audio type: string - title: document type: string - title: personal-video-recording type: string - title: photo type: string - title: raw type: string - title: scorm type: string - title: video type: string - title: webapp type: string - title: url type: string - title: page type: string - name: hideLabel description: Set to true if you want to hide the label for this asset required: false in: query schema: type: boolean - name: isAnnotatable description: Set to true if you want to allow tablet users to share to annotate this file required: false in: query schema: type: boolean - name: isDivisionShared description: Set to true if you want to share this file across divisions required: false in: query schema: type: boolean - name: isDownloadable description: Set to true if you want to allow recipients to be able to download this file required: false in: query schema: type: boolean - name: isEditable description: Set true if the asset can be edited in the Showpad Edit App required: false in: query schema: type: boolean - name: isPersonal description: Whether or not the asset is a 'personal' asset - in your own division required: false in: query schema: type: boolean - name: isSensitive description: Set to true if you do not want this file to be visible in Kiosk mode on the tablet required: false in: query schema: type: boolean - name: isShareable description: Set to true if you want to allow users to share this file with other people 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: lockedPages description: The pages that are locked together in this asset required: false in: query schema: type: array items: type: string - 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: Display name of the file 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: onlyShareEntireDocument description: Whether or not we can only share the entire document required: false in: query schema: type: boolean - name: originalName description: Original name of the file required: false in: query schema: type: string - name: slug description: The slug of the asset (valid and unique UUIDv4) required: false in: query schema: type: string - name: sort description: The field you want to sort on. Adding a '-' in front of the field name allows you to sort descending. required: false in: query schema: type: string - name: standardId description: Standard ID with version (e.g. ph-135.v1) 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: url description: Url to link to required: false in: query schema: type: string - name: useOptimized description: Set to true if you want to use the optimized version of this file required: false in: query schema: type: boolean - name: version description: The version of asset as an integer required: false in: query schema: type: integer format: int32 /channels/{id}/channelnodes.json: get: deprecated: false tags: - channels operationId: get_channels_id_channelnodes description: Get all channel nodes that belong to the channel with ID='id' summary: /channels/{id}/channelnodes.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: Link for channel node (in the case of app links) type: string asset: description: Related asset (if not a smartview, etc.) type: string format: link assetType: description: Type of the asset type: string channel: description: Channel it belongs to type: string format: link createdAt: description: Datetime for the creation date type: string format: date externalId: description: External Id type: string hideLabel: description: Whether to hide the label type: boolean humanReadablePath: description: Channel node path type: string icon: description: Icon (if it has an icon to represent it) type: string format: link isSensitive: description: Whether the node can be seen in kiosk mode, true will hide it type: boolean label: description: Label used for channel node type: string limit: description: To be used in combination with filter, will limit the amount of items returned by the filter type: integer format: int32 parentNode: description: Parent node (null if none) type: string format: link path: description: Path as stored in the system type: string privateNote: description: Private note (not publicly visible) type: string publicNote: description: Public note type: string rootNode: description: Root node (null if uppermost) type: string format: link type: description: Type of channel node type: string updatedAt: description: Datetime for the date when it was last updated type: string format: date url: description: URL for the channel node type: string left: description: Left position (used for sorting) type: integer format: int32 leftNode: description: Left node (see LEFT) type: string format: link level: description: Nesting level (0-based) type: integer format: int32 right: description: Right position (used for sorting) type: integer format: int32 rightNode: description: Right node (see RIGHT) type: string format: link security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: id description: ID of the Channel item required: true in: path schema: type: string - name: appLink description: Link for channel node (in the case of app links) required: false in: query schema: type: string - name: assetAppLink description: Link to the asset required: false in: query schema: type: string - name: assetTagIds description: Comma separated list of all tags id's to filter required: false in: query schema: type: string - name: assetType description: Type of the asset required: false in: query schema: type: string anyOf: - title: 3d-model type: string - title: audio type: string - title: document type: string - title: personal-video-recording type: string - title: photo type: string - title: raw type: string - title: scorm type: string - title: video type: string - title: webapp type: string - title: url type: string - title: page 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: level description: Nesting level (0-based) required: false in: query schema: type: integer format: int32 - 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: 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: parentNodeId description: ID of the parent node (null if none) required: false in: query schema: type: string - name: ancestorId description: ID of the ancestor node to filter on required: false in: query schema: type: string - name: query description: Used to query based on URI, etc. required: false in: query schema: type: string - name: sort description: The field you want to sort on. Adding a '-' in front of the field name allows you to sort descending. 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: type description: Type of channel node required: false in: query schema: type: string anyOf: - title: album type: string - title: collection type: string - title: item type: string - title: root type: string - title: smartCollection type: string - title: uri type: string /channels/{id}/duplicate.json: post: deprecated: false tags: - channels operationId: post_channels_id_duplicate description: Duplicate the channel item with ID='id' summary: /channels/{id}/duplicate.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: id description: ID of the source channel item required: true in: path 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: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string requestBody: required: true content: application/json: schema: type: object properties: targetResource: type: string addCurrentUser: type: boolean required: - targetResource /channels/{id}/link.json: post: deprecated: false tags: - channels operationId: link_channels_id_link description: Link the Channel item with ID='id' summary: /channels/{id}/link.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 security: - bearerAuth: [] - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Channel item required: true in: path 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: 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: Link: type: string required: - Link application/json: schema: type: object properties: Link: type: string required: - Link /channels/{id}/tag-categories.json: get: deprecated: false tags: - channels operationId: get_channels_id_tag-categories description: Fetch the tag categories for an experience with ID='id' summary: /channels/{id}/tag-categories.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: - read_contentprofile_management parameters: - name: id description: ID of the source experience required: true in: path schema: type: string post: deprecated: false tags: - channels operationId: post_channels_id_tag-categories description: Update the tag categories for an experience with ID='id' summary: /channels/{id}/tag-categories.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: id description: ID of the source experience required: true in: path schema: type: string requestBody: required: true content: application/json: schema: type: object properties: tagCategoryIds: description: List of tag category ids type: array items: description: Tag category id type: string required: - tagCategoryIds /channels/{id}/tags.json: get: deprecated: false tags: - channels operationId: get_channels_id_tags description: Get tags for channel with ID='id' summary: /channels/{id}/tags.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 security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: id description: ID of the source channel item required: true in: path schema: type: string /channels/{id}/unlink.json: post: deprecated: false tags: - channels operationId: unlink_channels_id_unlink description: Link the Channel item with ID='id' summary: /channels/{id}/unlink.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 security: - bearerAuth: [] - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Channel item required: true in: path 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: 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: Link: type: string required: - Link application/json: schema: type: object properties: Link: type: string required: - Link /channels/{id}/usergroups.json: get: deprecated: false tags: - channels operationId: get_channels_id_usergroups description: Get all usergroups that belong to the channel with ID='id' summary: /channels/{id}/usergroups.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 name: description: Name of the usergroup type: string description: description: Description of the usergroup type: string externalId: description: External ID of the usergroup as used in the source application type: - string - 'null' updatedAt: description: The date that the usergroup was updated type: string format: date-time createdAt: description: The date that the usergroup was created type: string format: date-time divisions: description: The division linked to this usergroup type: object properties: href: type: string format: link users: description: The users linked to this usergroup type: object properties: href: type: string format: link anonymizedUserData: description: Displays if this groups has anonymized data. type: boolean isDefault: description: Default usergroup containing all users. type: boolean userCount: description: The amount of users in this group. type: - integer - 'null' format: int32 deactivatedUserCount: description: The amount of deactivated users in this group. type: - integer - 'null' format: int32 pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: - integer - 'null' format: int32 neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: - integer - 'null' format: int32 numberOfDirectLicenses: description: The number of direct licenses. type: - integer - 'null' format: int32 numberOfPartnerLicenses: description: The number of partner licenses. type: - integer - 'null' format: int32 numberOfViewOnlyLicenses: description: The number of view only licenses. type: - integer - 'null' format: int32 isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: - boolean - 'null' provisionedBy: description: The system that provisioned this usergroup. type: - string - 'null' security: - bearerAuth: [] - oAuth: - read_contentprofile_management - read_user_management parameters: - name: id description: ID of the Channel item required: true in: path 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: externalId description: External ID of the usergroup 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: isSynced description: Show that usergroup is synced 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: Name of the usergroup 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: 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 name. 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 post: deprecated: false tags: - channels operationId: post_channels_id_usergroups description: Add a group to the channel with ID='id' summary: /channels/{id}/usergroups.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 name: description: Name of the usergroup type: string description: description: Description of the usergroup type: string externalId: description: External ID of the usergroup as used in the source application type: - string - 'null' updatedAt: description: The date that the usergroup was updated type: string format: date-time createdAt: description: The date that the usergroup was created type: string format: date-time divisions: description: The division linked to this usergroup type: object properties: href: type: string format: link users: description: The users linked to this usergroup type: object properties: href: type: string format: link anonymizedUserData: description: Displays if this groups has anonymized data. type: boolean isDefault: description: Default usergroup containing all users. type: boolean userCount: description: The amount of users in this group. type: - integer - 'null' format: int32 deactivatedUserCount: description: The amount of deactivated users in this group. type: - integer - 'null' format: int32 pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: - integer - 'null' format: int32 neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: - integer - 'null' format: int32 numberOfDirectLicenses: description: The number of direct licenses. type: - integer - 'null' format: int32 numberOfPartnerLicenses: description: The number of partner licenses. type: - integer - 'null' format: int32 numberOfViewOnlyLicenses: description: The number of view only licenses. type: - integer - 'null' format: int32 isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: - boolean - 'null' provisionedBy: description: The system that provisioned this usergroup. type: - string - 'null' security: - bearerAuth: [] - oAuth: - write_contentprofile_management - write_user_management parameters: - name: id description: ID of the Channel item required: true in: path 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: 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: name: type: string contentProfiles: type: array items: type: string description: type: string externalId: type: string provisionedBy: type: string required: - name application/json: schema: type: object properties: name: type: string contentProfiles: type: array items: type: string description: type: string externalId: type: string provisionedBy: type: string required: - name /channels/{id}/users.json: get: deprecated: false tags: - channels operationId: get_channels_id_users description: Get all users that belong to the channel with ID='id' summary: /channels/{id}/users.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 apiKey: description: The API key of the user type: - string - 'null' avatar: description: The Avatar linked to this user type: - string - 'null' format: link companyName: description: User's company name type: string companyRole: description: User's company role type: - string - 'null' consentGivenAt: description: The date at which the user consented to the current privacy policy type: - string - 'null' format: date consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: - string - 'null' createdAt: description: The date that the user was created type: string format: date-time divisionpermissions: description: The Division Permissions linked to this user type: - string - 'null' format: link email: description: Email of the user type: string emailNotifications: description: Set to true if the user will receive email notifications for activities performed by recipients type: boolean emailSignature: description: User's email signature type: - string - 'null' externalId: description: External ID of the user as used in the source application. Can only be used by the owner, admin or promoted users. type: - string - 'null' firstName: description: First name of the user type: string forcePasswordReset: description: 'Determines whether a user should change their password on first login after having had their password reset. When provided without a password, this value will be ignored.' type: boolean ftueStatus: description: FTUE dialogs acknowledged by the user type: - string - 'null' insightsLastViewedAt: description: Last time Showpad Insights was viewed type: - string - 'null' format: date invitationConfirmedAt: description: Confirmation date of the initial user invitation type: - string - 'null' format: date-time isActive: description: Indicates whether a user is active type: boolean isAnonymized: description: Show that user is anonymized. Can only be used by the owner, admin or promoted users. type: boolean isInvited: description: Shows that user is invited. Can only be used by the owner, admin or promoted users. type: boolean isPasswordSet: description: Indicates if user password is set type: boolean isSynced: description: Shows that user is synced. Can only be used by the owner, admin or promoted users. type: boolean isTrainingCoachingManager: description: Shows whether the user training coaching manager is or not type: boolean language: description: The user's language type: string lastConfirmedContentUpdate: description: The date the user last updated his content type: - string - 'null' format: date lastInvitationSentAt: description: Date of the last sent invitation email type: - string - 'null' format: date-time lastInvitationStatus: description: Status of the last sent invitation email type: - string - 'null' lastLogin: description: The date the user last logged in type: - string - 'null' format: date lastName: description: Last name of the user type: string managedUsergroups: description: A list of usergroups managed by the user. Can only be used by the owner, admin or promoted users. type: - string - 'null' format: link multiPillarNavigation: description: Indicates whether the multi pillar navigation is enabled type: boolean myUploadsCollectionId: description: ID of the uploads collection for this user type: string myUploadsDivisionId: description: ID of the my uploads channel for this user type: string personalContentFileSizeUsed: description: Total used space for this user's My Uploads section type: integer format: int32 personalContentIndividualFileSizeLimit: description: Limit of a My Uploads upload for this user type: integer format: int64 personalContentTotalFileSizeLimit: description: Limit of this user's My Uploads quote type: integer format: int64 isPersonalContentTotalUnlimited: description: Should the personal storage limit be interpreted as unlimited? type: boolean phone: description: User's phone number type: - string - 'null' productLicenseContent: description: Show user's productLicenseContent type: string productLicenseTrainingCoaching: description: Show user's productLicenseTrainingCoaching type: string timezone: description: "User timezone (or company timezone if not specified). Must be a tz database identifier i.e. Country/City. \nIf the city part contains multiple words it must be split by underscores i.e. America/New_York.\n" type: string updatedAt: description: The date that the user was updated type: string format: date-time usergroups: description: Groups linked to this user. Can only be retrieved by the owner, admin or promoted users. type: object properties: href: type: string format: link userName: description: Unique name of the user within the organization type: string userpermission: description: The User Permission linked to this user type: object properties: id: type: string href: type: string format: link userType: description: Type of user type: string scimId: description: External id for scim integration type: - string - 'null' href: description: External id for scim integration type: string bccAddresses: description: BCC addresses type: array items: type: string collectionsVersion: description: The version of the user's collections type: integer consentGiven: description: If the current privacy policy was approved by the user type: - boolean - 'null' consentRequired: description: Whether or not the user should give consent (again) type: boolean isPromotedMember: description: Indicated whether or not the user has active promoted memberships type: boolean lastUsedDevice: type: object properties: href: description: The URL to access the resource type: string id: type: string description: the resource identifier password: description: Password of the user (If no password is given, an invitation mail will be send unless it is specifically specified not to send a mail) type: string promotedDivisions: type: object properties: href: description: The URL to access the resource type: string sendMailToUser: description: Allows overwriting the default user activation email behavior. Can only be used by the owner, admin or promoted users. type: boolean provisionedBy: description: "Indicate how this user was provisioned. Can only be used by the owner, admin or promoted users.\nWhen the provisionedBy field is set to scim2.0, the reference ID can optionally be found in the scimId field. \nOther provisioning methods will have the externalId field populated.\nsftp, sfns and scim2.0 are currently reserved for Showpad owned provisioning mechanisms.\n" type: string managerId: description: ID of the direct manager. Can only be used by the owner, admin or promoted users. type: - string - 'null' uuid: description: Uuid of the user type: - string - 'null' security: - bearerAuth: [] - oAuth: - read_contentprofile_management - read_user_management parameters: - name: id description: ID of the Channel item required: true in: path 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: email description: Email of the user required: false in: query schema: type: string - name: emailNotifications description: Set to true if the user will receive email notifications for activities performed by recipients 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: externalId description: External ID of the user 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: firstName description: First name of the user required: false in: query schema: type: string - name: isActive description: Indicates whether a user is active required: false in: query schema: type: boolean - name: isAnonymized description: Show that user is anonymized required: false in: query schema: type: boolean - name: isInvited description: Shows that user is invited required: false in: query schema: type: boolean - name: isSynced description: Shows that user is synced required: false in: query schema: type: boolean - name: language description: The user's language required: false in: query schema: type: string - name: lastName description: Last name of the user required: false in: query schema: type: string - 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: 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: productLicenseContent description: Show user's productLicenseContent required: false in: query schema: type: string - name: productLicenseTrainingCoaching description: Show user's productLicenseTrainingCoaching required: false in: query schema: type: string - name: scimId description: External id for scim integration required: false in: query schema: type: string - name: sort description: The field you want to sort on. Adding a '-' in front of the field name allows you to sort descending. 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: userName description: Unique name of the user within the organization required: false in: query schema: type: string - name: userType description: Type of user required: false in: query schema: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string post: deprecated: false tags: - channels operationId: post_channels_id_users description: Add a user to the channel with ID='id' summary: /channels/{id}/users.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 apiKey: description: The API key of the user type: - string - 'null' avatar: description: The Avatar linked to this user type: - string - 'null' format: link companyName: description: User's company name type: string companyRole: description: User's company role type: - string - 'null' consentGivenAt: description: The date at which the user consented to the current privacy policy type: - string - 'null' format: date consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: - string - 'null' createdAt: description: The date that the user was created type: string format: date-time divisionpermissions: description: The Division Permissions linked to this user type: - string - 'null' format: link email: description: Email of the user type: string emailNotifications: description: Set to true if the user will receive email notifications for activities performed by recipients type: boolean emailSignature: description: User's email signature type: - string - 'null' externalId: description: External ID of the user as used in the source application. Can only be used by the owner, admin or promoted users. type: - string - 'null' firstName: description: First name of the user type: string forcePasswordReset: description: 'Determines whether a user should change their password on first login after having had their password reset. When provided without a password, this value will be ignored.' type: boolean ftueStatus: description: FTUE dialogs acknowledged by the user type: - string - 'null' insightsLastViewedAt: description: Last time Showpad Insights was viewed type: - string - 'null' format: date invitationConfirmedAt: description: Confirmation date of the initial user invitation type: - string - 'null' format: date-time isActive: description: Indicates whether a user is active type: boolean isAnonymized: description: Show that user is anonymized. Can only be used by the owner, admin or promoted users. type: boolean isInvited: description: Shows that user is invited. Can only be used by the owner, admin or promoted users. type: boolean isPasswordSet: description: Indicates if user password is set type: boolean isSynced: description: Shows that user is synced. Can only be used by the owner, admin or promoted users. type: boolean isTrainingCoachingManager: description: Shows whether the user training coaching manager is or not type: boolean language: description: The user's language type: string lastConfirmedContentUpdate: description: The date the user last updated his content type: - string - 'null' format: date lastInvitationSentAt: description: Date of the last sent invitation email type: - string - 'null' format: date-time lastInvitationStatus: description: Status of the last sent invitation email type: - string - 'null' lastLogin: description: The date the user last logged in type: - string - 'null' format: date lastName: description: Last name of the user type: string managedUsergroups: description: A list of usergroups managed by the user. Can only be used by the owner, admin or promoted users. type: - string - 'null' format: link multiPillarNavigation: description: Indicates whether the multi pillar navigation is enabled type: boolean myUploadsCollectionId: description: ID of the uploads collection for this user type: string myUploadsDivisionId: description: ID of the my uploads channel for this user type: string personalContentFileSizeUsed: description: Total used space for this user's My Uploads section type: integer format: int32 personalContentIndividualFileSizeLimit: description: Limit of a My Uploads upload for this user type: integer format: int64 personalContentTotalFileSizeLimit: description: Limit of this user's My Uploads quote type: integer format: int64 isPersonalContentTotalUnlimited: description: Should the personal storage limit be interpreted as unlimited? type: boolean phone: description: User's phone number type: - string - 'null' productLicenseContent: description: Show user's productLicenseContent type: string productLicenseTrainingCoaching: description: Show user's productLicenseTrainingCoaching type: string timezone: description: "User timezone (or company timezone if not specified). Must be a tz database identifier i.e. Country/City. \nIf the city part contains multiple words it must be split by underscores i.e. America/New_York.\n" type: string updatedAt: description: The date that the user was updated type: string format: date-time usergroups: description: Groups linked to this user. Can only be retrieved by the owner, admin or promoted users. type: object properties: href: type: string format: link userName: description: Unique name of the user within the organization type: string userpermission: description: The User Permission linked to this user type: object properties: id: type: string href: type: string format: link userType: description: Type of user type: string scimId: description: External id for scim integration type: - string - 'null' href: description: External id for scim integration type: string bccAddresses: description: BCC addresses type: array items: type: string collectionsVersion: description: The version of the user's collections type: integer consentGiven: description: If the current privacy policy was approved by the user type: - boolean - 'null' consentRequired: description: Whether or not the user should give consent (again) type: boolean isPromotedMember: description: Indicated whether or not the user has active promoted memberships type: boolean lastUsedDevice: type: object properties: href: description: The URL to access the resource type: string id: type: string description: the resource identifier password: description: Password of the user (If no password is given, an invitation mail will be send unless it is specifically specified not to send a mail) type: string promotedDivisions: type: object properties: href: description: The URL to access the resource type: string sendMailToUser: description: Allows overwriting the default user activation email behavior. Can only be used by the owner, admin or promoted users. type: boolean provisionedBy: description: "Indicate how this user was provisioned. Can only be used by the owner, admin or promoted users.\nWhen the provisionedBy field is set to scim2.0, the reference ID can optionally be found in the scimId field. \nOther provisioning methods will have the externalId field populated.\nsftp, sfns and scim2.0 are currently reserved for Showpad owned provisioning mechanisms.\n" type: string managerId: description: ID of the direct manager. Can only be used by the owner, admin or promoted users. type: - string - 'null' uuid: description: Uuid of the user type: - string - 'null' security: - bearerAuth: [] - oAuth: - write_contentprofile_management - write_user_management parameters: - name: id description: ID of the Channel item required: true in: path 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: 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: email: type: string firstName: type: string isActive: type: boolean language: type: string lastName: type: string userName: type: string bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean emailNotifications: type: boolean emailSignature: type: string externalId: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean sha512PasswordHash: type: string timezone: type: string userType: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string required: - email - firstName - isActive - language - lastName - userName application/json: schema: type: object properties: email: type: string firstName: type: string isActive: type: boolean language: type: string lastName: type: string userName: type: string bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean emailNotifications: type: boolean emailSignature: type: string externalId: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean sha512PasswordHash: type: string timezone: type: string userType: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string required: - email - firstName - isActive - language - lastName - userName components: securitySchemes: bearerAuth: type: http scheme: bearer description: This is the Bearer token to identify the current requesting user. Please check out this [page](https://docs.api.showpad.com/docs/apis/concepts/authentication) for a more in-depth explanation on Showpad authentication. oAuth: type: oauth2 flows: password: tokenUrl: https://{customer}.showpad.biz/api/v3/oauth2/token scopes: refresh_token: Allows the refresh of access tokens. read_user_management: Allows read access for user data (includes users, usergroups and user permissions). write_user_management: Allows write access for user data (includes users, usergroups and user permissions). read_contentprofile_management: Allows read access for content profile-related resources (content profiles, assets, tags, tickets and comments). write_contentprofile_management: Allows write access for content profile-related resources (content profiles, assets, tags, tickets and comments). read_division_management: Allows read access for division-related resources (divisions and division permissions). write_division_management: Allows write accesss for division-related resources (divisions and division permissions). authorizationCode: authorizationUrl: https://{customer}.showpad.biz/api/v3/oauth2/authorize tokenUrl: https://{customer}.showpad.biz/api/v3/oauth2/token refresh_token: Allows the refresh of access tokens. scopes: read_user_management: Allows read access for user data (includes users, usergroups and user permissions). write_user_management: Allows write access for user data (includes users, usergroups and user permissions). read_contentprofile_management: Allows read access for content profile-related resources (content profiles, assets, tags, tickets and comments). write_contentprofile_management: Allows write access for content profile-related resources (content profiles, assets, tags, tickets and comments). read_division_management: Allows read access for division-related resources (divisions and division permissions). write_division_management: Allows write accesss for division-related resources (divisions and division permissions).