openapi: 3.0.3 info: title: Showpad 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 tags: - name: assets description: '' - name: channels description: '' - name: comments description: '' - name: divisionpermissions description: '' - name: divisions description: '' - name: exports description: '' - name: generic description: '' - name: recommendations description: '' - name: tags description: '' - name: tickets description: '' - name: usergroups description: '' - name: userpermissions description: '' - name: users description: '' paths: /assets.json: get: deprecated: true tags: - assets operationId: get_assets description: |- Generates a list of Asset items. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getAssets). summary: /assets.json security: - bearerAuth: [] - oAuth: - read_contentprofile_management 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 nullable: true 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 nullable: true shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: string nullable: true shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: integer format: int32 nullable: true externalId: description: External ID of the asset as used in the source application type: string nullable: true 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 nullable: true 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 nullable: true format: date archivedAt: description: The date that the file was sent to trash type: string nullable: true format: date expiresAt: description: The expiry date of the asset type: string nullable: true format: date releasedAt: description: The release date of the asset type: string nullable: true format: date draftedAt: description: The draft date of the asset type: string nullable: true format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: array nullable: true items: type: string pageCount: description: 'The number of pages the document has, if applicable' type: integer nullable: true 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 nullable: true currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: string nullable: true format: link channelTemplateConfigId: description: Channel template config ID type: string nullable: true 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 nullable: true 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 nullable: true format: int32 duration: description: Duration of the media type: integer nullable: true format: int32 wordCount: description: 'The number of words the asset contains, if applicable' type: integer nullable: true 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 nullable: true items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: array nullable: true items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: string nullable: true fileUuid: description: The Uuid of the current file type: string nullable: true 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 nullable: true oAuth2ClientId: description: The OAuth2 client that can manage the asset via an external service type: string parameters: - 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 post: deprecated: true tags: - assets operationId: post_assets description: |- Create a Asset item. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/postAssets) or this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/postAssetFiles). summary: /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: 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 nullable: true 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 nullable: true shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: string nullable: true shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: integer format: int32 nullable: true externalId: description: External ID of the asset as used in the source application type: string nullable: true 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 nullable: true 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 nullable: true format: date archivedAt: description: The date that the file was sent to trash type: string nullable: true format: date expiresAt: description: The expiry date of the asset type: string nullable: true format: date releasedAt: description: The release date of the asset type: string nullable: true format: date draftedAt: description: The draft date of the asset type: string nullable: true format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: array nullable: true items: type: string pageCount: description: 'The number of pages the document has, if applicable' type: integer nullable: true 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 nullable: true currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: string nullable: true format: link channelTemplateConfigId: description: Channel template config ID type: string nullable: true 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 nullable: true 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 nullable: true format: int32 duration: description: Duration of the media type: integer nullable: true format: int32 wordCount: description: 'The number of words the asset contains, if applicable' type: integer nullable: true 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 nullable: true items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: array nullable: true items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: string nullable: true fileUuid: description: The Uuid of the current file type: string nullable: true 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 nullable: true oAuth2ClientId: description: The OAuth2 client that can manage the asset via an external service type: string 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: multipart/form-data: schema: type: object properties: channelTemplateConfigId: type: string description: type: string expiresAt: type: string format: date externalDate: type: string format: date externalId: type: string externalServiceId: type: string file: type: string format: binary filetype: 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 hideLabel: type: boolean icon: type: string format: binary isAnnotatable: type: boolean isDivisionShared: type: boolean isDownloadable: type: boolean isEditable: type: boolean isPersonal: type: boolean isSensitive: type: boolean isShareable: type: boolean liked: type: boolean lockedPages: type: array items: type: string name: type: string oAuth2ClientId: type: string onlyShareEntireDocument: type: boolean postProcessingInstructions: type: string releasedAt: type: string format: date draftedAt: type: string format: date slug: type: string url: type: string useOptimized: type: boolean /assets/count.json: get: deprecated: false tags: - assets operationId: get_assets_count description: Retrieve the number of Asset items summary: /assets/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 security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - 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: 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: 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: lockedPages description: The pages that are locked together in this asset required: false in: query schema: type: array items: type: string - name: name description: Display name of the file required: false in: query schema: type: string - 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: 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 /assets/description.json: get: deprecated: false tags: - assets operationId: get_assets_description description: Generates information about the Asset model and available apis summary: /assets/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 '/assets/{id1}/tags/{id2}.json': get: deprecated: true tags: - assets operationId: get_assets_id1_tags_id2 description: |- Link or unlink an asset with ID = 'id1' to a tag with ID = 'id2'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateAsset). summary: '/assets/{id1}/tags/{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 parameters: - name: id1 description: ID of the Asset item required: true in: path schema: type: string - name: id2 description: ID of the Tag 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 '/assets/{id1}/tags/{id2}/link.json': post: deprecated: true tags: - assets operationId: link_assets_id1_tags_id2_link description: |- Link an asset with ID = 'id1' to a tag with ID = 'id2'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateAsset). summary: '/assets/{id1}/tags/{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 parameters: - name: id1 description: ID of the Asset item required: true in: path schema: type: string - name: id2 description: ID of the Tag 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 '/assets/{id1}/tags/{id2}/unlink.json': post: deprecated: true tags: - assets operationId: unlink_assets_id1_tags_id2_unlink description: |- Unlink an asset with ID = 'id1' from a tag with ID = 'id2'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateAsset). summary: '/assets/{id1}/tags/{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 parameters: - name: id1 description: ID of the Asset item required: true in: path schema: type: string - name: id2 description: ID of the Tag 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 '/assets/{id}.json': get: deprecated: true tags: - assets operationId: get_assets_id description: |- Retrieve Asset item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getAsset). summary: '/assets/{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 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 nullable: true 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 nullable: true shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: string nullable: true shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: integer format: int32 nullable: true externalId: description: External ID of the asset as used in the source application type: string nullable: true 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 nullable: true 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 nullable: true format: date archivedAt: description: The date that the file was sent to trash type: string nullable: true format: date expiresAt: description: The expiry date of the asset type: string nullable: true format: date releasedAt: description: The release date of the asset type: string nullable: true format: date draftedAt: description: The draft date of the asset type: string nullable: true format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: array nullable: true items: type: string pageCount: description: 'The number of pages the document has, if applicable' type: integer nullable: true 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 nullable: true currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: string nullable: true format: link channelTemplateConfigId: description: Channel template config ID type: string nullable: true 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 nullable: true 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 nullable: true format: int32 duration: description: Duration of the media type: integer nullable: true format: int32 wordCount: description: 'The number of words the asset contains, if applicable' type: integer nullable: true 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 nullable: true items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: array nullable: true items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: string nullable: true fileUuid: description: The Uuid of the current file type: string nullable: true 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 nullable: true 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 Asset 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: 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: - assets operationId: put_assets_id description: Update the Asset item with ID='id' summary: '/assets/{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 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 nullable: true 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 nullable: true shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: string nullable: true shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: integer format: int32 nullable: true externalId: description: External ID of the asset as used in the source application type: string nullable: true 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 nullable: true 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 nullable: true format: date archivedAt: description: The date that the file was sent to trash type: string nullable: true format: date expiresAt: description: The expiry date of the asset type: string nullable: true format: date releasedAt: description: The release date of the asset type: string nullable: true format: date draftedAt: description: The draft date of the asset type: string nullable: true format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: array nullable: true items: type: string pageCount: description: 'The number of pages the document has, if applicable' type: integer nullable: true 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 nullable: true currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: string nullable: true format: link channelTemplateConfigId: description: Channel template config ID type: string nullable: true 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 nullable: true 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 nullable: true format: int32 duration: description: Duration of the media type: integer nullable: true format: int32 wordCount: description: 'The number of words the asset contains, if applicable' type: integer nullable: true 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 nullable: true items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: array nullable: true items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: string nullable: true fileUuid: description: The Uuid of the current file type: string nullable: true 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 nullable: true oAuth2ClientId: description: The OAuth2 client that can manage the asset via an external service type: string security: - bearerAuth: [] - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Asset 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 - 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: description: type: string expiresAt: type: string format: date externalDate: type: string format: date externalId: type: string externalServiceId: type: string file: type: string format: binary filetype: 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 hideLabel: type: boolean icon: type: string format: binary isAnnotatable: type: boolean isDivisionShared: type: boolean isDownloadable: type: boolean isEditable: type: boolean isPersonal: type: boolean isSensitive: type: boolean isShareable: type: boolean liked: type: boolean lockedPages: type: array items: type: string name: type: string oAuth2ClientId: type: string onlyShareEntireDocument: type: boolean releasedAt: type: string format: date draftedAt: type: string format: date url: type: string useOptimized: type: boolean post: deprecated: true tags: - assets operationId: post_assets_id description: |- Update the Asset item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateAsset). summary: '/assets/{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 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 nullable: true 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 nullable: true shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: string nullable: true shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: integer format: int32 nullable: true externalId: description: External ID of the asset as used in the source application type: string nullable: true 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 nullable: true 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 nullable: true format: date archivedAt: description: The date that the file was sent to trash type: string nullable: true format: date expiresAt: description: The expiry date of the asset type: string nullable: true format: date releasedAt: description: The release date of the asset type: string nullable: true format: date draftedAt: description: The draft date of the asset type: string nullable: true format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: array nullable: true items: type: string pageCount: description: 'The number of pages the document has, if applicable' type: integer nullable: true 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 nullable: true currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: string nullable: true format: link channelTemplateConfigId: description: Channel template config ID type: string nullable: true 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 nullable: true 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 nullable: true format: int32 duration: description: Duration of the media type: integer nullable: true format: int32 wordCount: description: 'The number of words the asset contains, if applicable' type: integer nullable: true 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 nullable: true items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: array nullable: true items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: string nullable: true fileUuid: description: The Uuid of the current file type: string nullable: true 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 nullable: true oAuth2ClientId: description: The OAuth2 client that can manage the asset via an external service type: string security: - bearerAuth: [] - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Asset 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 - 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: multipart/form-data: schema: type: object properties: description: type: string expiresAt: type: string format: date externalDate: type: string format: date externalId: type: string externalServiceId: type: string file: type: string format: binary filetype: 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 hideLabel: type: boolean icon: type: string format: binary isAnnotatable: type: boolean isDivisionShared: type: boolean isDownloadable: type: boolean isEditable: type: boolean isPersonal: type: boolean isSensitive: type: boolean isShareable: type: boolean liked: type: boolean lockedPages: type: array items: type: string name: type: string oAuth2ClientId: type: string onlyShareEntireDocument: type: boolean releasedAt: type: string format: date draftedAt: type: string format: date url: type: string useOptimized: type: boolean delete: deprecated: true tags: - assets operationId: delete_assets_id description: |- Delete the Asset item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/deleteAsset). summary: '/assets/{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 Asset 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 '/assets/{id}/comments.json': get: deprecated: false tags: - assets operationId: get_assets_id_comments description: Get all comments that belong to the asset with ID='id' summary: '/assets/{id}/comments.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 createdAt: description: The date that the comment was created type: string format: date division: description: The division this comment resides in type: string format: link externalId: description: External ID of the comment as used in the source application type: string isUnregisteredUserComment: description: Indicates whether this comment is made by an unregistered user type: boolean message: description: The message of the comment type: string parent: description: The resource this comment is given on type: string format: link parentType: description: The type of resource this comment is given on type: string unregisteredUserFirstName: description: First Name of the unregistered user type: string unregisteredUserLastName: description: Last Name of the unregistered user type: string updatedAt: description: The date that the comment was updated type: string format: date user: description: The user that created this comment type: string format: link parentMobileApiId: description: Element ID in mobile-API format (e.g. ph-125) type: string asset: description: The asset linked to this comment type: string format: link collectionItem: description: The collection item linked to this comment type: string format: link share: description: The share linked to this comment type: string format: link comment: description: The parent comment linked to this comment type: string format: link security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: id description: ID of the Asset item required: true in: path schema: type: string - name: createdSince description: Filter comments on createdAt greater than or equal to this value 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 comment 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: isUnregisteredUserComment description: Indicates whether this comment is made by an unregistered user 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: 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. 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: unregisteredUserFirstName description: First Name of the unregistered user required: false in: query schema: type: string - name: unregisteredUserLastName description: Last Name of the unregistered user required: false in: query schema: type: string post: deprecated: false tags: - assets operationId: post_assets_id_comments description: Add a comment to the asset with ID='id' summary: '/assets/{id}/comments.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 createdAt: description: The date that the comment was created type: string format: date division: description: The division this comment resides in type: string format: link externalId: description: External ID of the comment as used in the source application type: string isUnregisteredUserComment: description: Indicates whether this comment is made by an unregistered user type: boolean message: description: The message of the comment type: string parent: description: The resource this comment is given on type: string format: link parentType: description: The type of resource this comment is given on type: string unregisteredUserFirstName: description: First Name of the unregistered user type: string unregisteredUserLastName: description: Last Name of the unregistered user type: string updatedAt: description: The date that the comment was updated type: string format: date user: description: The user that created this comment type: string format: link parentMobileApiId: description: Element ID in mobile-API format (e.g. ph-125) type: string asset: description: The asset linked to this comment type: string format: link collectionItem: description: The collection item linked to this comment type: string format: link share: description: The share linked to this comment type: string format: link comment: description: The parent comment linked to this comment type: string format: link security: - bearerAuth: [] - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Asset 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: message: type: string externalId: type: string isUnregisteredUserComment: type: boolean unregisteredUserFirstName: type: string unregisteredUserLastName: type: string required: - message application/json: schema: type: object properties: message: type: string externalId: type: string isUnregisteredUserComment: type: boolean unregisteredUserFirstName: type: string unregisteredUserLastName: type: string required: - message '/assets/{id}/link.json': post: deprecated: true tags: - assets operationId: link_assets_id_link description: |- Link the Asset item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateAsset). summary: '/assets/{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 Asset 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 '/assets/{id}/tags.json': get: deprecated: false tags: - assets operationId: get_assets_id_tags description: Get all tags that belong to the asset with ID='id' summary: '/assets/{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 resourcetype: description: The type of resource type: string href: description: Url link to the tag type: string assets: description: The assets linked to this tag type: object properties: href: type: string format: link type: description: The type of tag type: string createdAt: description: The date that the tag was created type: string format: date-time description: description: Description of the tag type: string division: description: The division of the tag type: object properties: href: type: string format: link id: type: string divisionId: description: The division ID of the tag type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true name: description: Name of the tag type: string updatedAt: description: The date that the tag was updated type: string format: date-time externalService: description: External Service of the tag as used in the source application type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: id description: ID of the Asset 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 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: 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 tag 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. 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: - assets operationId: post_assets_id_tags description: Add a tag to the asset with ID='id' summary: '/assets/{id}/tags.json' responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object location: type: string nullable: true 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: Url link to the tag type: string assets: description: The assets linked to this tag type: object properties: href: type: string format: link type: description: The type of tag type: string createdAt: description: The date that the tag was created type: string format: date-time description: description: Description of the tag type: string division: description: The division of the tag type: object properties: href: type: string format: link id: type: string divisionId: description: The division ID of the tag type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true name: description: Name of the tag type: string updatedAt: description: The date that the tag was updated type: string format: date-time externalService: description: External Service of the tag as used in the source application type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Asset 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 description: type: string divisionId: type: string externalId: type: string required: - name application/json: schema: type: object properties: name: type: string description: type: string divisionId: type: string externalId: type: string required: - name '/assets/{id}/unlink.json': post: deprecated: true tags: - assets operationId: unlink_assets_id_unlink description: |- Link the Asset item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateAsset). summary: '/assets/{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 Asset 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.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 format: link nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true properties: id: type: string href: type: string format: link currentTemplateAsset: description: The template app linked to this channel type: string format: link nullable: true 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 nullable: true 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 format: date-time nullable: true logo: description: The logo image linked to this channel type: string format: link nullable: true 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 nullable: true 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 nullable: true 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 format: link nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true properties: id: type: string href: type: string format: link currentTemplateAsset: description: The template app linked to this channel type: string format: link nullable: true 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 nullable: true 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 format: date-time nullable: true logo: description: The logo image linked to this channel type: string format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 description: The template app linked to this channel nullable: true 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 nullable: true 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 nullable: true shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: string nullable: true shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: integer format: int32 nullable: true externalId: description: External ID of the asset as used in the source application type: string nullable: true 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 nullable: true 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 nullable: true format: date archivedAt: description: The date that the file was sent to trash type: string nullable: true format: date expiresAt: description: The expiry date of the asset type: string nullable: true format: date releasedAt: description: The release date of the asset type: string nullable: true format: date draftedAt: description: The draft date of the asset type: string nullable: true format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: array nullable: true items: type: string pageCount: description: 'The number of pages the document has, if applicable' type: integer nullable: true 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 nullable: true currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: string nullable: true format: link channelTemplateConfigId: description: Channel template config ID type: string nullable: true 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 nullable: true 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 nullable: true format: int32 duration: description: Duration of the media type: integer nullable: true format: int32 wordCount: description: 'The number of words the asset contains, if applicable' type: integer nullable: true 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 nullable: true items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: array nullable: true items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: string nullable: true fileUuid: description: The Uuid of the current file type: string nullable: true 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 nullable: true 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 format: link nullable: true 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 format: link nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true properties: id: type: string href: type: string format: link currentTemplateAsset: description: The template app linked to this channel type: string format: link nullable: true 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 nullable: true 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 format: date-time nullable: true logo: description: The logo image linked to this channel type: string format: link nullable: true 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 nullable: true 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 nullable: true 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 format: link nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true properties: id: type: string href: type: string format: link currentTemplateAsset: description: The template app linked to this channel type: string format: link nullable: true 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 nullable: true 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 format: date-time nullable: true logo: description: The logo image linked to this channel type: string format: link nullable: true 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 nullable: true 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 nullable: true 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 format: link nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true properties: id: type: string href: type: string format: link currentTemplateAsset: description: The template app linked to this channel type: string format: link nullable: true 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 nullable: true 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 format: date-time nullable: true logo: description: The logo image linked to this channel type: string format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: string nullable: true shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: integer format: int32 nullable: true externalId: description: External ID of the asset as used in the source application type: string nullable: true 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 nullable: true 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 nullable: true format: date archivedAt: description: The date that the file was sent to trash type: string nullable: true format: date expiresAt: description: The expiry date of the asset type: string nullable: true format: date releasedAt: description: The release date of the asset type: string nullable: true format: date draftedAt: description: The draft date of the asset type: string nullable: true format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: array nullable: true items: type: string pageCount: description: 'The number of pages the document has, if applicable' type: integer nullable: true 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 nullable: true currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: string nullable: true format: link channelTemplateConfigId: description: Channel template config ID type: string nullable: true 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 nullable: true 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 nullable: true format: int32 duration: description: Duration of the media type: integer nullable: true format: int32 wordCount: description: 'The number of words the asset contains, if applicable' type: integer nullable: true 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 nullable: true items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: array nullable: true items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: string nullable: true fileUuid: description: The Uuid of the current file type: string nullable: true 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 nullable: true 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 format: link nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true properties: id: type: string href: type: string format: link currentTemplateAsset: description: The template app linked to this channel type: string format: link nullable: true 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 nullable: true 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 format: date-time nullable: true logo: description: The logo image linked to this channel type: string format: link nullable: true 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 nullable: true 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 nullable: true 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 format: link nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true properties: id: type: string href: type: string format: link currentTemplateAsset: description: The template app linked to this channel type: string format: link nullable: true 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 nullable: true 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 format: date-time nullable: true logo: description: The logo image linked to this channel type: string format: link nullable: true 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 nullable: true 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 nullable: true 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 format: link nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true properties: id: type: string href: type: string format: link currentTemplateAsset: description: The template app linked to this channel type: string format: link nullable: true 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 nullable: true 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 format: date-time nullable: true logo: description: The logo image linked to this channel type: string format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true 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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true 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 nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true 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 nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true 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 /comments.json: get: deprecated: false tags: - comments operationId: get_comments description: Generates a list of Comment items summary: /comments.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 comment was created type: string format: date division: description: The division this comment resides in type: string format: link externalId: description: External ID of the comment as used in the source application type: string isUnregisteredUserComment: description: Indicates whether this comment is made by an unregistered user type: boolean message: description: The message of the comment type: string parent: description: The resource this comment is given on type: string format: link parentType: description: The type of resource this comment is given on type: string unregisteredUserFirstName: description: First Name of the unregistered user type: string unregisteredUserLastName: description: Last Name of the unregistered user type: string updatedAt: description: The date that the comment was updated type: string format: date user: description: The user that created this comment type: string format: link parentMobileApiId: description: Element ID in mobile-API format (e.g. ph-125) type: string asset: description: The asset linked to this comment type: string format: link collectionItem: description: The collection item linked to this comment type: string format: link share: description: The share linked to this comment type: string format: link comment: description: The parent comment linked to this comment type: string format: link security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: createdSince description: Filter comments on createdAt greater than or equal to this value 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 comment 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: isUnregisteredUserComment description: Indicates whether this comment is made by an unregistered user 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: 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. 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: unregisteredUserFirstName description: First Name of the unregistered user required: false in: query schema: type: string - name: unregisteredUserLastName description: Last Name of the unregistered user required: false in: query schema: type: string post: deprecated: false tags: - comments operationId: post_comments description: Create a Comment item summary: /comments.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 createdAt: description: The date that the comment was created type: string format: date division: description: The division this comment resides in type: string format: link externalId: description: External ID of the comment as used in the source application type: string isUnregisteredUserComment: description: Indicates whether this comment is made by an unregistered user type: boolean message: description: The message of the comment type: string parent: description: The resource this comment is given on type: string format: link parentType: description: The type of resource this comment is given on type: string unregisteredUserFirstName: description: First Name of the unregistered user type: string unregisteredUserLastName: description: Last Name of the unregistered user type: string updatedAt: description: The date that the comment was updated type: string format: date user: description: The user that created this comment type: string format: link parentMobileApiId: description: Element ID in mobile-API format (e.g. ph-125) type: string asset: description: The asset linked to this comment type: string format: link collectionItem: description: The collection item linked to this comment type: string format: link share: description: The share linked to this comment type: string format: link comment: description: The parent comment linked to this comment 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: message: type: string externalId: type: string isUnregisteredUserComment: type: boolean unregisteredUserFirstName: type: string unregisteredUserLastName: type: string required: - message application/json: schema: type: object properties: message: type: string externalId: type: string isUnregisteredUserComment: type: boolean unregisteredUserFirstName: type: string unregisteredUserLastName: type: string required: - message /comments/count.json: get: deprecated: false tags: - comments operationId: get_comments_count description: Retrieve the number of Comment items summary: /comments/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 security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: createdSince description: Filter comments on createdAt greater than or equal to this value 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: externalId description: External ID of the comment as used in the source application required: false in: query schema: type: string - name: isUnregisteredUserComment description: Indicates whether this comment is made by an unregistered 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: unregisteredUserFirstName description: First Name of the unregistered user required: false in: query schema: type: string - name: unregisteredUserLastName description: Last Name of the unregistered user required: false in: query schema: type: string /comments/description.json: get: deprecated: false tags: - comments operationId: get_comments_description description: Generates information about the Comment model and available apis summary: /comments/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 '/comments/{id}.json': get: deprecated: false tags: - comments operationId: get_comments_id description: Retrieve Comment item with ID='id' summary: '/comments/{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 createdAt: description: The date that the comment was created type: string format: date division: description: The division this comment resides in type: string format: link externalId: description: External ID of the comment as used in the source application type: string isUnregisteredUserComment: description: Indicates whether this comment is made by an unregistered user type: boolean message: description: The message of the comment type: string parent: description: The resource this comment is given on type: string format: link parentType: description: The type of resource this comment is given on type: string unregisteredUserFirstName: description: First Name of the unregistered user type: string unregisteredUserLastName: description: Last Name of the unregistered user type: string updatedAt: description: The date that the comment was updated type: string format: date user: description: The user that created this comment type: string format: link parentMobileApiId: description: Element ID in mobile-API format (e.g. ph-125) type: string asset: description: The asset linked to this comment type: string format: link collectionItem: description: The collection item linked to this comment type: string format: link share: description: The share linked to this comment type: string format: link comment: description: The parent comment linked to this comment type: string format: link security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: id description: ID of the Comment 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: 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: - comments operationId: put_comments_id description: Update the Comment item with ID='id' summary: '/comments/{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 createdAt: description: The date that the comment was created type: string format: date division: description: The division this comment resides in type: string format: link externalId: description: External ID of the comment as used in the source application type: string isUnregisteredUserComment: description: Indicates whether this comment is made by an unregistered user type: boolean message: description: The message of the comment type: string parent: description: The resource this comment is given on type: string format: link parentType: description: The type of resource this comment is given on type: string unregisteredUserFirstName: description: First Name of the unregistered user type: string unregisteredUserLastName: description: Last Name of the unregistered user type: string updatedAt: description: The date that the comment was updated type: string format: date user: description: The user that created this comment type: string format: link parentMobileApiId: description: Element ID in mobile-API format (e.g. ph-125) type: string asset: description: The asset linked to this comment type: string format: link collectionItem: description: The collection item linked to this comment type: string format: link share: description: The share linked to this comment type: string format: link comment: description: The parent comment linked to this comment type: string format: link security: - bearerAuth: [] - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Comment 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 - 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: externalId: type: string isUnregisteredUserComment: type: boolean message: type: string unregisteredUserFirstName: type: string unregisteredUserLastName: type: string application/json: schema: type: object properties: externalId: type: string isUnregisteredUserComment: type: boolean message: type: string unregisteredUserFirstName: type: string unregisteredUserLastName: type: string post: deprecated: false tags: - comments operationId: post_comments_id description: Update the Comment item with ID='id' summary: '/comments/{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 createdAt: description: The date that the comment was created type: string format: date division: description: The division this comment resides in type: string format: link externalId: description: External ID of the comment as used in the source application type: string isUnregisteredUserComment: description: Indicates whether this comment is made by an unregistered user type: boolean message: description: The message of the comment type: string parent: description: The resource this comment is given on type: string format: link parentType: description: The type of resource this comment is given on type: string unregisteredUserFirstName: description: First Name of the unregistered user type: string unregisteredUserLastName: description: Last Name of the unregistered user type: string updatedAt: description: The date that the comment was updated type: string format: date user: description: The user that created this comment type: string format: link parentMobileApiId: description: Element ID in mobile-API format (e.g. ph-125) type: string asset: description: The asset linked to this comment type: string format: link collectionItem: description: The collection item linked to this comment type: string format: link share: description: The share linked to this comment type: string format: link comment: description: The parent comment linked to this comment type: string format: link security: - bearerAuth: [] - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Comment 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 - 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: externalId: type: string isUnregisteredUserComment: type: boolean message: type: string unregisteredUserFirstName: type: string unregisteredUserLastName: type: string application/json: schema: type: object properties: externalId: type: string isUnregisteredUserComment: type: boolean message: type: string unregisteredUserFirstName: type: string unregisteredUserLastName: type: string delete: deprecated: false tags: - comments operationId: delete_comments_id description: Delete the Comment item with ID='id' summary: '/comments/{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: [] parameters: - name: id description: ID of the Comment 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 /divisions.json: get: deprecated: true tags: - divisions operationId: get_divisions description: |- Generates a list of Division items. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getDivisions). summary: /divisions.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 assets: description: The assets linked to this division type: object properties: href: type: string format: link comments: description: The comments linked to this division type: object properties: href: type: string format: link channels: description: The channels linked to this division type: object properties: href: type: string format: link createdAt: description: The date that the division was created type: string format: date-time updatedAt: description: The date that the division was updated type: string format: date-time externalId: description: External ID of the tag as used in the source application type: string nullable: true hasDivisionAssetSharingEnabled: description: If the division has enabled assets sharing type: boolean name: description: The name of the division type: string tags: description: The tags linked to this division type: object properties: href: type: string format: link tickets: description: The tickets linked to this division type: object properties: href: type: string format: link usergroups: description: The groups linked to this division type: object properties: href: type: string format: link defaultCatalogSetting: type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - 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 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: hasDivisionAssetSharingEnabled description: If the division has enabled assets sharing 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 division 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: - divisions operationId: post_divisions description: Create a Division item summary: /divisions.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 assets: description: The assets linked to this division type: object properties: href: type: string format: link comments: description: The comments linked to this division type: object properties: href: type: string format: link channels: description: The channels linked to this division type: object properties: href: type: string format: link createdAt: description: The date that the division was created type: string format: date-time updatedAt: description: The date that the division was updated type: string format: date-time externalId: description: External ID of the tag as used in the source application type: string nullable: true hasDivisionAssetSharingEnabled: description: If the division has enabled assets sharing type: boolean name: description: The name of the division type: string tags: description: The tags linked to this division type: object properties: href: type: string format: link tickets: description: The tickets linked to this division type: object properties: href: type: string format: link usergroups: description: The groups linked to this division type: object properties: href: type: string format: link defaultCatalogSetting: type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - write_division_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: name: type: string externalId: type: string hasDivisionAssetSharingEnabled: type: boolean required: - name application/json: schema: type: object properties: name: type: string externalId: type: string hasDivisionAssetSharingEnabled: type: boolean required: - name /divisions/count.json: get: deprecated: false tags: - divisions operationId: get_divisions_count description: Retrieve the number of Division items summary: /divisions/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_division_management parameters: - 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: externalId description: External ID of the tag as used in the source application required: false in: query schema: type: string - name: hasDivisionAssetSharingEnabled description: If the division has enabled assets sharing required: false in: query schema: type: boolean - name: name description: The name of the division 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 /divisions/description.json: get: deprecated: false tags: - divisions operationId: get_divisions_description description: Generates information about the Division model and available apis summary: /divisions/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_division_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 '/divisions/{id1}/usergroups/{id2}.json': get: deprecated: false tags: - divisions operationId: get_divisions_id1_usergroups_id2 description: Link or unlink an division with ID = 'id1' to a usergroup with ID = 'id2' summary: '/divisions/{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 security: - bearerAuth: [] - oAuth: - write_division_management - write_user_management parameters: - name: id1 description: ID of the Division 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 '/divisions/{id1}/usergroups/{id2}/link.json': post: deprecated: false tags: - divisions operationId: link_divisions_id1_usergroups_id2_link description: Link an division with ID = 'id1' to a usergroup with ID = 'id2' summary: '/divisions/{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_division_management - write_user_management parameters: - name: id1 description: ID of the Division 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 '/divisions/{id1}/usergroups/{id2}/unlink.json': post: deprecated: false tags: - divisions operationId: unlink_divisions_id1_usergroups_id2_unlink description: Unlink an division with ID = 'id1' from a usergroup with ID = 'id2' summary: '/divisions/{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_division_management - write_user_management parameters: - name: id1 description: ID of the Division 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 '/divisions/{id}.json': get: deprecated: true tags: - divisions operationId: get_divisions_id description: |- Retrieve Division item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getDivisionById). summary: '/divisions/{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 assets: description: The assets linked to this division type: object properties: href: type: string format: link comments: description: The comments linked to this division type: object properties: href: type: string format: link channels: description: The channels linked to this division type: object properties: href: type: string format: link createdAt: description: The date that the division was created type: string format: date-time updatedAt: description: The date that the division was updated type: string format: date-time externalId: description: External ID of the tag as used in the source application type: string nullable: true hasDivisionAssetSharingEnabled: description: If the division has enabled assets sharing type: boolean name: description: The name of the division type: string tags: description: The tags linked to this division type: object properties: href: type: string format: link tickets: description: The tickets linked to this division type: object properties: href: type: string format: link usergroups: description: The groups linked to this division type: object properties: href: type: string format: link defaultCatalogSetting: type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: id description: ID of the Division 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: 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: - divisions operationId: put_divisions_id description: Update the Division item with ID='id' summary: '/divisions/{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 assets: description: The assets linked to this division type: object properties: href: type: string format: link comments: description: The comments linked to this division type: object properties: href: type: string format: link channels: description: The channels linked to this division type: object properties: href: type: string format: link createdAt: description: The date that the division was created type: string format: date-time updatedAt: description: The date that the division was updated type: string format: date-time externalId: description: External ID of the tag as used in the source application type: string nullable: true hasDivisionAssetSharingEnabled: description: If the division has enabled assets sharing type: boolean name: description: The name of the division type: string tags: description: The tags linked to this division type: object properties: href: type: string format: link tickets: description: The tickets linked to this division type: object properties: href: type: string format: link usergroups: description: The groups linked to this division type: object properties: href: type: string format: link defaultCatalogSetting: type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - write_division_management parameters: - name: id description: ID of the Division 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 - 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: externalId: type: string hasDivisionAssetSharingEnabled: type: boolean name: type: string application/json: schema: type: object properties: externalId: type: string hasDivisionAssetSharingEnabled: type: boolean name: type: string post: deprecated: false tags: - divisions operationId: post_divisions_id description: Update the Division item with ID='id' summary: '/divisions/{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 assets: description: The assets linked to this division type: object properties: href: type: string format: link comments: description: The comments linked to this division type: object properties: href: type: string format: link channels: description: The channels linked to this division type: object properties: href: type: string format: link createdAt: description: The date that the division was created type: string format: date-time updatedAt: description: The date that the division was updated type: string format: date-time externalId: description: External ID of the tag as used in the source application type: string nullable: true hasDivisionAssetSharingEnabled: description: If the division has enabled assets sharing type: boolean name: description: The name of the division type: string tags: description: The tags linked to this division type: object properties: href: type: string format: link tickets: description: The tickets linked to this division type: object properties: href: type: string format: link usergroups: description: The groups linked to this division type: object properties: href: type: string format: link defaultCatalogSetting: type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - write_division_management parameters: - name: id description: ID of the Division 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 - 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: externalId: type: string hasDivisionAssetSharingEnabled: type: boolean name: type: string application/json: schema: type: object properties: externalId: type: string hasDivisionAssetSharingEnabled: type: boolean name: type: string delete: deprecated: false tags: - divisions operationId: delete_divisions_id description: Delete the Division item with ID='id' summary: '/divisions/{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_division_management parameters: - name: id description: ID of the Division 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 '/divisions/{id}/assets.json': get: deprecated: true tags: - divisions operationId: get_divisions_id_assets description: |- Get all assets that belong to the division with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/postAssetsQuery) or this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getAssets). summary: '/divisions/{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 nullable: true 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 nullable: true shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: string nullable: true shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: integer format: int32 nullable: true externalId: description: External ID of the asset as used in the source application type: string nullable: true 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 nullable: true 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 nullable: true format: date archivedAt: description: The date that the file was sent to trash type: string nullable: true format: date expiresAt: description: The expiry date of the asset type: string nullable: true format: date releasedAt: description: The release date of the asset type: string nullable: true format: date draftedAt: description: The draft date of the asset type: string nullable: true format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: array nullable: true items: type: string pageCount: description: 'The number of pages the document has, if applicable' type: integer nullable: true 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 nullable: true currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: string nullable: true format: link channelTemplateConfigId: description: Channel template config ID type: string nullable: true 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 nullable: true 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 nullable: true format: int32 duration: description: Duration of the media type: integer nullable: true format: int32 wordCount: description: 'The number of words the asset contains, if applicable' type: integer nullable: true 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 nullable: true items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: array nullable: true items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: string nullable: true fileUuid: description: The Uuid of the current file type: string nullable: true 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 nullable: true oAuth2ClientId: description: The OAuth2 client that can manage the asset via an external service type: string security: - bearerAuth: [] - oAuth: - read_division_management - read_contentprofile_management parameters: - name: id description: ID of the Division 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 post: deprecated: true tags: - divisions operationId: post_divisions_id_assets description: |- Add an asset to the division with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/postAssets). summary: '/divisions/{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: 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 nullable: true 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 nullable: true shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: string nullable: true shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: integer format: int32 nullable: true externalId: description: External ID of the asset as used in the source application type: string nullable: true 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 nullable: true 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 nullable: true format: date archivedAt: description: The date that the file was sent to trash type: string nullable: true format: date expiresAt: description: The expiry date of the asset type: string nullable: true format: date releasedAt: description: The release date of the asset type: string nullable: true format: date draftedAt: description: The draft date of the asset type: string nullable: true format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: array nullable: true items: type: string pageCount: description: 'The number of pages the document has, if applicable' type: integer nullable: true 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 nullable: true currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: string nullable: true format: link channelTemplateConfigId: description: Channel template config ID type: string nullable: true 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 nullable: true 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 nullable: true format: int32 duration: description: Duration of the media type: integer nullable: true format: int32 wordCount: description: 'The number of words the asset contains, if applicable' type: integer nullable: true 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 nullable: true items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: array nullable: true items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: string nullable: true fileUuid: description: The Uuid of the current file type: string nullable: true 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 nullable: true oAuth2ClientId: description: The OAuth2 client that can manage the asset via an external service type: string security: - bearerAuth: [] - oAuth: - write_division_management - write_contentprofile_management parameters: - name: id description: ID of the Division 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: multipart/form-data: schema: type: object properties: channelTemplateConfigId: type: string description: type: string expiresAt: type: string format: date externalDate: type: string format: date externalId: type: string externalServiceId: type: string file: type: string format: binary filetype: 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 hideLabel: type: boolean icon: type: string format: binary isAnnotatable: type: boolean isDivisionShared: type: boolean isDownloadable: type: boolean isEditable: type: boolean isPersonal: type: boolean isSensitive: type: boolean isShareable: type: boolean liked: type: boolean lockedPages: type: array items: type: string name: type: string oAuth2ClientId: type: string onlyShareEntireDocument: type: boolean postProcessingInstructions: type: string releasedAt: type: string format: date draftedAt: type: string format: date slug: type: string url: type: string useOptimized: type: boolean '/divisions/{id}/comments.json': get: deprecated: false tags: - divisions operationId: get_divisions_id_comments description: Get all comments that belong to the division with ID='id' summary: '/divisions/{id}/comments.json' responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object location: type: string nullable: true 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: Url link to the tag type: string assets: description: The assets linked to this tag type: object properties: href: type: string format: link type: description: The type of tag type: string createdAt: description: The date that the tag was created type: string format: date-time description: description: Description of the tag type: string division: description: The division of the tag type: object properties: href: type: string format: link id: type: string divisionId: description: The division ID of the tag type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true name: description: Name of the tag type: string updatedAt: description: The date that the tag was updated type: string format: date-time externalService: description: External Service of the tag as used in the source application type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - read_division_management - read_contentprofile_management parameters: - name: id description: ID of the Division 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 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: 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 tag 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. 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 '/divisions/{id}/link.json': post: deprecated: true tags: - divisions operationId: link_divisions_id_link description: |- Link the Division item with ID='id' to a user group. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend using a v4 endpoint whenever possible. summary: '/divisions/{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_division_management - write_contentprofile_management parameters: - name: id description: ID of the Division 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 '/divisions/{id}/tags.json': get: deprecated: true tags: - divisions operationId: get_divisions_id_tags description: |- Get all tags that belong to the division with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getTags). summary: '/divisions/{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 resourcetype: description: The type of resource type: string href: description: Url link to the tag type: string assets: description: The assets linked to this tag type: object properties: href: type: string format: link type: description: The type of tag type: string createdAt: description: The date that the tag was created type: string format: date-time description: description: Description of the tag type: string division: description: The division of the tag type: object properties: href: type: string format: link id: type: string divisionId: description: The division ID of the tag type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true name: description: Name of the tag type: string updatedAt: description: The date that the tag was updated type: string format: date-time externalService: description: External Service of the tag as used in the source application type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - read_division_management - read_contentprofile_management parameters: - name: id description: ID of the Division 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: divisionId description: The id of the division 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: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - name: includeNonRequired description: Include non-required jobs 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: 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: onlyCustomerTypes description: Only include asset types which are customer facing required: false in: query schema: type: boolean - name: onlyUnfinished description: Only include jobs which have not finished 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 queuedAt, status.' required: false in: query schema: type: string - name: status description: Current status of the asset required: false in: query schema: type: string anyOf: - title: queued type: string - title: processing type: string - title: completed type: string - title: failed 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: true tags: - divisions operationId: post_divisions_id_tags description: |- Add a tag to the division with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateTag). summary: '/divisions/{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: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string asset: description: The location of the asset type: string format: link completedAt: description: The date processing was completed type: string format: date division: description: The location of the division type: string format: link divisionId: description: The id of the division type: string queuedAt: description: The date the asset was queued for processing type: string format: date startedAt: description: The date Showpad started processing the asset type: string format: date status: description: Current status of the asset type: string user: description: The location of the user responsible for submitting the asset type: string format: link type: description: The type of the ticket resource type: string provisionalAssetId: description: Asset ID that will be used if the file is processed correctly type: string assetFilename: description: The filename of the file that's being processed type: string materialisedPath: description: The materialised path that describes the location of the asset (when available) type: string assetFileType: description: The type of the asset file type: string previewUrl: description: The preview URL for the ticket type: string thumbnailUrl: description: The thumbnail URL for the ticket type: string canBeForceUsed: description: Is the related element allowed to be used on failure of this ticket type: boolean onlyCustomerTypes: description: Only include asset types which are customer facing type: boolean onlyUnfinished: description: Only include jobs which have not finished type: boolean includeNonRequired: description: Include non-required jobs type: boolean security: - bearerAuth: [] - oAuth: - write_division_management - write_contentprofile_management parameters: - name: id description: ID of the Division 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: divisionId: type: string type: type: string required: - divisionId - type application/json: schema: type: object properties: divisionId: type: string type: type: string required: - divisionId - type '/divisions/{id}/tickets.json': get: deprecated: false tags: - divisions operationId: get_divisions_id_tickets description: Get all tickets that belong to the division with ID='id' summary: '/divisions/{id}/tickets.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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true security: - bearerAuth: [] - oAuth: - read_division_management - read_contentprofile_management parameters: - name: id description: ID of the Division 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 '/divisions/{id}/unlink.json': post: deprecated: true tags: - divisions operationId: unlink_divisions_id_unlink description: |- Link the Division item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend using a v4 endpoint whenever possible. summary: '/divisions/{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_division_management - write_contentprofile_management parameters: - name: id description: ID of the Division 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 '/divisions/{id}/usergroups.json': get: deprecated: false tags: - divisions operationId: get_divisions_id_usergroups description: Get all usergroups that belong to the division with ID='id' summary: '/divisions/{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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true security: - bearerAuth: [] - oAuth: - read_division_management - read_user_management parameters: - name: id description: ID of the Division 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: - divisions operationId: post_divisions_id_usergroups description: Add a group to the division with ID='id' summary: '/divisions/{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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true security: - write_division_management - write_user_management parameters: - name: id description: ID of the Division 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 '/divisions/{id}/users.json': get: deprecated: true tags: - divisions operationId: get_divisions_id_users description: |- Get all users that belong to the division with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend using a v4 endpoint whenever possible. summary: '/divisions/{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 nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true security: - bearerAuth: [] - oAuth: - read_division_management - read_user_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: createdSince description: Filter comments on createdAt greater than or equal to this value 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 comment 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: isUnregisteredUserComment description: Indicates whether this comment is made by an unregistered user 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: 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. 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: unregisteredUserFirstName description: First Name of the unregistered user required: false in: query schema: type: string - name: unregisteredUserLastName description: Last Name of the unregistered user required: false in: query schema: type: string /divisionpermissions.json: get: deprecated: false tags: - divisionpermissions operationId: get_divisionpermissions description: Generates a list of DivisionPermission items summary: /divisionpermissions.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 createdAt: description: The date that the division permission was created type: string format: date-time division: description: The division this division permission belongs to type: object properties: id: type: string href: type: string format: link divisionId: description: Id of the division this division permission belongs to type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true updatedAt: description: The date that the division permission was updated type: string format: date-time user: description: The user this division permission belongs to type: object properties: id: type: string href: type: string format: link userId: description: Id of the user this division permission belongs to type: string manageAssets: description: Whether this permission enables assets management type: boolean manageExperiences: description: Whether this permission enables experiences management type: boolean deleteExperiences: description: Whether this permission enables experiences deletion type: boolean manageCoursesAndChecklists: description: Whether this permission enables courses and checklists management type: boolean manageAiRoleplays: description: Whether this permission enables management of AI roleplays type: boolean manageAnnouncements: description: Whether this permission enables announcements management type: boolean viewUsers: description: Whether this permission enables users view type: boolean manageUsers: description: Whether this permission enables users management type: boolean readinessReporting: description: Whether this permission enables readiness reporting type: boolean contentReporting: description: Whether this permission enables content reporting type: boolean reporting: description: Whether this permission enables reporting type: boolean messaging: description: Whether this permission enables messaging type: boolean manageContent: description: Whether this permission enables content management type: boolean createUserGroups: description: Whether this permission enables user group creation type: boolean manageTags: description: Whether this permission enables tag management type: boolean notifyUsersByEmail: description: Whether this permission enables email notification of users type: boolean expiredAt: description: The date that the division permission was expired type: string format: date-time nullable: true metadata: description: Metadata field for different purposes type: string nullable: true manageSharingThemes: description: Whether this permission allows sharing theme management in case the sharing feature would be enabled type: boolean security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: createUserGroups description: Whether this permission enables the creation of groups required: false in: query schema: type: boolean - 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: expiredAt description: The date that the division permission was expired required: false in: query schema: type: string format: date - 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: 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: manageContent description: Whether this permission enables managing content required: false in: query schema: type: boolean - name: manageAiRoleplays description: Whether this permission enables management of AI roleplays required: false in: query schema: type: boolean - name: messaging description: Whether this permission enables messaging required: false in: query schema: type: boolean - name: metadata description: Metadata field for different purposes 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: 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: reporting description: Whether this permission enables reporting 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. 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: - divisionpermissions operationId: post_divisionpermissions description: Create a DivisionPermission item summary: /divisionpermissions.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 createdAt: description: The date that the division permission was created type: string format: date-time division: description: The division this division permission belongs to type: object properties: id: type: string href: type: string format: link divisionId: description: Id of the division this division permission belongs to type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true updatedAt: description: The date that the division permission was updated type: string format: date-time user: description: The user this division permission belongs to type: object properties: id: type: string href: type: string format: link userId: description: Id of the user this division permission belongs to type: string manageAssets: description: Whether this permission enables assets management type: boolean manageExperiences: description: Whether this permission enables experiences management type: boolean deleteExperiences: description: Whether this permission enables experiences deletion type: boolean manageCoursesAndChecklists: description: Whether this permission enables courses and checklists management type: boolean manageAiRoleplays: description: Whether this permission enables management of AI roleplays type: boolean manageAnnouncements: description: Whether this permission enables announcements management type: boolean viewUsers: description: Whether this permission enables users view type: boolean manageUsers: description: Whether this permission enables users management type: boolean readinessReporting: description: Whether this permission enables readiness reporting type: boolean contentReporting: description: Whether this permission enables content reporting type: boolean reporting: description: Whether this permission enables reporting type: boolean messaging: description: Whether this permission enables messaging type: boolean manageContent: description: Whether this permission enables content management type: boolean createUserGroups: description: Whether this permission enables user group creation type: boolean manageTags: description: Whether this permission enables tag management type: boolean notifyUsersByEmail: description: Whether this permission enables email notification of users type: boolean expiredAt: description: The date that the division permission was expired type: string format: date-time nullable: true metadata: description: Metadata field for different purposes type: string nullable: true manageSharingThemes: description: Whether this permission allows sharing theme management in case the sharing feature would be enabled type: boolean security: - bearerAuth: [] 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: divisionId: type: string userId: type: string contentReporting: type: boolean expiredAt: type: string format: date externalId: type: string manageAnnouncements: type: boolean manageAssets: type: boolean manageCoursesAndChecklists: type: boolean manageAiRoleplays: type: boolean manageExperiences: type: boolean deleteExperiences: type: boolean manageUsers: type: boolean metadata: type: string notifyUsersByEmail: type: boolean readinessReporting: type: boolean viewUsers: type: boolean required: - divisionId - userId application/json: schema: type: object properties: divisionId: type: string userId: type: string contentReporting: type: boolean expiredAt: type: string format: date externalId: type: string manageAnnouncements: type: boolean manageAssets: type: boolean manageCoursesAndChecklists: type: boolean manageAiRoleplays: type: boolean manageExperiences: type: boolean deleteExperiences: type: boolean manageUsers: type: boolean metadata: type: string notifyUsersByEmail: type: boolean readinessReporting: type: boolean viewUsers: type: boolean required: - divisionId - userId /divisionpermissions/count.json: get: deprecated: false tags: - divisionpermissions operationId: get_divisionpermissions_count description: Retrieve the number of DivisionPermission items summary: /divisionpermissions/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_division_management parameters: - name: contentReporting description: Whether this permission enables content reporting required: false in: query schema: type: boolean - name: createUserGroups description: Whether this permission enables the creation of groups required: false in: query schema: type: boolean - 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: expiredAt description: The date that the division permission was expired required: false in: query schema: type: string format: date - name: externalId description: External ID of the tag as used in the source application required: false in: query schema: type: string - name: manageAnnouncements description: Whether this permission enables announcements management required: false in: query schema: type: boolean - name: manageAssets description: Whether this permission enables assets management required: false in: query schema: type: boolean - name: manageContent description: Whether this permission enables managing content required: false in: query schema: type: boolean - name: manageCoursesAndChecklists description: Whether this permission enables courses and checklists management required: false in: query schema: type: boolean - name: manageAiRoleplays description: Whether this permission enables management of AI roleplays required: false in: query schema: type: boolean - name: manageExperiences description: Whether this permission enables experiences management required: false in: query schema: type: boolean - name: deleteExperiences description: Whether this permission enables experiences deletion required: false in: query schema: type: boolean - name: manageUsers description: Whether this permission enables users management required: false in: query schema: type: boolean - name: messaging description: Whether this permission enables messaging required: false in: query schema: type: boolean - name: metadata description: Metadata field for different purposes required: false in: query schema: type: string - name: notifyUsersByEmail description: Whether this permission enables email notification of users required: false in: query schema: type: boolean - name: readinessReporting description: Whether this permission enables readiness reporting required: false in: query schema: type: boolean - name: reporting description: Whether this permission enables reporting 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: viewUsers description: Whether this permission enables users view required: false in: query schema: type: boolean /divisionpermissions/description.json: get: deprecated: false tags: - divisionpermissions operationId: get_divisionpermissions_description description: Generates information about the DivisionPermission model and available apis summary: /divisionpermissions/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_division_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 '/divisionpermissions/{id}.json': get: deprecated: false tags: - divisionpermissions operationId: get_divisionpermissions_id description: Retrieve DivisionPermission item with ID='id' summary: '/divisionpermissions/{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 createdAt: description: The date that the division permission was created type: string format: date-time division: description: The division this division permission belongs to type: object properties: id: type: string href: type: string format: link divisionId: description: Id of the division this division permission belongs to type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true updatedAt: description: The date that the division permission was updated type: string format: date-time user: description: The user this division permission belongs to type: object properties: id: type: string href: type: string format: link userId: description: Id of the user this division permission belongs to type: string manageAssets: description: Whether this permission enables assets management type: boolean manageExperiences: description: Whether this permission enables experiences management type: boolean deleteExperiences: description: Whether this permission enables experiences deletion type: boolean manageCoursesAndChecklists: description: Whether this permission enables courses and checklists management type: boolean manageAiRoleplays: description: Whether this permission enables management of AI roleplays type: boolean manageAnnouncements: description: Whether this permission enables announcements management type: boolean viewUsers: description: Whether this permission enables users view type: boolean manageUsers: description: Whether this permission enables users management type: boolean readinessReporting: description: Whether this permission enables readiness reporting type: boolean contentReporting: description: Whether this permission enables content reporting type: boolean reporting: description: Whether this permission enables reporting type: boolean messaging: description: Whether this permission enables messaging type: boolean manageContent: description: Whether this permission enables content management type: boolean createUserGroups: description: Whether this permission enables user group creation type: boolean manageTags: description: Whether this permission enables tag management type: boolean notifyUsersByEmail: description: Whether this permission enables email notification of users type: boolean expiredAt: description: The date that the division permission was expired type: string format: date-time nullable: true metadata: description: Metadata field for different purposes type: string nullable: true manageSharingThemes: description: Whether this permission allows sharing theme management in case the sharing feature would be enabled type: boolean security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: id description: ID of the DivisionPermission 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: 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: - divisionpermissions operationId: put_divisionpermissions_id description: Update the DivisionPermission item with ID='id' summary: '/divisionpermissions/{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 createdAt: description: The date that the division permission was created type: string format: date-time division: description: The division this division permission belongs to type: object properties: id: type: string href: type: string format: link divisionId: description: Id of the division this division permission belongs to type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true updatedAt: description: The date that the division permission was updated type: string format: date-time user: description: The user this division permission belongs to type: object properties: id: type: string href: type: string format: link userId: description: Id of the user this division permission belongs to type: string manageAssets: description: Whether this permission enables assets management type: boolean manageExperiences: description: Whether this permission enables experiences management type: boolean deleteExperiences: description: Whether this permission enables experiences deletion type: boolean manageCoursesAndChecklists: description: Whether this permission enables courses and checklists management type: boolean manageAiRoleplays: description: Whether this permission enables management of AI roleplays type: boolean manageAnnouncements: description: Whether this permission enables announcements management type: boolean viewUsers: description: Whether this permission enables users view type: boolean manageUsers: description: Whether this permission enables users management type: boolean readinessReporting: description: Whether this permission enables readiness reporting type: boolean contentReporting: description: Whether this permission enables content reporting type: boolean reporting: description: Whether this permission enables reporting type: boolean messaging: description: Whether this permission enables messaging type: boolean manageContent: description: Whether this permission enables content management type: boolean createUserGroups: description: Whether this permission enables user group creation type: boolean manageTags: description: Whether this permission enables tag management type: boolean notifyUsersByEmail: description: Whether this permission enables email notification of users type: boolean expiredAt: description: The date that the division permission was expired type: string format: date-time nullable: true metadata: description: Metadata field for different purposes type: string nullable: true manageSharingThemes: description: Whether this permission allows sharing theme management in case the sharing feature would be enabled type: boolean security: - bearerAuth: [] - oAuth: - write_division_management parameters: - name: id description: ID of the DivisionPermission 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 - 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: contentReporting: type: boolean divisionId: type: string expiredAt: type: string format: date externalId: type: string manageAnnouncements: type: boolean manageAssets: type: boolean manageCoursesAndChecklists: type: boolean manageAiRoleplays: type: boolean manageExperiences: type: boolean deleteExperiences: type: boolean manageUsers: type: boolean metadata: type: string notifyUsersByEmail: type: boolean readinessReporting: type: boolean userId: type: string viewUsers: type: boolean application/json: schema: type: object properties: contentReporting: type: boolean divisionId: type: string expiredAt: type: string format: date externalId: type: string manageAnnouncements: type: boolean manageAssets: type: boolean manageCoursesAndChecklists: type: boolean manageAiRoleplays: type: boolean manageExperiences: type: boolean deleteExperiences: type: boolean manageUsers: type: boolean metadata: type: string notifyUsersByEmail: type: boolean readinessReporting: type: boolean userId: type: string viewUsers: type: boolean post: deprecated: false tags: - divisionpermissions operationId: post_divisionpermissions_id description: Update the DivisionPermission item with ID='id' summary: '/divisionpermissions/{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 createdAt: description: The date that the division permission was created type: string format: date-time division: description: The division this division permission belongs to type: object properties: id: type: string href: type: string format: link divisionId: description: Id of the division this division permission belongs to type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true updatedAt: description: The date that the division permission was updated type: string format: date-time user: description: The user this division permission belongs to type: object properties: id: type: string href: type: string format: link userId: description: Id of the user this division permission belongs to type: string manageAssets: description: Whether this permission enables assets management type: boolean manageExperiences: description: Whether this permission enables experiences management type: boolean deleteExperiences: description: Whether this permission enables experiences deletion type: boolean manageCoursesAndChecklists: description: Whether this permission enables courses and checklists management type: boolean manageAiRoleplays: description: Whether this permission enables management of AI roleplays type: boolean manageAnnouncements: description: Whether this permission enables announcements management type: boolean viewUsers: description: Whether this permission enables users view type: boolean manageUsers: description: Whether this permission enables users management type: boolean readinessReporting: description: Whether this permission enables readiness reporting type: boolean contentReporting: description: Whether this permission enables content reporting type: boolean reporting: description: Whether this permission enables reporting type: boolean messaging: description: Whether this permission enables messaging type: boolean manageContent: description: Whether this permission enables content management type: boolean createUserGroups: description: Whether this permission enables user group creation type: boolean manageTags: description: Whether this permission enables tag management type: boolean notifyUsersByEmail: description: Whether this permission enables email notification of users type: boolean expiredAt: description: The date that the division permission was expired type: string format: date-time nullable: true metadata: description: Metadata field for different purposes type: string nullable: true manageSharingThemes: description: Whether this permission allows sharing theme management in case the sharing feature would be enabled type: boolean security: - bearerAuth: [] - oAuth: - write_division_management parameters: - name: id description: ID of the DivisionPermission 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 - 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: contentReporting: type: boolean divisionId: type: string expiredAt: type: string format: date externalId: type: string manageAnnouncements: type: boolean manageAssets: type: boolean manageCoursesAndChecklists: type: boolean manageAiRoleplays: type: boolean manageExperiences: type: boolean deleteExperiences: type: boolean manageUsers: type: boolean metadata: type: string notifyUsersByEmail: type: boolean readinessReporting: type: boolean userId: type: string viewUsers: type: boolean application/json: schema: type: object properties: contentReporting: type: boolean divisionId: type: string expiredAt: type: string format: date externalId: type: string manageAnnouncements: type: boolean manageAssets: type: boolean manageCoursesAndChecklists: type: boolean manageAiRoleplays: type: boolean manageExperiences: type: boolean deleteExperiences: type: boolean manageUsers: type: boolean metadata: type: string notifyUsersByEmail: type: boolean readinessReporting: type: boolean userId: type: string viewUsers: type: boolean delete: deprecated: false tags: - divisionpermissions operationId: delete_divisionpermissions_id description: Delete the DivisionPermission item with ID='id' summary: '/divisionpermissions/{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_division_management parameters: - name: id description: ID of the DivisionPermission 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 '/divisionpermissions/{id}/link.json': post: deprecated: false tags: - divisionpermissions operationId: link_divisionpermissions_id_link description: Link the DivisionPermission item with ID='id' summary: '/divisionpermissions/{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_division_management parameters: - name: id description: ID of the DivisionPermission 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 '/divisionpermissions/{id}/unlink.json': post: deprecated: false tags: - divisionpermissions operationId: unlink_divisionpermissions_id_unlink description: Link the DivisionPermission item with ID='id' summary: '/divisionpermissions/{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_division_management parameters: - name: id description: ID of the DivisionPermission 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 /exports/asset-authors.json: get: deprecated: false tags: - exports operationId: get_exports_asset-authors description: Export of asset-authors summary: /exports/asset-authors.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 required: - assetId - authorId example: assetId: a3e72bbfae0b87381106b1beb685ea88 authorId: aaf982e112be64774f5a5a9a1ac5d0c2 properties: assetId: description: The unique identifier of the asset. type: string authorId: description: The unique identifier of the Showpad user that is the author of this asset. type: string security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/asset-countries.json: get: deprecated: false tags: - exports operationId: get_exports_asset-countries description: Export of asset-countries summary: /exports/asset-countries.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 required: - assetId - countryCode example: assetId: a3e72bbfae0b87381106b1beb685ea88 countryCode: FR properties: assetId: description: The unique identifier of the asset. type: string countryCode: description: The ISO 3166-1 alpha-2 country code. type: string minLength: 2 maxLength: 2 security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/asset-languages.json: get: deprecated: false tags: - exports operationId: get_exports_asset-languages description: Export of asset-languages summary: /exports/asset-languages.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 required: - assetId - languageCode example: assetId: a3e72bbfae0b87381106b1beb685ea88 languageCode: fr properties: assetId: description: The unique identifier of the asset. type: string languageCode: description: The ISO 639-1 language code. type: string minLength: 2 maxLength: 2 security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/asset-tags.json: get: deprecated: false tags: - exports operationId: get_exports_asset-tags description: Export of asset-tags summary: /exports/asset-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 required: - assetId - tagId example: assetId: a3e72bbfae0b87381106b1beb685ea88 tagId: ba16a6afc2d4247862c9986aa09772fd properties: assetId: description: The unique identifier of the asset. type: string tagId: description: The unique identifier of the tag. type: string security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/assets.json: get: deprecated: false tags: - exports operationId: get_exports_assets description: Export of assets summary: /exports/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 required: - assetId - divisionId - displayName - status - slug - source - description - type - isSensitive - isShareable - isDownloadable - isDivisionShared - isAnnotatable - expiresAt - releasedAt - draftedAt - deletedAt - uploadedAt - archivedAt - createdAt - updatedAt - externalId - commentsCount - likesCount - optimizedFileSize - originalFileSize - originalAssetId example: assetId: b31f42f161f489cd56dc829cb8c8a7e8 divisionId: 4643adcc1621814e91c489b34bb428ed displayName: South Africa safari.mp4 status: active slug: 2a51789f52f6496603b14ef45ffa4e33 source: marketing description: null type: video isSensitive: false isShareable: true isDownloadable: true isDivisionShared: false isAnnotatable: false expiresAt: null releasedAt: null draftedAt: null deletedAt: '2022-07-16T11:55:52.000Z' uploadedAt: '2020-07-16T11:55:52.000Z' archivedAt: null createdAt: '2020-07-16T11:55:52.000Z' updatedAt: '2020-07-16T11:55:52.000Z' externalId: null commentsCount: 0 likesCount: 0 optimizedFileSize: 154050210 originalFileSize: 172332979 originalAssetId: null properties: assetId: description: The unique identifier of the asset. type: string divisionId: description: The unique identifier of the division of the asset. type: string displayName: description: Name of the asset (includes the extension). type: string status: description: "Status of the asset. During upload, an asset can have multiple statuses but to be used by a user it has \nto be \"active\". This can indicate, however, why a file is in the library but not used, i.e. it failed \nto process.\n" type: string source: description: An indication of whether the asset was uploaded by an admin (marketing-owned) or as a personal user upload. type: string enum: - personal - shared description: description: Description of the asset given in the Online Platform. type: string nullable: true type: description: The type of the asset type: string isSensitive: description: Indicator whether asset is confidential (can be shown in Kiosk mode or not). type: boolean isShareable: description: Indicator whether asset can be shared or not. type: boolean isDownloadable: description: Indicator whether asset can be downloaded or not. type: boolean isDivisionShared: description: Indicator whether asset has "global" property. This means it is shared across several divisions. type: boolean isAnnotatable: description: Indicator whether asset can be annotated by user. type: boolean expiresAt: description: Expiry date on the asset. type: string format: date-time nullable: true releasedAt: description: Release date of the asset. type: string format: date-time nullable: true draftedAt: description: Draft date of the asset. type: string format: date-time nullable: true deletedAt: description: 'Timestamp when the asset was deleted. In the Online Platform, all reporting will exclude events after this date.' type: string format: date-time nullable: true uploadedAt: description: Timestamp when the asset is uploaded. type: string format: date-time nullable: true archivedAt: description: 'Timestamp when the asset is archived. In the Online Platform, that means the asset is in the Trash but not yet deleted.' type: string format: date-time nullable: true createdAt: description: Timestamp when the asset was created. type: string format: date-time updatedAt: description: Timestamp when the asset is last updated. type: string format: date-time externalId: description: Assets uploaded via an integration often have a ID from the source system. type: string nullable: true commentsCount: description: Number of comments. type: integer format: int32 likesCount: description: Number of likes. type: integer format: int32 optimizedFileSize: description: Filesize of the asset in bytes after optimization by Showpad. type: integer format: int64 nullable: true originalFileSize: description: Filesize of the original asset in bytes. type: integer format: int64 nullable: true originalAssetId: description: The unique identifier of the original asset (in case of edited assets). type: string nullable: true slug: description: The slug of an asset type: string nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/channel-usergroups.json: get: deprecated: false tags: - exports operationId: get_exports_channel-usergroups description: Export of channel-usergroups summary: /exports/channel-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 required: - channelId - usergroupId example: channelId: 3b04f0522b120f7736b4a5581e9a7b82 usergroupId: 22b3d7f8eea74c37d3d140642ccbaeba properties: channelId: description: The unique identifier of the channel (also called experience). type: string usergroupId: description: The unique identifier of the usergroup assigned to the channel/experience. type: string security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/channel-users.json: get: deprecated: false tags: - exports operationId: get_exports_channel-users description: Export of channel-users summary: /exports/channel-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 required: - channelId - userId example: channelId: 6fa226398411027389efe94029f167b1 userId: aaf982e112be64774f5a5a9a1ac5d0c2 properties: channelId: description: The unique identifier of the channel (also called experience). type: string userId: description: The unique identifier of the user assigned to the channel/experience. type: string security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/channels.json: get: deprecated: false tags: - exports operationId: get_exports_channels description: Export of channels summary: /exports/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 required: - channelId - name - status - deletedAt example: channelId: 6fa226398411027389efe94029f167b1 name: Safari status: active deletedAt: null properties: channelId: description: The unique identifier of the channel (also called experience). type: string name: description: The name of the experience. type: string status: description: Deprecated field. Please ignore. type: string deletedAt: description: Timestamp when the experience is deleted. type: string format: date-time nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/collectionitems.json: get: deprecated: false tags: - exports operationId: get_exports_collectionitems description: Export of collectionitems summary: /exports/collectionitems.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 required: - collectionItemId - collectionId - assetId - page - position - createdAt - updatedAt - deletedAt example: collectionItemId: 7843b4523ecc64d16dad3043505d6190a85efcc6ad354986615dac32fc90e5ae collectionId: fe3516e716cb90839a74149388258570d1dab8f531c78616043e31d76d2bd2cc assetId: e1b5dd48608b137251db41dfde8581a2 page: null position: 3 createdAt: '2022-07-18T10:52:56.000Z' updatedAt: '2022-07-18T10:52:56.000Z' deletedAt: null properties: collectionItemId: description: The unique identifier of the collection item. type: string collectionId: description: The unique identifier of the collection this collection item belongs to. type: string assetId: description: The unique identifier of the asset linked to this collection item. type: string page: description: "Page of the asset added. If the complete asset is added, the page field will be empty (NULL). If the \noriginal asset is updated, it is still the absolute page number which will be part of the collection.\n" type: integer format: int32 nullable: true position: description: Position (0-based) of the asset (page) in the collection. type: integer format: int32 createdAt: description: Timestamp when the collection item was created. type: string format: date-time updatedAt: description: Timestamp when the collection item is last updated. type: string format: date-time deletedAt: description: Timestamp when the collection item was deleted. type: string format: date-time nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/collections.json: get: deprecated: false tags: - exports operationId: get_exports_collections description: Export of collections summary: /exports/collections.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 required: - collectionId - userId - name - createdAt - updatedAt - deletedAt example: collectionId: d8a3961c96f4d6950d3b2ff97501427743508b7c1bef632da2640b61abe5ce59 userId: f7e77ece030b616d9e4c4e3834e94aa4 name: CustomerA createdAt: '2021-09-13T08:11:33.000Z' updatedAt: '2021-09-13T08:11:34.000Z' deletedAt: null properties: collectionId: description: The unique identifier of the collection. type: string userId: description: The unique identifier of the user that owns this collection. type: string name: description: Name of the collection. type: string createdAt: description: Timestamp when the collection was created. type: string format: date-time updatedAt: description: Timestamp when the collection is last updated. type: string format: date-time deletedAt: description: Timestamp when the collection was deleted. type: string format: date-time nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/contacts.json: get: deprecated: false tags: - exports operationId: get_exports_contacts description: Export of contacts summary: /exports/contacts.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 required: - contactId - name - userId - deletedAt example: contactId: 8792a2fd4e2cefcd6d3bb6201e4ebf92 name: admin@showpad.com userId: aaf982e112be64774f5a5a9a1ac5d0c2 deletedAt: null properties: contactId: description: The unique identifier of the contact. type: string name: description: Name of the contact. type: string userId: description: User ID that created the contact (can be different than the user that generates the share). type: string deletedAt: description: Timestamp when the contact was deleted. type: string format: date-time nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/devices.json: get: deprecated: false tags: - exports operationId: get_exports_devices description: Export of devices summary: /exports/devices.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 required: - deviceId - appUsed - lastActiveUserId - model - location - type example: deviceId: 3ecf6b651c97a7ad319772557c830c1b appUsed: web lastActiveUserId: 817219b07f8649beedab964442f6ac9b model: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML like Gecko) Version/16.5 Safari/605.1.15 location: Ghent BE type: browser properties: deviceId: description: The unique identifier of the device. type: string appUsed: description: "On the device record that is registered, we keep multiple fields to identify the device, e.g. the \noperating system, the device model (device model or browser user agent), the type of device (web, \nbrowser, tablet, trackingPixel), and the app that was used.\n" type: string lastActiveUserId: description: 'Last user ID which logged on to this device. If the event is not related to a Showpad user, this field is NULL.' type: string nullable: true model: description: Model of the device (if available). type: string nullable: true location: description: (last) location of the device (if available). type: string nullable: true type: description: "The mapping is based on model and app used. This is done to facilitate recreating identical reporting \nto that used in our Online Platform.\n" type: string security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/division-usergroups.json: get: deprecated: false tags: - exports operationId: get_exports_division-usergroups description: Export of division-usergroups summary: /exports/division-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 required: - divisionId - usergroupId example: divisionId: '4643adcc1621814e91c489b34bb428ed,' usergroupId: 22b3d7f8eea74c37d3d140642ccbaeba properties: divisionId: description: The unique identifier of the division. type: string usergroupId: description: The unique identifier of the usergroup. type: string security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/divisions.json: get: deprecated: false tags: - exports operationId: get_exports_divisions description: Export of divisions summary: /exports/divisions.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 required: - divisionId - divisionName - isGlobal - isPersonal - ownerUserId - deletedAt example: divisionId: 409fe43883cb6e1f12c655e753aac096 divisionName: Product Development isGlobal: false isPersonal: false deletedAt: '2020-04-18T08:16:10.000Z' ownerUserId: null properties: divisionId: description: The unique identifier of the division. type: string divisionName: description: The name of the division type: string isGlobal: description: Indicates the division is a global division. type: boolean isPersonal: description: 'Indicates the source of assets is the user''s My Files, which is in fact a personal division.' type: boolean ownerUserId: description: In case of a personal division (My Files) this field contains the related userId. type: string nullable: true deletedAt: description: Timestamp when the division was deleted. type: string format: date-time nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/events.json: get: deprecated: false tags: - exports operationId: get_exports_events description: Export of events summary: /exports/events.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 required: - eventId - startTime - endTime - loggedAt - userId - channelId - shareId - sharedSpaceId - sharedSpaceParticipantId - deviceId - divisionId - assetId - contactId - type - page - metadata example: eventId: 92d93d74bb1017d71533f8b6335fdb25152685c473a851890597c2a521f161f2 startTime: '2018-04-05T13:54:17+00:00' endTime: '2018-04-05T13:54:19+00:00' loggedAt: '2018-04-05T13:54:19+00:00' userId: c0bf28fe5aefb7cf3b8091c71a8bc4c9 channelId: null shareId: 64cd098838b373928d45623ffd893baa sharedSpaceId: null sharedSpaceParticipantId: null deviceId: 22d0289575051a644335465abf06bee5 divisionId: null assetId: 3b6d75cf1970aa5f1a3e6bf73cd07347 contactId: a26c59efde808da3b54085f3df0042cd type: shared-asset-viewed page: null metadata: ip: 172.16.118.0 properties: eventId: description: Identifier of an event; an event is an interaction of a user in the Showpad apps. type: string startTime: description: Timestamp of the event (start). type: string format: date-time endTime: description: Timestamp of the event (end). type: string format: date-time loggedAt: description: Timestamp of the logging of the event to the database (can be later in offline use case). type: string format: date-time userId: description: Identifier of a user. type: string channelId: description: Identifier of a channel (experience). type: string nullable: true shareId: description: Identifier of a share. type: string nullable: true sharedSpaceId: description: Identifier of a shared space. type: string nullable: true sharedSpaceParticipantId: description: Identifier of a shared space participant. type: string nullable: true deviceId: description: Identifier of a device. type: string nullable: true divisionId: description: 'Deprecated field, please do not use this for linking division lookup table. The correct divisionId is found on the asset lookup table.' type: string nullable: true assetId: description: Identifier of an asset. type: string nullable: true contactId: description: Identifier of a contact. type: string nullable: true type: description: Type of the event type: string nullable: true page: description: "Page of the asset (for view events only); NULL for all other cases or the \"all pages\" view event; \npage is also only filled when the export is executed with pageBased=true; Values are numeric for all \nnon-HTML5 assets and can be text/string for HTML5 assets.\n" type: integer format: int32 nullable: true metadata: description: Some experiences have some extra metadata on usage data. type: object nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: startedAt description: 'Only include events that happened after this date (YYYY-MM-DD, YYYY-MM-DD HH:mm:ss or timestamp)' required: false in: query schema: type: string format: date - name: endedAt description: 'Only include events that happened before this date (YYYY-MM-DD, YYYY-MM-DD HH:mm:ss or timestamp)' required: false in: query schema: type: string format: date - name: loggedBefore description: 'Only include events that have been logged to Showpad before this date (for offline use, this is when the device comes online) (YYYY-MM-DD, YYYY-MM-DD HH:mm:ss or timestamp)' required: false in: query schema: type: string format: date - name: loggedAfter description: 'Include only events that have been logged to Showpad after or at the specified timestamp. (loggedAfter >= timestamp, for offline use, this is when the device comes online) (YYYY-MM-DD, YYYY-MM-DD HH:mm:ss or timestamp)' required: false in: query schema: type: string format: date - name: pageBased description: Include page-based information in events required: false in: query schema: type: boolean - name: userId description: Only include events for a specified user required: false in: query schema: type: string - name: eventType description: Only include events with a specified event type. You can list multiple event types by separating them by a comma. required: false in: query schema: type: string - name: channelIds description: Only include events with a specified channel ID. You can list multiple channel IDs by separating them by a comma. 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 50, only 50 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 50 maximum: 1000 oneOf: - required: - startedAt - required: - endedAt - required: - loggedBefore - required: - loggedAfter /exports/sharedspace-items.json: get: deprecated: false tags: - exports operationId: get_exports_sharedspace-items description: Export of sharedspace-items summary: /exports/sharedspace-items.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 required: - sharedSpaceItemId - sharedSpaceId - userId - assetId - page - createdAt - updatedAt - deletedAt example: sharedSpaceItemId: 7843b4523ecc64d16dad3043505d6190c5fd949402bebbfbb5786c76b5144ae4 sharedSpaceId: 354a27151d58a11d7254931e9b036a05 userId: c0bf28fe5aefb7cf3b8091c71a8bc4c9 assetId: fadabd92012642cf143aa6c0a7194a23 page: null createdAt: '2018-03-09T14:46:58.000Z' updatedAt: '2018-03-09T14:46:58.000Z' deletedAt: null properties: sharedSpaceItemId: description: The unique identifier of the shared space item. type: string sharedSpaceId: description: The unique identifier of the shared space. type: string userId: description: The unique identifier of the user. type: string assetId: description: The unique identifier of the asset. type: string page: description: Page number (zero-based) in case a single page was inserted in the shared space. type: integer format: int32 nullable: true createdAt: description: Timestamp when the item was added to the shared space. type: string format: date-time updatedAt: description: Timestamp when the item was last modified in the shared space. type: string format: date-time deletedAt: description: Timestamp when the item was deleted from the shared space. type: string format: date-time nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/sharedspaceparticipants.json: get: deprecated: false tags: - exports operationId: get_exports_sharedspaceparticipants description: Export of sharedspaceparticipants summary: /exports/sharedspaceparticipants.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 required: - sharedSpaceParticipantId - sharedSpaceId - userId - accessGrantedAt - accessRevokedAt - lastActivityAt - createdAt - deletedAt example: sharedSpaceItemId: 7843b4523ecc64d16dad3043505d6190c5fd949402bebbfbb5786c76b5144ae4 sharedSpaceId: 354a27151d58a11d7254931e9b036a05 userId: c0bf28fe5aefb7cf3b8091c71a8bc4c9 assetId: fadabd92012642cf143aa6c0a7194a23 page: null createdAt: '2018-03-09T14:46:58.000Z' updatedAt: '2018-03-09T14:46:58.000Z' deletedAt: null firstName: Chris lastName: P. Bacon emailAddress: chris.bacon@showpad.com organisation: Showpad jobTitle: Software Engineer properties: sharedSpaceParticipantId: description: The unique identifier of the shared space participant. type: string sharedSpaceId: description: The unique identifier of the shared space. type: string userId: description: The unique identifier of the user. type: string nullable: true accessGrantedAt: description: Timestamp this person was granted access. type: string format: date-time nullable: true accessRevokedAt: description: Timestamp this person was revoked access. type: string format: date-time nullable: true lastActivityAt: description: Timestamp of last activity of this participant. type: string format: date-time nullable: true createdAt: description: Timestap when the participant was created. type: string format: date-time deletedAt: description: Timestamp of removal of this participant. type: string format: date-time nullable: true firstName: description: First name of this participant. type: string nullable: true lastName: description: Last name of this participant. type: string nullable: true emailAddress: description: E-mail adress of this participant. type: string nullable: true organisation: description: Organisation name that this participant belongs to. type: string nullable: true jobTitle: description: Job title of this participant. type: string nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/sharedspaces.json: get: deprecated: false tags: - exports operationId: get_exports_sharedspaces description: Export of sharedspaces summary: /exports/sharedspaces.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 required: - sharedSpaceId - creatorId - ownerId - title - description - status - createdAt - lastActivityAt - deletedAt - sharedSpaceParticipantsIds example: title: Shared Space for Customer A description: This is a shared space made for customerA createdAt: '2020-03-22T14:04:20.000Z' lastActivityAt: '2023-02-27T13:35:58.000Z' deletedAt: null sharedSpaceId: 6fe3df909ca6631847b85ddb1bf7d9db creatorId: c0bf28fe5aefb7cf3b8091c71a8bc4c9 ownerId: c0bf28fe5aefb7cf3b8091c71a8bc4c9 sharedSpaceParticipantsIds: - cfff0715565e8431c502db395c824f92 - 2f7bfe2dcf74900bf9518aae5bda6ad5 - a23c317737b4b1dcedc49bcd0650d4ca - 43b75d24508f9db4431073e248fa7db6 - a2038666ce17917c5d2a6d1fb239ce4a status: active properties: sharedSpaceId: description: The unique identifier of the shared space. type: string creatorId: description: The unique identifier of the user that created the shared space. type: string ownerId: description: The unique identifier of the user that owns the shared space. type: string title: description: Title of the shared space. type: string maxLength: 65535 description: description: Description of the shared space. type: string maxLength: 65535 nullable: true status: description: 'Status of the shared space. Can be one of: active, archived, deleted' type: string createdAt: description: Timestamp of creation of shared space (should be close to timestamp of event itself). type: string format: date-time lastActivityAt: description: Timestamp of last activity on the shared space. type: string format: date-time nullable: true deletedAt: description: Shared Spaces can be deleted; this is the timestamp. type: string format: date-time nullable: true sharedSpaceParticipantsIds: description: Array with all participants - lookup to sharedspaceparticipants. type: array items: type: string security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/shares.json: get: deprecated: false tags: - exports operationId: get_exports_shares description: Export of shares summary: /exports/shares.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 required: - shareId - title - type - salesforce - theme - recipients - creatorId - sharedAt - revokedAt example: shareId: 86c034ab7a6f0bd3bf796437b3239dba title: Share for customer A type: link salesforce: false theme: My Branded Theme recipients: null creatorId: c0bf28fe5aefb7cf3b8091c71a8bc4c9 sharedAt: '2022-09-01T13:19:59.000Z' revokedAt: null properties: shareId: description: The unique identifier of the share. type: string title: description: Title of the share. type: string maxLength: 65535 type: description: Type of the share type: string salesforce: description: Indicator whether logged to Salesforce or not. type: boolean theme: description: Name of the theme used for sharing (simple shares only). type: string recipients: description: List of recipients of the share. Typically recipient email address. If we don't have email but we have the name we store the name. type: string maxLength: 65535 creatorId: description: The user ID that created the share. type: string sharedAt: description: Timestamp of creation of share record (should be close to timestamp of event itself). type: string format: date-time revokedAt: description: Shares can be revoked (not deleted). This is the timestamp. type: string format: date-time nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/tagcategories.json: get: deprecated: false tags: - exports operationId: get_exports_tagcategories description: Export of tagcategories summary: /exports/tagcategories.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 required: - tagCategoryId - name - path - publishedAt example: tagCategoryId: 635eeed476f55a43223edde5f598eb2b name: Level two path: /e31188c031455bdbbbc9863d19096a14/ publishedAt: '2020-08-24T16:42:03.000Z' properties: tagCategoryId: description: The unique identifier of the tag category. type: string name: description: Name of the tag category. type: string path: description: "Path above the tag category. A category can be a child to another category. The full parent path \n(based on tagCategoryId) is presented here in \"materialized path\" format.\n" type: string maxLength: 65535 publishedAt: description: "Timestamp when the tag category was published. If empty, the tag category is created for internal \nusage but not for use on the search or browse experiences.\n" type: string format: date-time security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/tagcategory-tags.json: get: deprecated: false tags: - exports operationId: get_exports_tagcategory-tags description: Export of tagcategory-tags summary: /exports/tagcategory-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 required: - tagCategoryId - tagId example: tagCategoryId: 0ed2cfaa83e798a60d0490dc9578204a tagId: 16643416ea0fcd2388eb578143bc38f6 properties: tagCategoryId: description: The unique identifier of the tag category. type: string tagId: description: The unique identifier of the tag. type: string security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/tags.json: get: deprecated: false tags: - exports operationId: get_exports_tags description: Export of tags summary: /exports/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 required: - tagId - name example: tagId: 70e0c51c290b36f6e67cc520dc572195 name: Flyers properties: tagId: description: The unique identifier of the tag. type: string name: description: Tag name type: string security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/user-usergroups.json: get: deprecated: false tags: - exports operationId: get_exports_user-usergroups description: Export of user-usergroups summary: /exports/user-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 required: - userId - usergroupId example: userId: c0bf28fe5aefb7cf3b8091c71a8bc4c9 usergroupId: 3648832d1da2729923493af577ef1d01 properties: userId: description: The unique identifier of the user. type: string usergroupId: description: The unique identifier of the usergroup. type: string security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/usergroups.json: get: deprecated: false tags: - exports operationId: get_exports_usergroups description: Export of usergroups summary: /exports/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 required: - usergroupId - name - deletedAt example: usergroupId: 3648832d1da2729923493af577ef1d01 name: All Users deletedAt: null properties: usergroupId: description: The unique identifier of the usergroup. type: string name: description: Name of the usergroup. type: string deletedAt: description: Timestamp when the usergroup was deleted. type: string format: date-time nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 /exports/users.json: get: deprecated: false tags: - exports operationId: get_exports_users description: Export of users summary: /exports/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 required: - userId - firstName - lastName - emailAddress - deletedAt - isActive - isForgotten - createdAt - userRole - managerId - externalId example: userId: c0bf28fe5aefb7cf3b8091c71a8bc4c9 firstName: Chris lastName: P. Bacon emailAddress: chrisp.bacon@showpad.com deletedAt: null isActive: true isForgotten: false createdAt: '2018-01-11T14:33:34.000Z' userRole: Admin managerId: f64a937107b290b3068f6eb8fab33411 externalId: null properties: userId: description: The unique identifier of the user. type: string firstName: description: First name of the user. type: string lastName: description: Last name of the user. type: string emailAddress: description: E-mail address of the user. type: string deletedAt: description: Timestamp when the user was deleted. type: string format: date-time nullable: true isActive: description: "Indicates if the user has an active license. When a user is deactivated, isActive will be false. \nIn case the user is deleted, this field can still be true if the user had an active license at the time\nof deletion.\n" type: boolean isForgotten: description: "Indicates the user has been anonymized for GDPR reasons; i.e. deleted users are anonymized after x \nmonths according to configuration in the OP. Also for some geographies active users can be anonymized; \nemailAddress, firstname and lastname will also be anonymized.\n" type: boolean createdAt: description: Timestamp of creation of the user type: string format: date-time userRole: description: 'The role of the user inside Showpad. Can be one of: Admin, Manager, Promoted Member, User.' type: string managerId: description: The identifier of the manager user. type: string nullable: true externalId: description: The external id of the user. type: string nullable: true security: - bearerAuth: [] - oAuth: - read_division_management parameters: - name: limit description: 'Sets the maximum number of returned items. The maximum limit is set to 100000. For example, if ''limit'' is 1, only 1 items will be retrieved.' required: false in: query schema: type: integer format: int32 minimum: 1 maximum: 100000 - 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 '/{id}.json': get: deprecated: false tags: - generic operationId: get_id description: "Retrieve a resource using the 'id' parameter, where 'id' represents the PID associated with any resource. \nThe system will intelligently identify the resource type and provide the corresponding resource as the output.\n" summary: '/{id}.json' responses: '403': description: Forbidden. Requester does not have the right permissions to request the resource. default: description: successful operation content: application/json: schema: type: object security: - bearerAuth: [] - oAuth: - read_division_management - read_contentprofile_management - read_user_management parameters: - name: id description: ID of the Resource 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: 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 /recommendations/assets/new: get: deprecated: false tags: - recommendations operationId: get_recommendations_assets_new description: Newly available assets summary: /recommendations/assets/new 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: The unique identifier of the asset. type: string example: 597cf7f51b60fc59c0d6d79588047c62 score: description: The recommendation score of the asset. type: number example: 1.8027210884354 model: description: The recommendation model of the asset. type: string example: content-asset-new content: type: object properties: id: description: The unique identifier of the asset. type: string example: 597cf7f51b60fc59c0d6d79588047c62 displayName: description: The name of the asset. type: string example: Demo.pdf description: description: The description of the asset. type: string nullable: true example: My asset description type: description: The type of the asset. type: string example: document extension: description: The extension of the asset. type: string example: pdf appLink: description: The app link of the asset. type: string example: 'showpad://file/262876c721ab7f126e78022a02188150' previewUrls: description: The preview URLs of the asset. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/preview/v6.0' thumbnailUrls: description: The thumbnail URLs of the asset. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/thumbnail/v1.1' coverFocalPoint: description: The focal point of the cover image of the asset. type: string nullable: true example: 0.48/0.38 createdAt: description: The creation date of the asset. type: string format: date-time example: '2022-11-08T09:53:56+00:00' updatedAt: description: The last update date of the asset. type: string format: date-time example: '2022-11-08T09:53:56+00:00' security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: notViewedAfter description: 'Exclude assets that have been viewed by user after this date (default: now)' required: false in: query schema: type: string format: date - name: assignedAfter description: 'Only include assets that have been assigned to the user after this date (default: today minus 30 days)' required: false in: query schema: type: string format: date - name: tagIds description: 'Same as conjunctiveTagIds. If tagIds is used, the disjunctiveTagIds and excludedTagIds parameters are ignored (tag IDs passed as an array, e.g. 1,2)' required: false in: query schema: type: string - name: conjunctiveTagIds description: 'Only include assets that have all these tags (tag IDs passed as an array, e.g. 1,2)' required: false in: query schema: type: string - name: disjunctiveTagIds description: 'Only include assets that have at least on of these tags (tag IDs passed as an array, e.g. 1,2)' required: false in: query schema: type: string - name: excludedTagIds description: 'Exclude assets that have one of these tags (tag IDs passed as an array, e.g. 1,2)' required: false in: query schema: type: string - name: limit description: 'Return maximum this number of assets (default: 10)' required: false in: query schema: type: integer format: int32 /recommendations/assets/popular: get: deprecated: false tags: - recommendations operationId: get_recommendations_assets_popular description: |- This endpoint returns assets that consistently perform well based on long-term engagement metrics such as views, shares, or downloads. The results reflect sustained interest and usefulness over time. Use this endpoint when you need to: - Highlight top-performing content to users - Recommend frequently accessed or shared assets - Inform content strategy with insights on long-term engagement Popular results are based on aggregated activity over an extended period and may vary depending on user access and Division permissions. summary: /recommendations/assets/popular 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 assets returned in the response. type: integer format: int32 example: 20 items: type: array description: List of popular asset records based on user activity and query parameters. items: type: object properties: id: description: The unique identifier of the recommended asset. type: string example: 597cf7f51b60fc59c0d6d79588047c62 score: description: The recommendation score of the asset. type: number example: 1.8027210884354 model: description: The recommendation model of the asset. type: string example: content-asset-popular content: type: object properties: id: description: The unique identifier of the recommended asset. type: string example: 597cf7f51b60fc59c0d6d79588047c62 displayName: description: The display name of the asset. type: string example: Demo.pdf description: description: The optional text description of the asset. type: string nullable: true example: My asset description type: description: The type of the asset. type: string example: document extension: description: The file extension of the asset. type: string example: pdf appLink: description: The app link of the asset. type: string example: 'showpad://file/262876c721ab7f126e78022a02188150' previewUrls: description: The preview URLs of the asset. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/preview/v6.0' thumbnailUrls: description: The thumbnail URLs of the asset. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/thumbnail/v1.1' coverFocalPoint: description: The X/Y coordinates that define the focal point of the cover image of the asset. type: string nullable: true example: 0.48/0.38 createdAt: description: Date and time when the asset was created. type: string format: date-time example: '2022-11-08T09:53:56+00:00' updatedAt: description: Date and time of the asset's most recent update. type: string format: date-time example: '2022-11-08T09:53:56+00:00' security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: startedAt description: 'Restricts popularity calculations to activity **after** the specified date. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:mm:ss, or Unix timestamp. Default: one year ago' required: false in: query schema: type: string format: date - name: endedAt description: 'Restricts popularity calculations to activity **before** a specified date. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:mm:ss, or Unix timestamp. Default: current time' required: false in: query schema: type: string format: date - name: notViewedAfter description: 'Excludes assets that were viewed after a specified date by the current user. Default: current time' required: false in: query schema: type: string format: date - name: activityScope description: 'Defines how popularity is measured. Use viewed to rank assets by number of in-app views, or shared to rank by number of Shares (excluding Shared Spaces). Possible values: `viewed` (default) or `shared`' required: false in: query schema: type: string - name: userScope description: 'Determines whose activity is considered when calculating popularity. Use `user` to consider only the current user’s activity, or `global` (default) to include all users with access to the same assets.' required: false in: query schema: type: string - name: tagIds description: 'Filters results to include only assets that are tagged with all of the specified tag IDs. Accepts an array (comma-separated list) of tag IDs. Example: 1,2, 5. If this parameter is used, it overrides any values provided in `disjunctiveTagIds` or `excludedTagIds`' required: false in: query schema: type: string - name: conjunctiveTagIds description: 'Filters results to include only assets that have **all** of the specified tag IDs. Pass values as an array (comma-separated list). Example: 1,2,5' required: false in: query schema: type: string - name: disjunctiveTagIds description: 'Filters results to include assets that have **at least one** of the specified tag IDs. Pass values as an array (comma-separated list). Example: 1,2,5' required: false in: query schema: type: string - name: excludedTagIds description: 'Excludes assets that have **any** of the specified tag IDs. Pass values as an array (comma-separated list). Example: 1,2,5' required: false in: query schema: type: string - name: limit description: 'Maximum number of assets to return. Default: 10' required: false in: query schema: type: integer format: int32 /recommendations/assets/trending: get: deprecated: false tags: - recommendations operationId: get_recommendations_assets_trending description: |- Retrieve assets with rising engagement based on recent user activity, such as views or shares. This endpoint identifies content that is currently being interacted with more frequently, making it useful for surfacing timely and relevant materials. Use this endpoint when you need to: - Highlight assets that are receiving increased attention over a short period - Recommend recent high-engagement content to users - Filter trending assets by tags, activity type, or time window summary: /recommendations/assets/trending 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 assets returned in the response. type: integer format: int32 example: 20 items: type: array description: List of popular asset records based on user activity and query parameters. items: type: object properties: id: description: The unique identifier of the recommended asset. type: string example: 597cf7f51b60fc59c0d6d79588047c62 score: description: The recommendation score of the asset. type: number example: 1.8027210884354 model: description: The recommendation model of the asset. type: string example: content-asset-trending content: type: object properties: id: description: The unique identifier of the asset. type: string example: 597cf7f51b60fc59c0d6d79588047c62 displayName: description: The display name of the asset. type: string example: Demo.pdf description: description: The optional text description of the asset. type: string nullable: true example: My asset description type: description: The type of the asset. type: string example: document extension: description: The file extension of the asset. type: string example: pdf appLink: description: The app link of the asset. type: string example: 'showpad://file/262876c721ab7f126e78022a02188150' previewUrls: description: The preview URLs of the asset. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/preview/v6.0' thumbnailUrls: description: The thumbnail URLs of the asset. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/thumbnail/v1.1' coverFocalPoint: description: The X/Y coordinates that define the focal point of the cover image of the asset. type: string nullable: true example: 0.48/0.38 createdAt: description: Date and time when the asset was created. type: string format: date-time example: '2022-11-08T09:53:56+00:00' updatedAt: description: Date and time of the asset's most recent update. type: string format: date-time example: '2022-11-08T09:53:56+00:00' security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: startedAt description: 'Restricts popularity calculations to activity **after** the specified date. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:mm:ss, or Unix timestamp. Default: one year ago' required: false in: query schema: type: string format: date - name: endedAt description: 'Restricts popularity calculations to activity **before** a specified date. Accepts formats: YYYY-MM-DD, YYYY-MM-DD HH:mm:ss, or Unix timestamp. Default: current time' required: false in: query schema: type: string format: date - name: notViewedAfter description: 'Excludes assets that were viewed after a specified date by the current user. Default: current time' required: false in: query schema: type: string format: date - name: activityScope description: 'Defines how popularity is measured. Use viewed to rank assets by number of in-app views, or shared to rank by number of Shares (excluding Shared Spaces). Possible values: `viewed` (default) or `shared`§' required: false in: query schema: type: string - name: userScope description: 'Determines whose activity is considered when calculating popularity. Use `user` to consider only the current user’s activity, or `global` (default) to include all users with access to the same assets. ' required: false in: query schema: type: string - name: tagIds description: 'Filters results to include only assets that are tagged with all of the specified tag IDs. Accepts an array (comma-separated list) of tag IDs. Example: 1,2, 5. If this parameter is used, it overrides any values provided in `disjunctiveTagIds` or `excludedTagIds`' required: false in: query schema: type: string - name: conjunctiveTagIds description: 'Filters results to include only assets that have **all** of the specified tag IDs. Pass values as an array (comma-separated list). Example: 1,2,5' required: false in: query schema: type: string - name: disjunctiveTagIds description: 'Filters results to include assets that have **at least one** of the specified tag IDs. Pass values as an array (comma-separated list). Example: 1,2, 5' required: false in: query schema: type: string - name: excludedTagIds description: 'Excludes assets that have **any** of the specified tag IDs. Pass values as an array (comma-separated list). Example: 1,2, 5' required: false in: query schema: type: string - name: limit description: 'Maximum number of assets to return. Default: 10' required: false in: query schema: type: integer format: int32 /recommendations/assets/updated: get: deprecated: false tags: - recommendations operationId: get_recommendations_assets_updated description: Recently updated assets summary: /recommendations/assets/updated 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: The unique identifier of the asset. type: string example: 597cf7f51b60fc59c0d6d79588047c62 score: description: The recommendation score of the asset. type: number example: 1.8027210884354 model: description: The recommendation model of the asset. type: string example: content-asset-updated content: type: object properties: id: description: The unique identifier of the asset. type: string example: 597cf7f51b60fc59c0d6d79588047c62 displayName: description: The name of the asset. type: string example: Demo.pdf description: description: The description of the asset. type: string nullable: true example: My asset description type: description: The type of the asset. type: string example: document extension: description: The extension of the asset. type: string example: pdf appLink: description: The app link of the asset. type: string example: 'showpad://file/262876c721ab7f126e78022a02188150' previewUrls: description: The preview URLs of the asset. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/preview/v6.0' thumbnailUrls: description: The thumbnail URLs of the asset. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/thumbnail/v1.1' coverFocalPoint: description: The focal point of the cover image of the asset. type: string nullable: true example: 0.48/0.38 createdAt: description: The creation date of the asset. type: string format: date-time example: '2022-11-08T09:53:56+00:00' updatedAt: description: The last update date of the asset. type: string format: date-time example: '2022-11-08T09:53:56+00:00' security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: notViewedAfter description: 'Exclude assets that have been viewed by user after this date (default: now)' required: false in: query schema: type: string format: date - name: updatedAfter description: 'Only include assets that have been updated after this date (default: today minus 30 days)' required: false in: query schema: type: string format: date - name: tagIds description: 'Same as conjunctiveTagIds. If tagIds is used, the disjunctiveTagIds and excludedTagIds parameters are ignored (tag IDs passed as an array, e.g. 1,2)' required: false in: query schema: type: string - name: conjunctiveTagIds description: 'Only include assets that have all these tags (tag IDs passed as an array, e.g. 1,2)' required: false in: query schema: type: string - name: disjunctiveTagIds description: 'Only include assets that have at least on of these tags (tag IDs passed as an array, e.g. 1,2)' required: false in: query schema: type: string - name: excludedTagIds description: 'Exclude assets that have one of these tags (tag IDs passed as an array, e.g. 1,2)' required: false in: query schema: type: string - name: limit description: 'Return maximum this number of assets (default: 10)' required: false in: query schema: type: integer format: int32 /recommendations/experiences/new: get: deprecated: false tags: - recommendations operationId: get_recommendations_experiences_new description: New experiences summary: /recommendations/experiences/new 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: The unique identifier of the experience. type: string example: 597cf7f51b60fc59c0d6d79588047c62 score: description: The recommendation score of the experience. type: number example: 1.8027210884354 model: description: The recommendation model of the experience. type: string example: content-experience-new content: type: object properties: id: description: The unique identifier of the experience. type: string example: 597cf7f51b60fc59c0d6d79588047c62 displayName: description: The name of the experience. type: string example: Demo.pdf description: description: The description of the experience. type: string nullable: true example: My asset description type: description: The type of the experience. type: string example: profile extension: description: The extension of the experience. type: string nullable: true example: null appLink: description: The app link of the experience. type: string example: 'showpad://profile/2802' previewUrls: description: The preview URLs of the experience. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/preview/v6.0' thumbnailUrls: description: The thumbnail URLs of the experience. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/thumbnail/v1.1' coverFocalPoint: description: The focal point of the cover image of the experience. type: string nullable: true example: 0.48/0.38 createdAt: description: The creation date of the experience. type: string format: date-time example: '2022-11-08T09:53:56+00:00' updatedAt: description: The last update date of the experience. type: string format: date-time example: '2022-11-08T09:53:56+00:00' security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: notViewedAfter description: 'Exclude experiences that have been viewed by user after this date (default: now)' required: false in: query schema: type: string format: date - name: assignedAfter description: 'Only include experiences that have been assigned to the user after this date (default: today minus 30 days)' required: false in: query schema: type: string format: date - name: limit description: 'Return maximum this number of assets (default: 10)' required: false in: query schema: type: integer format: int32 /recommendations/experiences/popular: get: deprecated: false tags: - recommendations operationId: get_recommendations_experiences_popular description: Popular experiences summary: /recommendations/experiences/popular 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: The unique identifier of the experience. type: string example: 597cf7f51b60fc59c0d6d79588047c62 score: description: The recommendation score of the experience. type: number example: 1.8027210884354 model: description: The recommendation model of the experience. type: string example: content-experience-popular-non-used content: type: object properties: id: description: The unique identifier of the experience. type: string example: 597cf7f51b60fc59c0d6d79588047c62 displayName: description: The name of the experience. type: string example: Demo.pdf description: description: The description of the experience. type: string nullable: true example: My asset description type: description: The type of the experience. type: string example: profile extension: description: The extension of the experience. type: string nullable: true example: null appLink: description: The app link of the experience. type: string example: 'showpad://profile/2802' previewUrls: description: The preview URLs of the experience. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/preview/v6.0' thumbnailUrls: description: The thumbnail URLs of the experience. type: array items: type: string example: 'https://demo.showpad.biz/api/v3/assets/597cf7f51b60fc59c0d6d79588047c62/thumbnail/v1.1' coverFocalPoint: description: The focal point of the cover image of the experience. type: string nullable: true example: 0.48/0.38 createdAt: description: The creation date of the experience. type: string format: date-time example: '2022-11-08T09:53:56+00:00' updatedAt: description: The last update date of the experience. type: string format: date-time example: '2022-11-08T09:53:56+00:00' security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: startedAt description: 'Calculate popularity taking into account views or shares after this date only (YYYY-MM-DD, YYYY-MM-DD HH:mm:ss or timestamp) (default: 1 year ago)' required: false in: query schema: type: string format: date - name: endedAt description: 'Calculate popularity taking into account views or shares before this date only (YYYY-MM-DD, YYYY-MM-DD HH:mm:ss or timestamp) (default: now)' required: false in: query schema: type: string format: date - name: notViewedAfter description: 'Exclude assets that have been viewed by user after this date (default: now)' required: false in: query schema: type: string format: date - name: limit description: 'Return maximum this number of assets (default: 10)' required: false in: query schema: type: integer format: int32 /tags.json: get: deprecated: true tags: - tags operationId: get_tags description: |- Generates a list of Tag items. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getTags). summary: /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 resourcetype: description: The type of resource type: string href: description: Url link to the tag type: string assets: description: The assets linked to this tag type: object properties: href: type: string format: link type: description: The type of tag type: string createdAt: description: The date that the tag was created type: string format: date-time description: description: Description of the tag type: string division: description: The division of the tag type: object properties: href: type: string format: link id: type: string divisionId: description: The division ID of the tag type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true name: description: Name of the tag type: string updatedAt: description: The date that the tag was updated type: string format: date-time externalService: description: External Service of the tag as used in the source application type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - 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 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: 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 tag 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. 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: true tags: - tags operationId: post_tags description: |- Create a Tag item. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/postTags). summary: /tags.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object location: type: string nullable: true 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: Url link to the tag type: string assets: description: The assets linked to this tag type: object properties: href: type: string format: link type: description: The type of tag type: string createdAt: description: The date that the tag was created type: string format: date-time description: description: Description of the tag type: string division: description: The division of the tag type: object properties: href: type: string format: link id: type: string divisionId: description: The division ID of the tag type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true name: description: Name of the tag type: string updatedAt: description: The date that the tag was updated type: string format: date-time externalService: description: External Service of the tag as used in the source application type: string format: link nullable: true 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: name: type: string description: type: string divisionId: type: string externalId: type: string required: - name application/json: schema: type: object properties: name: type: string description: type: string divisionId: type: string externalId: type: string required: - name /tags/count.json: get: deprecated: false tags: - tags operationId: get_tags_count description: Retrieve the number of Tag items summary: /tags/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 security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - 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: externalId description: External ID of the tag as used in the source application required: false in: query schema: type: string - name: name description: Name of the tag 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 /tags/description.json: get: deprecated: false tags: - tags operationId: get_tags_description description: Generates information about the Tag model and available apis summary: /tags/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 '/tags/{id1}/assets/{id2}.json': get: deprecated: false tags: - tags operationId: get_tags_id1_assets_id2 description: Link or unlink an tag with ID = 'id1' to a asset with ID = 'id2' summary: '/tags/{id1}/assets/{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 parameters: - name: id1 description: ID of the Tag item required: true in: path schema: type: string - name: id2 description: ID of the Asset 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 '/tags/{id1}/assets/{id2}/link.json': post: deprecated: true tags: - tags operationId: link_tags_id1_assets_id2_link description: |- Link a tag with ID = 'id1' to an asset with ID = 'id2'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateAsset). summary: '/tags/{id1}/assets/{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 parameters: - name: id1 description: ID of the Tag item required: true in: path schema: type: string - name: id2 description: ID of the Asset 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 '/tags/{id1}/assets/{id2}/unlink.json': post: deprecated: true tags: - tags operationId: unlink_tags_id1_assets_id2_unlink description: |- Unlink a tag with ID = 'id1' from an asset with ID = 'id2'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateAsset). summary: '/tags/{id1}/assets/{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 parameters: - name: id1 description: ID of the Tag item required: true in: path schema: type: string - name: id2 description: ID of the Asset 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 '/tags/{id}.json': get: deprecated: true tags: - tags operationId: get_tags_id description: |- Retrieve Tag item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getTag). summary: '/tags/{id}.json' responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object location: type: string nullable: true 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: Url link to the tag type: string assets: description: The assets linked to this tag type: object properties: href: type: string format: link type: description: The type of tag type: string createdAt: description: The date that the tag was created type: string format: date-time description: description: Description of the tag type: string division: description: The division of the tag type: object properties: href: type: string format: link id: type: string divisionId: description: The division ID of the tag type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true name: description: Name of the tag type: string updatedAt: description: The date that the tag was updated type: string format: date-time externalService: description: External Service of the tag as used in the source application type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: id description: ID of the Tag 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: 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: - tags operationId: put_tags_id description: Update the Tag item with ID='id' summary: '/tags/{id}.json' responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object location: type: string nullable: true 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: Url link to the tag type: string assets: description: The assets linked to this tag type: object properties: href: type: string format: link type: description: The type of tag type: string createdAt: description: The date that the tag was created type: string format: date-time description: description: Description of the tag type: string division: description: The division of the tag type: object properties: href: type: string format: link id: type: string divisionId: description: The division ID of the tag type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true name: description: Name of the tag type: string updatedAt: description: The date that the tag was updated type: string format: date-time externalService: description: External Service of the tag as used in the source application type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Tag 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 - 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: description: type: string divisionId: type: string externalId: type: string name: type: string application/json: schema: type: object properties: description: type: string divisionId: type: string externalId: type: string name: type: string post: deprecated: true tags: - tags operationId: post_tags_id description: |- Update the Tag item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateTag). summary: '/tags/{id}.json' responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object location: type: string nullable: true 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: Url link to the tag type: string assets: description: The assets linked to this tag type: object properties: href: type: string format: link type: description: The type of tag type: string createdAt: description: The date that the tag was created type: string format: date-time description: description: Description of the tag type: string division: description: The division of the tag type: object properties: href: type: string format: link id: type: string divisionId: description: The division ID of the tag type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true name: description: Name of the tag type: string updatedAt: description: The date that the tag was updated type: string format: date-time externalService: description: External Service of the tag as used in the source application type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Tag 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 - 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: description: type: string divisionId: type: string externalId: type: string name: type: string application/json: schema: type: object properties: description: type: string divisionId: type: string externalId: type: string name: type: string delete: deprecated: true tags: - tags operationId: delete_tags_id description: |- Delete the Tag item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/deleteTag). summary: '/tags/{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 Tag 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 '/tags/{id}/assets.json': get: deprecated: false tags: - tags operationId: get_tags_id_assets description: Get all assets that belong to the tag with ID='id' summary: '/tags/{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: 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 nullable: true 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 nullable: true shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: string nullable: true shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: integer format: int32 nullable: true externalId: description: External ID of the asset as used in the source application type: string nullable: true 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 nullable: true 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 nullable: true format: date archivedAt: description: The date that the file was sent to trash type: string nullable: true format: date expiresAt: description: The expiry date of the asset type: string nullable: true format: date releasedAt: description: The release date of the asset type: string nullable: true format: date draftedAt: description: The draft date of the asset type: string nullable: true format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: array nullable: true items: type: string pageCount: description: 'The number of pages the document has, if applicable' type: integer nullable: true 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 nullable: true currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: string nullable: true format: link channelTemplateConfigId: description: Channel template config ID type: string nullable: true 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 nullable: true 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 nullable: true format: int32 duration: description: Duration of the media type: integer nullable: true format: int32 wordCount: description: 'The number of words the asset contains, if applicable' type: integer nullable: true 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 nullable: true items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: array nullable: true items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: string nullable: true fileUuid: description: The Uuid of the current file type: string nullable: true 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 nullable: true 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 Tag 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 post: deprecated: false tags: - tags operationId: post_tags_id_assets description: Add an asset to a tag with ID='id' summary: '/tags/{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: 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 nullable: true 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 nullable: true shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: string nullable: true shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: integer format: int32 nullable: true externalId: description: External ID of the asset as used in the source application type: string nullable: true 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 nullable: true 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 nullable: true format: date archivedAt: description: The date that the file was sent to trash type: string nullable: true format: date expiresAt: description: The expiry date of the asset type: string nullable: true format: date releasedAt: description: The release date of the asset type: string nullable: true format: date draftedAt: description: The draft date of the asset type: string nullable: true format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: array nullable: true items: type: string pageCount: description: 'The number of pages the document has, if applicable' type: integer nullable: true 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 nullable: true currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: string nullable: true format: link channelTemplateConfigId: description: Channel template config ID type: string nullable: true 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 nullable: true 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 nullable: true format: int32 duration: description: Duration of the media type: integer nullable: true format: int32 wordCount: description: 'The number of words the asset contains, if applicable' type: integer nullable: true 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 nullable: true items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: array nullable: true items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: string nullable: true fileUuid: description: The Uuid of the current file type: string nullable: true 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 nullable: true oAuth2ClientId: description: The OAuth2 client that can manage the asset via an external service type: string security: - oAuth: - write_contentprofile_management parameters: - name: id description: ID of the Tag 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: multipart/form-data: schema: type: object properties: channelTemplateConfigId: type: string description: type: string expiresAt: type: string format: date externalDate: type: string format: date externalId: type: string externalServiceId: type: string file: type: string format: binary filetype: 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 hideLabel: type: boolean icon: type: string format: binary isAnnotatable: type: boolean isDivisionShared: type: boolean isDownloadable: type: boolean isEditable: type: boolean isPersonal: type: boolean isSensitive: type: boolean isShareable: type: boolean liked: type: boolean lockedPages: type: array items: type: string name: type: string oAuth2ClientId: type: string onlyShareEntireDocument: type: boolean postProcessingInstructions: type: string releasedAt: type: string format: date draftedAt: type: string format: date slug: type: string url: type: string useOptimized: type: boolean '/tags/{id}/link.json': post: deprecated: true tags: - tags operationId: link_tags_id_link description: |- Link the Tag item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateAsset). summary: '/tags/{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 Tag 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 '/tags/{id}/unlink.json': post: deprecated: true tags: - tags operationId: unlink_tags_id_unlink description: |- Link the Tag item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateAsset). summary: '/tags/{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 Tag 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 /tickets.json: get: deprecated: false tags: - tickets operationId: get_tickets description: Generates a list of Ticket items summary: /tickets.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 asset: description: The location of the asset type: string format: link completedAt: description: The date processing was completed type: string format: date division: description: The location of the division type: string format: link divisionId: description: The id of the division type: string queuedAt: description: The date the asset was queued for processing type: string format: date startedAt: description: The date Showpad started processing the asset type: string format: date status: description: Current status of the asset type: string user: description: The location of the user responsible for submitting the asset type: string format: link type: description: The type of the ticket resource type: string provisionalAssetId: description: Asset ID that will be used if the file is processed correctly type: string assetFilename: description: The filename of the file that's being processed type: string materialisedPath: description: The materialised path that describes the location of the asset (when available) type: string assetFileType: description: The type of the asset file type: string previewUrl: description: The preview URL for the ticket type: string thumbnailUrl: description: The thumbnail URL for the ticket type: string canBeForceUsed: description: Is the related element allowed to be used on failure of this ticket type: boolean onlyCustomerTypes: description: Only include asset types which are customer facing type: boolean onlyUnfinished: description: Only include jobs which have not finished type: boolean includeNonRequired: description: Include non-required jobs type: boolean security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - 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: divisionId description: The id of the division 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: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - name: includeNonRequired description: Include non-required jobs 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: 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: onlyCustomerTypes description: Only include asset types which are customer facing required: false in: query schema: type: boolean - name: onlyUnfinished description: Only include jobs which have not finished 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 queuedAt, status.' required: false in: query schema: type: string - name: status description: Current status of the asset required: false in: query schema: type: string anyOf: - title: queued type: string - title: processing type: string - title: completed type: string - title: failed 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 /tickets/cancel: post: deprecated: false tags: - tickets operationId: post_tickets_cancel description: Cancel the ticket summary: /tickets/cancel 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 /tickets/count.json: get: deprecated: false tags: - tickets operationId: get_tickets_count description: Retrieve the number of Ticket items summary: /tickets/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 security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - 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: divisionId description: The id of the division required: false in: query schema: type: string - name: includeNonRequired description: Include non-required jobs required: false in: query schema: type: boolean - name: onlyCustomerTypes description: Only include asset types which are customer facing required: false in: query schema: type: boolean - name: onlyUnfinished description: Only include jobs which have not finished required: false in: query schema: type: boolean - name: status description: Current status of the asset required: false in: query schema: type: string anyOf: - title: queued type: string - title: processing type: string - title: completed type: string - title: failed 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 /tickets/description.json: get: deprecated: false tags: - tickets operationId: get_tickets_description description: Generates information about the Ticket model and available apis summary: /tickets/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 /tickets/force-use: post: deprecated: false tags: - tickets operationId: post_tickets_force-use description: 'Force using the related element on the ticket, only if the ticket has failed' summary: /tickets/force-use 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 '/tickets/{ids}/processingtime.json': get: deprecated: false tags: - tickets operationId: get_tickets_ids_processingtime description: Retrieve processing time for Ticket items with IDs='ids' summary: '/tickets/{ids}/processingtime.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 asset: description: The location of the asset type: string format: link completedAt: description: The date processing was completed type: string format: date division: description: The location of the division type: string format: link divisionId: description: The id of the division type: string queuedAt: description: The date the asset was queued for processing type: string format: date startedAt: description: The date Showpad started processing the asset type: string format: date status: description: Current status of the asset type: string user: description: The location of the user responsible for submitting the asset type: string format: link type: description: The type of the ticket resource type: string provisionalAssetId: description: Asset ID that will be used if the file is processed correctly type: string assetFilename: description: The filename of the file that's being processed type: string materialisedPath: description: The materialised path that describes the location of the asset (when available) type: string assetFileType: description: The type of the asset file type: string previewUrl: description: The preview URL for the ticket type: string thumbnailUrl: description: The thumbnail URL for the ticket type: string canBeForceUsed: description: Is the related element allowed to be used on failure of this ticket type: boolean onlyCustomerTypes: description: Only include asset types which are customer facing type: boolean onlyUnfinished: description: Only include jobs which have not finished type: boolean includeNonRequired: description: Include non-required jobs type: boolean security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: ids description: Comma separated list of IDs of the Ticket items 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 '/tickets/{id}.json': get: deprecated: false tags: - tickets operationId: get_tickets_id description: Retrieve Ticket item with ID='id' summary: '/tickets/{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 asset: description: The location of the asset type: string format: link completedAt: description: The date processing was completed type: string format: date division: description: The location of the division type: string format: link divisionId: description: The id of the division type: string queuedAt: description: The date the asset was queued for processing type: string format: date startedAt: description: The date Showpad started processing the asset type: string format: date status: description: Current status of the asset type: string user: description: The location of the user responsible for submitting the asset type: string format: link type: description: The type of the ticket resource type: string provisionalAssetId: description: Asset ID that will be used if the file is processed correctly type: string assetFilename: description: The filename of the file that's being processed type: string materialisedPath: description: The materialised path that describes the location of the asset (when available) type: string assetFileType: description: The type of the asset file type: string previewUrl: description: The preview URL for the ticket type: string thumbnailUrl: description: The thumbnail URL for the ticket type: string canBeForceUsed: description: Is the related element allowed to be used on failure of this ticket type: boolean onlyCustomerTypes: description: Only include asset types which are customer facing type: boolean onlyUnfinished: description: Only include jobs which have not finished type: boolean includeNonRequired: description: Include non-required jobs type: boolean security: - bearerAuth: [] - oAuth: - read_contentprofile_management parameters: - name: id description: ID of the Ticket 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: 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 delete: deprecated: false tags: - tickets operationId: delete_tickets_id description: Delete the Ticket item with ID='id' summary: '/tickets/{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 Ticket 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 '/tickets/{id}/cancel': post: deprecated: false tags: - tickets operationId: post_tickets_id_cancel description: Cancel the ticket summary: '/tickets/{id}/cancel' 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 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 '/tickets/{id}/force-use': post: deprecated: false tags: - tickets operationId: post_tickets_id_force-use description: 'Force using the related element on the ticket, only if the ticket has failed' summary: '/tickets/{id}/force-use' 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 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 /users.json: get: deprecated: true tags: - users operationId: get_users description: |- Generates a list of User items. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getUsers). For more detailed information on when to use V3 or V4, please refer to [User Management](https://developer.showpad.com/docs/apis/users/user-management). summary: /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 nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true security: - bearerAuth: [] - oAuth: - read_user_management parameters: - 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 enum: - avatar - divisionpermissions - lastUsedDevice - managedUsergroups - promotedDivisions - usergroups - userpermission - 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: - users operationId: post_users description: Create a User item summary: /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 nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true security: - bearerAuth: [] - oAuth: - write_user_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 enum: - avatar - divisionpermissions - lastUsedDevice - managedUsergroups - promotedDivisions - usergroups - userpermission - 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: 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 /users/count.json: get: deprecated: false tags: - users operationId: get_users_count description: Retrieve the number of User items summary: /users/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 security: - bearerAuth: [] - oAuth: - read_user_management parameters: - 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: externalId description: External ID of the user as used in the source application 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: 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: 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 /users/description.json: get: deprecated: false tags: - users operationId: get_users_description description: Generates information about the User model and available apis summary: /users/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_user_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 /users/invite.json: get: deprecated: false tags: - users operationId: get_users_invite description: Send an invite to all users who have a pending invitation summary: /users/invite.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 nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true security: - bearerAuth: [] - oAuth: - read_user_management parameters: - 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 /users/me.json: get: deprecated: false tags: - users operationId: get_users_me description: Generates information about the current API user summary: /users/me.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 nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true security: - bearerAuth: [] - oAuth: - read_user_management parameters: - name: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string enum: - avatar - divisionpermissions - lastUsedDevice - managedUsergroups - promotedDivisions - usergroups - userpermission - 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 /users/me/recommendations.json: get: deprecated: false tags: - users operationId: get_users_me_recommendations description: Get recommendations for the current user summary: /users/me/recommendations.json responses: default: description: successful operation content: application/json: schema: type: object security: - bearerAuth: [] - oAuth: - read_user_management - read_contentprofile_management parameters: - name: recommendationsType description: 'Indicates the type of recommendations you want to fetch (default: homescreen)' required: false in: query schema: type: string /users/me/tickets.json: get: deprecated: false tags: - users operationId: get_users_me_tickets description: Get tickets for the current user summary: /users/me/tickets.json responses: default: description: successful operation content: application/json: schema: type: object security: - bearerAuth: [] - oAuth: - read_user_management - read_contentprofile_management parameters: - name: recommendationsType description: 'Indicates the type of recommendations you want to fetch (default: homescreen)' required: false in: query schema: type: string '/users/{id1}/usergroups/{id2}.json': get: deprecated: false tags: - users operationId: get_users_id1_usergroups_id2 description: Link or unlink an user with ID = 'id1' to a usergroup with ID = 'id2' summary: '/users/{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_user_management parameters: - name: id1 description: ID of the User 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 '/users/{id1}/usergroups/{id2}/link.json': post: deprecated: false tags: - users operationId: link_users_id1_usergroups_id2_link description: Link a user with ID = 'id1' to a usergroup with ID = 'id2' summary: '/users/{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_user_management parameters: - name: id1 description: ID of the User 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 '/users/{id1}/usergroups/{id2}/unlink.json': post: deprecated: false tags: - users operationId: unlink_users_id1_usergroups_id2_unlink description: Unlink a user with ID = 'id1' from an usergroup with ID = 'id2' summary: '/users/{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_user_management parameters: - name: id1 description: ID of the User 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 '/users/{id}.json': get: deprecated: true tags: - users operationId: get_users_id description: |- Retrieve User item with ID='id'. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getUserById). For more detailed information on when to use V3 or V4, please refer to [User Management](https://developer.showpad.com/docs/apis/users/user-management). summary: '/users/{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 apiKey: description: The API key of the user type: string nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true security: - bearerAuth: [] - oAuth: - read_user_management parameters: - name: id 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: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string enum: - avatar - divisionpermissions - lastUsedDevice - managedUsergroups - promotedDivisions - usergroups - userpermission - 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: - users operationId: put_users_id description: Update the User item with ID='id' summary: '/users/{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 apiKey: description: The API key of the user type: string nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true security: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id description: ID of the User 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: - avatar - divisionpermissions - lastUsedDevice - managedUsergroups - promotedDivisions - usergroups - userpermission - 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: bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean email: type: string emailNotifications: type: boolean emailSignature: type: string externalId: type: string firstName: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date isActive: type: boolean isSynced: type: boolean language: type: string lastName: type: string managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean timezone: type: string userName: type: string userType: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string application/json: schema: type: object properties: bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean email: type: string emailNotifications: type: boolean emailSignature: type: string externalId: type: string firstName: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date isActive: type: boolean isSynced: type: boolean language: type: string lastName: type: string managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean timezone: type: string userName: type: string userType: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string post: deprecated: false tags: - users operationId: post_users_id description: Update the User item with ID='id' summary: '/users/{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 apiKey: description: The API key of the user type: string nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true security: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id description: ID of the User 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: - avatar - divisionpermissions - lastUsedDevice - managedUsergroups - promotedDivisions - usergroups - userpermission - 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: bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean email: type: string emailNotifications: type: boolean emailSignature: type: string externalId: type: string firstName: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date isActive: type: boolean isSynced: type: boolean description: 'When the value is changed from `true` to `false`, other property updates will be ignored.' language: type: string lastName: type: string managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean timezone: type: string userName: type: string userType: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string application/json: schema: type: object properties: bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean email: type: string emailNotifications: type: boolean emailSignature: type: string externalId: type: string firstName: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date isActive: type: boolean isSynced: type: boolean language: type: string lastName: type: string managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean timezone: type: string userName: type: string userType: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string delete: deprecated: false tags: - users operationId: delete_users_id description: Delete the User item with ID='id' summary: '/users/{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_user_management parameters: - name: id 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 '/users/{id}/channels.json': get: deprecated: false tags: - users operationId: get_users_id_channels description: Get all channels that belong to the user with ID='id' summary: '/users/{id}/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 format: link nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true properties: id: type: string href: type: string format: link currentTemplateAsset: description: The template app linked to this channel type: string format: link nullable: true 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 nullable: true 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 format: date-time nullable: true logo: description: The logo image linked to this channel type: string format: link nullable: true 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 nullable: true 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 nullable: true 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_user_management - read_content_profile_management parameters: - name: id description: ID of the User item required: true in: path schema: type: string - 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 '/users/{id}/divisionpermissions.json': get: deprecated: false tags: - users operationId: get_users_id_divisionpermissions description: Get all division permissions that belong to the user with ID='id' summary: '/users/{id}/divisionpermissions.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 createdAt: description: The date that the division permission was created type: string format: date-time division: description: The division this division permission belongs to type: object properties: id: type: string href: type: string format: link divisionId: description: Id of the division this division permission belongs to type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true updatedAt: description: The date that the division permission was updated type: string format: date-time user: description: The user this division permission belongs to type: object properties: id: type: string href: type: string format: link userId: description: Id of the user this division permission belongs to type: string manageAssets: description: Whether this permission enables assets management type: boolean manageExperiences: description: Whether this permission enables experiences management type: boolean deleteExperiences: description: Whether this permission enables experiences deletion type: boolean manageCoursesAndChecklists: description: Whether this permission enables courses and checklists management type: boolean manageAiRoleplays: description: Whether this permission enables management of AI roleplays type: boolean manageAnnouncements: description: Whether this permission enables announcements management type: boolean viewUsers: description: Whether this permission enables users view type: boolean manageUsers: description: Whether this permission enables users management type: boolean readinessReporting: description: Whether this permission enables readiness reporting type: boolean contentReporting: description: Whether this permission enables content reporting type: boolean reporting: description: Whether this permission enables reporting type: boolean messaging: description: Whether this permission enables messaging type: boolean manageContent: description: Whether this permission enables content management type: boolean createUserGroups: description: Whether this permission enables user group creation type: boolean manageTags: description: Whether this permission enables tag management type: boolean notifyUsersByEmail: description: Whether this permission enables email notification of users type: boolean expiredAt: description: The date that the division permission was expired type: string format: date-time nullable: true metadata: description: Metadata field for different purposes type: string nullable: true manageSharingThemes: description: Whether this permission allows sharing theme management in case the sharing feature would be enabled type: boolean security: - bearerAuth: [] - oAuth: - read_user_management - read_division_management parameters: - name: id description: ID of the User item required: true in: path schema: type: string - name: contentReporting description: Whether this permission enables content reporting required: false in: query schema: type: boolean - name: createUserGroups description: Whether this permission enables the creation of groups required: false in: query schema: type: boolean - 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: expiredAt description: The date that the division permission was expired required: false in: query schema: type: string format: date - 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: 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: manageAnnouncements description: Whether this permission enables announcements management required: false in: query schema: type: boolean - name: manageAssets description: Whether this permission enables assets management required: false in: query schema: type: boolean - name: manageContent description: Whether this permission enables managing content required: false in: query schema: type: boolean - name: manageCoursesAndChecklists description: Whether this permission enables courses and checklists management required: false in: query schema: type: boolean - name: manageAiRoleplays description: Whether this permission enables management of AI roleplays required: false in: query schema: type: boolean - name: manageExperiences description: Whether this permission enables experiences management required: false in: query schema: type: boolean - name: deleteExperiences description: Whether this permission enables experiences deletion required: false in: query schema: type: boolean - name: manageUsers description: Whether this permission enables users management required: false in: query schema: type: boolean - name: messaging description: Whether this permission enables messaging required: false in: query schema: type: boolean - name: metadata description: Metadata field for different purposes 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: post type: string - name: notifyUsersByEmail description: Whether this permission enables email notification of users required: false in: query schema: type: boolean - 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: readinessReporting description: Whether this permission enables readiness reporting required: false in: query schema: type: boolean - name: reporting description: Whether this permission enables reporting 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. 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: viewUsers description: Whether this permission enables users view required: false in: query schema: type: boolean post: deprecated: false tags: - users operationId: post_users_id_divisionpermissions description: Add a division permission to a user with ID='id' summary: '/users/{id}/divisionpermissions.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 createdAt: description: The date that the division permission was created type: string format: date-time division: description: The division this division permission belongs to type: object properties: id: type: string href: type: string format: link divisionId: description: Id of the division this division permission belongs to type: string externalId: description: External ID of the tag as used in the source application type: string nullable: true updatedAt: description: The date that the division permission was updated type: string format: date-time user: description: The user this division permission belongs to type: object properties: id: type: string href: type: string format: link userId: description: Id of the user this division permission belongs to type: string manageAssets: description: Whether this permission enables assets management type: boolean manageExperiences: description: Whether this permission enables experiences management type: boolean deleteExperiences: description: Whether this permission enables experiences deletion type: boolean manageCoursesAndChecklists: description: Whether this permission enables courses and checklists management type: boolean manageAiRoleplays: description: Whether this permission enables management of AI roleplays type: boolean manageAnnouncements: description: Whether this permission enables announcements management type: boolean viewUsers: description: Whether this permission enables users view type: boolean manageUsers: description: Whether this permission enables users management type: boolean readinessReporting: description: Whether this permission enables readiness reporting type: boolean contentReporting: description: Whether this permission enables content reporting type: boolean reporting: description: Whether this permission enables reporting type: boolean messaging: description: Whether this permission enables messaging type: boolean manageContent: description: Whether this permission enables content management type: boolean createUserGroups: description: Whether this permission enables user group creation type: boolean manageTags: description: Whether this permission enables tag management type: boolean notifyUsersByEmail: description: Whether this permission enables email notification of users type: boolean expiredAt: description: The date that the division permission was expired type: string format: date-time nullable: true metadata: description: Metadata field for different purposes type: string nullable: true manageSharingThemes: description: Whether this permission allows sharing theme management in case the sharing feature would be enabled type: boolean security: - bearerAuth: [] - oAuth: - write_user_management - write_division_management parameters: - name: id 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 requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: divisionId: type: string userId: type: string contentReporting: type: boolean expiredAt: type: string format: date externalId: type: string manageAnnouncements: type: boolean manageAssets: type: boolean manageCoursesAndChecklists: type: boolean manageAiRoleplays: type: boolean manageExperiences: type: boolean deleteExperiences: type: boolean manageUsers: type: boolean metadata: type: string notifyUsersByEmail: type: boolean readinessReporting: type: boolean viewUsers: type: boolean required: - divisionId - userId application/json: schema: type: object properties: divisionId: type: string userId: type: string contentReporting: type: boolean expiredAt: type: string format: date externalId: type: string manageAnnouncements: type: boolean manageAssets: type: boolean manageCoursesAndChecklists: type: boolean manageAiRoleplays: type: boolean manageExperiences: type: boolean deleteExperiences: type: boolean manageUsers: type: boolean metadata: type: string notifyUsersByEmail: type: boolean readinessReporting: type: boolean viewUsers: type: boolean required: - divisionId - userId '/users/{id}/divisions.json': get: deprecated: false tags: - users operationId: get_users_id_divisions description: Get all divisions that belong to the user with ID='id' summary: '/users/{id}/divisions.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 assets: description: The assets linked to this division type: object properties: href: type: string format: link comments: description: The comments linked to this division type: object properties: href: type: string format: link channels: description: The channels linked to this division type: object properties: href: type: string format: link createdAt: description: The date that the division was created type: string format: date-time updatedAt: description: The date that the division was updated type: string format: date-time externalId: description: External ID of the tag as used in the source application type: string nullable: true hasDivisionAssetSharingEnabled: description: If the division has enabled assets sharing type: boolean name: description: The name of the division type: string tags: description: The tags linked to this division type: object properties: href: type: string format: link tickets: description: The tickets linked to this division type: object properties: href: type: string format: link usergroups: description: The groups linked to this division type: object properties: href: type: string format: link defaultCatalogSetting: type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - read_user_management - read_division_management parameters: - name: id 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: 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: hasDivisionAssetSharingEnabled description: If the division has enabled assets sharing 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 division 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 '/users/{id}/email-preferences.json': get: deprecated: false tags: - users operationId: get_users_id_email-preferences description: Get the email preference that belongs to the current user summary: '/users/{id}/email-preferences.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_user_management - read_contentprofile_management parameters: - name: id 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: 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: 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: 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 post: deprecated: false tags: - users operationId: post_users_id_email-preferences description: Get the email preference that belongs to the current user summary: '/users/{id}/email-preferences.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_user_management - write_contentprofile_management parameters: - name: id 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 requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: activitiesSubscriptionEnabled: type: boolean commentsSubscriptionEnabled: type: boolean contentAddedSubscriptionEnabled: type: boolean insightsSubscriptionEnabled: type: boolean mentionsSubscriptionEnabled: type: boolean userJoinedSubscriptionEnabled: type: boolean application/json: schema: type: object properties: activitiesSubscriptionEnabled: type: boolean commentsSubscriptionEnabled: type: boolean contentAddedSubscriptionEnabled: type: boolean insightsSubscriptionEnabled: type: boolean mentionsSubscriptionEnabled: type: boolean userJoinedSubscriptionEnabled: type: boolean '/users/{id}/externalservices.json': get: deprecated: false tags: - users operationId: get_users_id_externalservices description: Get the external service that belongs to the current user summary: '/users/{id}/externalservices.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 division: description: The division of the external service type: string format: link type: description: The type of the external service type: string name: description: The name of the external service type: string externalId: description: The external id provided by the external service type: string createdAt: description: The created at of the external service type: string format: date updatedAt: description: The updated at of the external service type: string format: date security: - bearerAuth: [] - oAuth: - read_user_management - read_content_profile_management parameters: - name: id 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: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string - name: externalId description: The external id provided by the external service 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: 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 external service 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. 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: The type of the external service required: false in: query schema: type: string '/users/{id}/invite.json': get: deprecated: false tags: - users operationId: get_users_id_invite description: Send an invitation email to a single user summary: '/users/{id}/invite.json' responses: default: description: successful operation content: application/json: schema: type: object security: - bearerAuth: [] - oAuth: - read_user_management parameters: - name: id description: '' required: true in: path schema: type: string '/users/{id}/link.json': post: deprecated: false tags: - users operationId: link_users_id_link description: Link the User item with ID='id' summary: '/users/{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_user_management parameters: - name: id 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 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 '/users/{id}/unlink.json': post: deprecated: false tags: - users operationId: unlink_users_id_unlink description: Link the User item with ID='id' summary: '/users/{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_user_management parameters: - name: id 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 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 '/users/{id}/usergroups.json': get: deprecated: false tags: - users operationId: get_users_id_usergroups description: Get all usergroups that belong to the user with ID='id' summary: '/users/{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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true security: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id 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: 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: - users operationId: post_users_id_usergroups description: Add a usergroup to a user with ID='id' summary: '/users/{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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true security: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id 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 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 /usergroups.json: get: deprecated: false tags: - usergroups operationId: get_usergroups description: Generates a list of Usergroup items summary: /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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true security: - bearerAuth: [] - oAuth: - read_user_management parameters: - 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: - experiences - managers - tags - users - 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: - usergroups operationId: post_usergroups description: Create a Usergroup item summary: /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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true security: - bearerAuth: [] - oAuth: - write_user_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 enum: - experiences - managers - tags - users - 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: 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 /usergroups/count.json: get: deprecated: false tags: - usergroups operationId: get_usergroups_count description: Retrieve the number of Usergroup items summary: /usergroups/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 security: - bearerAuth: [] - oAuth: - read_user_management parameters: - 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: externalId description: External ID of the usergroup as used in the source application required: false in: query schema: type: string - name: isSynced description: Show that usergroup is synced required: false in: query schema: type: boolean - name: name description: Name of the usergroup 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 /usergroups/description.json: get: deprecated: false tags: - usergroups operationId: get_usergroups_description description: Generates information about the Usergroup model and available apis summary: /usergroups/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_user_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 '/usergroups/{id1}/divisions/{id2}.json': get: deprecated: false tags: - usergroups operationId: get_usergroups_id1_divisions_id2 description: Link or unlink an usergroup with ID = 'id1' to a division with ID = 'id2' summary: '/usergroups/{id1}/divisions/{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_user_management - write_division_management parameters: - name: id1 description: ID of the Usergroup item required: true in: path schema: type: string - name: id2 description: ID of the Division 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 '/usergroups/{id1}/divisions/{id2}/link.json': post: deprecated: false tags: - usergroups operationId: link_usergroups_id1_divisions_id2_link description: Link a usergroup with ID = 'id1' to a division with ID = 'id2' summary: '/usergroups/{id1}/divisions/{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_user_management - write_division_management parameters: - name: id1 description: ID of the Usergroup item required: true in: path schema: type: string - name: id2 description: ID of the Division 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 '/usergroups/{id1}/divisions/{id2}/unlink.json': post: deprecated: false tags: - usergroups operationId: unlink_usergroups_id1_divisions_id2_unlink description: Unlink a usergroup with ID = 'id1' from a division with ID = 'id2' summary: '/usergroups/{id1}/divisions/{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_user_management - write_division_management parameters: - name: id1 description: ID of the Usergroup item required: true in: path schema: type: string - name: id2 description: ID of the Division 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 '/usergroups/{id1}/users/{id2}.json': get: deprecated: false tags: - usergroups operationId: get_usergroups_id1_users_id2 description: Link or unlink an usergroup with ID = 'id1' to a user with ID = 'id2' summary: '/usergroups/{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: [] - oAuth: - write_user_management parameters: - name: id1 description: ID of the Usergroup 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 '/usergroups/{id1}/users/{id2}/link.json': post: deprecated: false tags: - usergroups operationId: link_usergroups_id1_users_id2_link description: Link a usergroup with ID = 'id1' to a user with ID = 'id2' summary: '/usergroups/{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_user_management parameters: - name: id1 description: ID of the Usergroup 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 '/usergroups/{id1}/users/{id2}/unlink.json': post: deprecated: false tags: - usergroups operationId: unlink_usergroups_id1_users_id2_unlink description: Unlink a usergroup with ID = 'id1' from an user with ID = 'id2' summary: '/usergroups/{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_user_management parameters: - name: id1 description: ID of the Usergroup 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 '/usergroups/{id}.json': get: deprecated: false tags: - usergroups operationId: get_usergroups_id description: Retrieve Usergroup item with ID='id' summary: '/usergroups/{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 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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true security: - bearerAuth: [] - oAuth: - read_user_management parameters: - name: id 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: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string enum: - experiences - managers - tags - users - 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: - usergroups operationId: put_usergroups_id description: Update the Usergroup item with ID='id' summary: '/usergroups/{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 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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true security: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id description: ID of the Usergroup 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: - experiences - managers - tags - users - 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: contentProfiles: type: array items: type: string description: type: string externalId: type: string isSynced: type: boolean name: type: string provisionedBy: type: string application/json: schema: type: object properties: contentProfiles: type: array items: type: string description: type: string externalId: type: string isSynced: type: boolean name: type: string provisionedBy: type: string post: deprecated: false tags: - usergroups operationId: post_usergroups_id description: Update the Usergroup item with ID='id' summary: '/usergroups/{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 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 nullable: true 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 format: int32 nullable: true deactivatedUserCount: description: The amount of deactivated users in this group. type: integer format: int32 nullable: true pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: integer format: int32 nullable: true neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: integer format: int32 nullable: true numberOfDirectLicenses: description: The number of direct licenses. type: integer format: int32 nullable: true numberOfPartnerLicenses: description: The number of partner licenses. type: integer format: int32 nullable: true numberOfViewOnlyLicenses: description: The number of view only licenses. type: integer format: int32 nullable: true isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: boolean nullable: true provisionedBy: description: The system that provisioned this usergroup. type: string nullable: true security: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id description: ID of the Usergroup 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: - experiences - managers - tags - users - 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: contentProfiles: type: array items: type: string description: type: string externalId: type: string isSynced: type: boolean name: type: string provisionedBy: type: string application/json: schema: type: object properties: contentProfiles: type: array items: type: string description: type: string externalId: type: string isSynced: type: boolean name: type: string provisionedBy: type: string delete: deprecated: false tags: - usergroups operationId: delete_usergroups_id description: Delete the Usergroup item with ID='id' summary: '/usergroups/{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_user_management parameters: - name: id 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 '/usergroups/{id}/divisions.json': get: deprecated: false tags: - usergroups operationId: get_usergroups_id_divisions description: Get all divisions that belong to the usergroup with ID='id' summary: '/usergroups/{id}/divisions.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 assets: description: The assets linked to this division type: object properties: href: type: string format: link comments: description: The comments linked to this division type: object properties: href: type: string format: link channels: description: The channels linked to this division type: object properties: href: type: string format: link createdAt: description: The date that the division was created type: string format: date-time updatedAt: description: The date that the division was updated type: string format: date-time externalId: description: External ID of the tag as used in the source application type: string nullable: true hasDivisionAssetSharingEnabled: description: If the division has enabled assets sharing type: boolean name: description: The name of the division type: string tags: description: The tags linked to this division type: object properties: href: type: string format: link tickets: description: The tickets linked to this division type: object properties: href: type: string format: link usergroups: description: The groups linked to this division type: object properties: href: type: string format: link defaultCatalogSetting: type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - read_user_management - read_division_management parameters: - name: id 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: 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: hasDivisionAssetSharingEnabled description: If the division has enabled assets sharing 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 division 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: - usergroups operationId: post_usergroups_id_divisions description: Add a division to a usergroup with ID='id' summary: '/usergroups/{id}/divisions.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 assets: description: The assets linked to this division type: object properties: href: type: string format: link comments: description: The comments linked to this division type: object properties: href: type: string format: link channels: description: The channels linked to this division type: object properties: href: type: string format: link createdAt: description: The date that the division was created type: string format: date-time updatedAt: description: The date that the division was updated type: string format: date-time externalId: description: External ID of the tag as used in the source application type: string nullable: true hasDivisionAssetSharingEnabled: description: If the division has enabled assets sharing type: boolean name: description: The name of the division type: string tags: description: The tags linked to this division type: object properties: href: type: string format: link tickets: description: The tickets linked to this division type: object properties: href: type: string format: link usergroups: description: The groups linked to this division type: object properties: href: type: string format: link defaultCatalogSetting: type: string format: link nullable: true security: - bearerAuth: [] - oAuth: - write_user_management - write_division_management parameters: - name: id 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 requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: name: type: string externalId: type: string hasDivisionAssetSharingEnabled: type: boolean required: - name application/json: schema: type: object properties: name: type: string externalId: type: string hasDivisionAssetSharingEnabled: type: boolean required: - name '/usergroups/{id}/link.json': post: deprecated: false tags: - usergroups operationId: link_usergroups_id_link description: Link the Usergroup item with ID='id' summary: '/usergroups/{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_user_management parameters: - name: id 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 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 '/usergroups/{id}/unlink.json': post: deprecated: false tags: - usergroups operationId: unlink_usergroups_id_unlink description: Link the Usergroup item with ID='id' summary: '/usergroups/{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_user_management parameters: - name: id 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 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 '/usergroups/{id}/users.json': get: deprecated: false tags: - usergroups operationId: get_usergroups_id_users description: Get all users that belong to the usergroup with ID='id' summary: '/usergroups/{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 nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true security: - bearerAuth: [] - oAuth: - read_user_management parameters: - name: id 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: 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: - usergroups operationId: post_usergroups_id_users description: Add an users to a usergroup with ID='id' summary: '/usergroups/{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 nullable: true avatar: description: The Avatar linked to this user type: string format: link nullable: true companyName: description: User's company name type: string companyRole: description: User's company role type: string nullable: true consentGivenAt: description: The date at which the user consented to the current privacy policy type: string format: date nullable: true consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: string nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true insightsLastViewedAt: description: Last time Showpad Insights was viewed type: string format: date nullable: true invitationConfirmedAt: description: Confirmation date of the initial user invitation type: string format: date-time nullable: true 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 format: date nullable: true lastInvitationSentAt: description: Date of the last sent invitation email type: string format: date-time nullable: true lastInvitationStatus: description: Status of the last sent invitation email type: string nullable: true lastLogin: description: The date the user last logged in type: string format: date nullable: true 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 format: link nullable: true 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 nullable: true 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 nullable: true 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 nullable: true 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 nullable: true uuid: description: Uuid of the user type: string nullable: true security: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id 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 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 /userpermissions.json: get: deprecated: false tags: - userpermissions operationId: get_userpermissions description: Generates a list of UserPermission items summary: /userpermissions.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 the tablet permission was created type: string format: date crm: description: Whether this permission enables the use of CRM type: boolean externalId: description: External ID of the tablet permission as used in the source application type: string fileCommenting: description: Whether this permission enables file commenting type: boolean name: description: Name of the Tablet Permission type: string personalCatalog: description: Whether this permission enables personal catalog viewing type: boolean updatedAt: description: The date the tablet permission was updated type: string format: date users: description: The users linked to this tablet permission type: string format: link webAccess: description: Whether this permission enables web access type: boolean smartPhoneAccess: description: Whether this permission enables smart phone access type: boolean personalContent: description: Whether this permission enables personal content type: boolean tagSearch: description: Whether this permission enables tag search type: boolean fileRating: description: Whether this permission enables file ratings type: boolean externalFileSystemImport: description: Whether this permission enables external file system import type: boolean advancedReporting: description: Whether this permission enables advanced reporting type: boolean salesforceIntegration: description: Whether this permission enables Salesforce Integration type: boolean salesEngagement: description: Whether this permission enables Sales engagement type: boolean locationSharing: description: What type of location sharing this user can undergo type: string collections: description: Whether to enable Collections type: boolean kioskMode: description: Whether kiosk mode is allowed type: boolean notifications: description: Whether receiving notifications is allowed type: boolean contactBrowser: description: Whether browsing contacts is allowed type: boolean contactExport: description: Whether exporting contacts is allowed type: boolean contactForm: description: Whether contact form is allowed type: boolean contactSync: description: Whether contact sync to the platform is allowed type: boolean channelTemplate: description: Whether this permission enables channel templates type: boolean canManageUsersAndGroups: description: Whether the user can manage users & user groups in the OP type: boolean canManageAssets: description: Whether the user can manage assets in the OP type: boolean canManageExperiences: description: Whether the user can manage experiences type: boolean canDeleteExperiences: description: Whether the user can delete experiences type: boolean canViewUsers: description: Whether the user can view users type: boolean canManageUsers: description: Whether the user can manage users type: boolean canContentReporting: description: Whether the user has access to content reporting in the OP type: boolean canTrainingReporting: description: Whether the user can has access to training & coaching reporting in the OP type: boolean canManageAnnouncements: description: Whether the user can manage announcements in the OP type: boolean canManageTags: description: Whether the user can can manage tags in the OP type: boolean canManageCoursesAndChecklists: description: Whether the user can can manage courses & checklists in the OP type: boolean canManageAiRoleplays: description: Whether user can manage AI roleplays type: boolean sharing: description: Whether the user has access to sharing type: boolean sharedSpaces: description: Whether the user has access to shared spaces type: boolean canManageContentProfiles: description: Whether user can manage content profiles type: boolean security: - bearerAuth: [] - oAuth: - read_user_management parameters: - name: advancedReporting description: Whether this permission enables advanced reporting required: false in: query schema: type: boolean - name: channelTemplate description: Whether this permission enables channel templates required: false in: query schema: type: boolean - name: collections description: Whether to enable Collections required: false in: query schema: type: boolean - name: contactBrowser description: Whether browsing contacts is allowed required: false in: query schema: type: boolean - name: contactExport description: Whether exporting contacts is allowed required: false in: query schema: type: boolean - name: contactForm description: Whether contact form is allowed required: false in: query schema: type: boolean - name: contactSync description: Whether contact sync to the platform is allowed required: false in: query schema: type: boolean - name: crm description: Whether this permission enables the use of CRM required: false in: query schema: type: boolean - 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: externalFileSystemImport description: Whether this permission enables external file system import required: false in: query schema: type: boolean - name: externalId description: External ID of the tablet permission 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: fileCommenting description: Whether this permission enables file commenting required: false in: query schema: type: boolean - name: fileRating description: Whether this permission enables file ratings required: false in: query schema: type: boolean - name: kioskMode description: Whether kiosk mode is allowed 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 Tablet Permission required: false in: query schema: type: string - name: notifications description: Whether receiving notifications is allowed required: false in: query schema: type: boolean - 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: personalCatalog description: Whether this permission enables personal catalog viewing required: false in: query schema: type: boolean - name: personalContent description: Whether this permission enables personal content required: false in: query schema: type: boolean - name: salesEngagement description: Whether this permission enables Sales engagement required: false in: query schema: type: boolean - name: salesforceIntegration description: Whether this permission enables Salesforce Integration required: false in: query schema: type: boolean - name: smartPhoneAccess description: Whether this permission enables smart phone access 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. 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: tagSearch description: Whether this permission enables tag search required: false in: query schema: type: boolean - name: webAccess description: Whether this permission enables web access required: false in: query schema: type: boolean post: deprecated: false tags: - userpermissions operationId: post_userpermissions description: Create a UserPermission item summary: /userpermissions.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 createdAt: description: The date the tablet permission was created type: string format: date crm: description: Whether this permission enables the use of CRM type: boolean externalId: description: External ID of the tablet permission as used in the source application type: string fileCommenting: description: Whether this permission enables file commenting type: boolean name: description: Name of the Tablet Permission type: string personalCatalog: description: Whether this permission enables personal catalog viewing type: boolean updatedAt: description: The date the tablet permission was updated type: string format: date users: description: The users linked to this tablet permission type: string format: link webAccess: description: Whether this permission enables web access type: boolean smartPhoneAccess: description: Whether this permission enables smart phone access type: boolean personalContent: description: Whether this permission enables personal content type: boolean tagSearch: description: Whether this permission enables tag search type: boolean fileRating: description: Whether this permission enables file ratings type: boolean externalFileSystemImport: description: Whether this permission enables external file system import type: boolean advancedReporting: description: Whether this permission enables advanced reporting type: boolean salesforceIntegration: description: Whether this permission enables Salesforce Integration type: boolean salesEngagement: description: Whether this permission enables Sales engagement type: boolean locationSharing: description: What type of location sharing this user can undergo type: string collections: description: Whether to enable Collections type: boolean kioskMode: description: Whether kiosk mode is allowed type: boolean notifications: description: Whether receiving notifications is allowed type: boolean contactBrowser: description: Whether browsing contacts is allowed type: boolean contactExport: description: Whether exporting contacts is allowed type: boolean contactForm: description: Whether contact form is allowed type: boolean contactSync: description: Whether contact sync to the platform is allowed type: boolean channelTemplate: description: Whether this permission enables channel templates type: boolean canManageUsersAndGroups: description: Whether the user can manage users & user groups in the OP type: boolean canManageAssets: description: Whether the user can manage assets in the OP type: boolean canManageExperiences: description: Whether the user can manage experiences type: boolean canDeleteExperiences: description: Whether the user can delete experiences type: boolean canViewUsers: description: Whether the user can view users type: boolean canManageUsers: description: Whether the user can manage users type: boolean canContentReporting: description: Whether the user has access to content reporting in the OP type: boolean canTrainingReporting: description: Whether the user can has access to training & coaching reporting in the OP type: boolean canManageAnnouncements: description: Whether the user can manage announcements in the OP type: boolean canManageTags: description: Whether the user can can manage tags in the OP type: boolean canManageCoursesAndChecklists: description: Whether the user can can manage courses & checklists in the OP type: boolean canManageAiRoleplays: description: Whether user can manage AI roleplays type: boolean sharing: description: Whether the user has access to sharing type: boolean sharedSpaces: description: Whether the user has access to shared spaces type: boolean canManageContentProfiles: description: Whether user can manage content profiles type: boolean security: - bearerAuth: [] - oAuth: - write_user_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: advancedReporting: type: boolean collections: type: boolean contactBrowser: type: boolean contactExport: type: boolean contactForm: type: boolean contactSync: type: boolean crm: type: boolean externalFileSystemImport: type: boolean fileCommenting: type: boolean fileRating: type: boolean kioskMode: type: boolean name: type: string notifications: type: boolean personalCatalog: type: boolean personalContent: type: boolean salesEngagement: type: boolean salesforceIntegration: type: boolean smartPhoneAccess: type: boolean tagSearch: type: boolean webAccess: type: boolean externalId: type: string required: - advancedReporting - collections - contactBrowser - contactExport - contactForm - contactSync - crm - externalFileSystemImport - fileCommenting - fileRating - kioskMode - name - notifications - personalCatalog - personalContent - salesEngagement - salesforceIntegration - smartPhoneAccess - tagSearch - webAccess application/json: schema: type: object properties: advancedReporting: type: boolean collections: type: boolean contactBrowser: type: boolean contactExport: type: boolean contactForm: type: boolean contactSync: type: boolean crm: type: boolean externalFileSystemImport: type: boolean fileCommenting: type: boolean fileRating: type: boolean kioskMode: type: boolean name: type: string notifications: type: boolean personalCatalog: type: boolean personalContent: type: boolean salesEngagement: type: boolean salesforceIntegration: type: boolean smartPhoneAccess: type: boolean tagSearch: type: boolean webAccess: type: boolean externalId: type: string required: - advancedReporting - collections - contactBrowser - contactExport - contactForm - contactSync - crm - externalFileSystemImport - fileCommenting - fileRating - kioskMode - name - notifications - personalCatalog - personalContent - salesEngagement - salesforceIntegration - smartPhoneAccess - tagSearch - webAccess /userpermissions/count.json: get: deprecated: false tags: - userpermissions operationId: get_userpermissions_count description: Retrieve the number of UserPermission items summary: /userpermissions/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 security: - bearerAuth: [] - oAuth: - read_user_management parameters: - name: advancedReporting description: Whether this permission enables advanced reporting required: false in: query schema: type: boolean - name: channelTemplate description: Whether this permission enables channel templates required: false in: query schema: type: boolean - name: collections description: Whether to enable Collections required: false in: query schema: type: boolean - name: contactBrowser description: Whether browsing contacts is allowed required: false in: query schema: type: boolean - name: contactExport description: Whether exporting contacts is allowed required: false in: query schema: type: boolean - name: contactForm description: Whether contact form is allowed required: false in: query schema: type: boolean - name: contactSync description: Whether contact sync to the platform is allowed required: false in: query schema: type: boolean - name: crm description: Whether this permission enables the use of CRM required: false in: query schema: type: boolean - 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: externalFileSystemImport description: Whether this permission enables external file system import required: false in: query schema: type: boolean - name: externalId description: External ID of the tablet permission as used in the source application required: false in: query schema: type: string - name: fileCommenting description: Whether this permission enables file commenting required: false in: query schema: type: boolean - name: fileRating description: Whether this permission enables file ratings required: false in: query schema: type: boolean - name: kioskMode description: Whether kiosk mode is allowed required: false in: query schema: type: boolean - name: name description: Name of the Tablet Permission required: false in: query schema: type: string - name: notifications description: Whether receiving notifications is allowed required: false in: query schema: type: boolean - name: personalCatalog description: Whether this permission enables personal catalog viewing required: false in: query schema: type: boolean - name: personalContent description: Whether this permission enables personal content required: false in: query schema: type: boolean - name: salesEngagement description: Whether this permission enables Sales engagement required: false in: query schema: type: boolean - name: salesforceIntegration description: Whether this permission enables Salesforce Integration required: false in: query schema: type: boolean - name: smartPhoneAccess description: Whether this permission enables smart phone access 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: tagSearch description: Whether this permission enables tag search required: false in: query schema: type: boolean - name: webAccess description: Whether this permission enables web access required: false in: query schema: type: boolean /userpermissions/description.json: get: deprecated: false tags: - userpermissions operationId: get_userpermissions_description description: Generates information about the UserPermission model and available apis summary: /userpermissions/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_user_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 '/userpermissions/{id}.json': get: deprecated: false tags: - userpermissions operationId: get_userpermissions_id description: Retrieve UserPermission item with ID='id' summary: '/userpermissions/{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 createdAt: description: The date the tablet permission was created type: string format: date crm: description: Whether this permission enables the use of CRM type: boolean externalId: description: External ID of the tablet permission as used in the source application type: string fileCommenting: description: Whether this permission enables file commenting type: boolean name: description: Name of the Tablet Permission type: string personalCatalog: description: Whether this permission enables personal catalog viewing type: boolean updatedAt: description: The date the tablet permission was updated type: string format: date users: description: The users linked to this tablet permission type: string format: link webAccess: description: Whether this permission enables web access type: boolean smartPhoneAccess: description: Whether this permission enables smart phone access type: boolean personalContent: description: Whether this permission enables personal content type: boolean tagSearch: description: Whether this permission enables tag search type: boolean fileRating: description: Whether this permission enables file ratings type: boolean externalFileSystemImport: description: Whether this permission enables external file system import type: boolean advancedReporting: description: Whether this permission enables advanced reporting type: boolean salesforceIntegration: description: Whether this permission enables Salesforce Integration type: boolean salesEngagement: description: Whether this permission enables Sales engagement type: boolean locationSharing: description: What type of location sharing this user can undergo type: string collections: description: Whether to enable Collections type: boolean kioskMode: description: Whether kiosk mode is allowed type: boolean notifications: description: Whether receiving notifications is allowed type: boolean contactBrowser: description: Whether browsing contacts is allowed type: boolean contactExport: description: Whether exporting contacts is allowed type: boolean contactForm: description: Whether contact form is allowed type: boolean contactSync: description: Whether contact sync to the platform is allowed type: boolean channelTemplate: description: Whether this permission enables channel templates type: boolean canManageUsersAndGroups: description: Whether the user can manage users & user groups in the OP type: boolean canManageAssets: description: Whether the user can manage assets in the OP type: boolean canManageExperiences: description: Whether the user can manage experiences type: boolean canDeleteExperiences: description: Whether the user can delete experiences type: boolean canViewUsers: description: Whether the user can view users type: boolean canManageUsers: description: Whether the user can manage users type: boolean canContentReporting: description: Whether the user has access to content reporting in the OP type: boolean canTrainingReporting: description: Whether the user can has access to training & coaching reporting in the OP type: boolean canManageAnnouncements: description: Whether the user can manage announcements in the OP type: boolean canManageTags: description: Whether the user can can manage tags in the OP type: boolean canManageCoursesAndChecklists: description: Whether the user can can manage courses & checklists in the OP type: boolean canManageAiRoleplays: description: Whether user can manage AI roleplays type: boolean sharing: description: Whether the user has access to sharing type: boolean sharedSpaces: description: Whether the user has access to shared spaces type: boolean canManageContentProfiles: description: Whether user can manage content profiles type: boolean security: - bearerAuth: [] - oAuth: - read_user_management parameters: - name: id description: ID of the UserPermission 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: 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: - userpermissions operationId: put_userpermissions_id description: Update the UserPermission item with ID='id' summary: '/userpermissions/{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 createdAt: description: The date the tablet permission was created type: string format: date crm: description: Whether this permission enables the use of CRM type: boolean externalId: description: External ID of the tablet permission as used in the source application type: string fileCommenting: description: Whether this permission enables file commenting type: boolean name: description: Name of the Tablet Permission type: string personalCatalog: description: Whether this permission enables personal catalog viewing type: boolean updatedAt: description: The date the tablet permission was updated type: string format: date users: description: The users linked to this tablet permission type: string format: link webAccess: description: Whether this permission enables web access type: boolean smartPhoneAccess: description: Whether this permission enables smart phone access type: boolean personalContent: description: Whether this permission enables personal content type: boolean tagSearch: description: Whether this permission enables tag search type: boolean fileRating: description: Whether this permission enables file ratings type: boolean externalFileSystemImport: description: Whether this permission enables external file system import type: boolean advancedReporting: description: Whether this permission enables advanced reporting type: boolean salesforceIntegration: description: Whether this permission enables Salesforce Integration type: boolean salesEngagement: description: Whether this permission enables Sales engagement type: boolean locationSharing: description: What type of location sharing this user can undergo type: string collections: description: Whether to enable Collections type: boolean kioskMode: description: Whether kiosk mode is allowed type: boolean notifications: description: Whether receiving notifications is allowed type: boolean contactBrowser: description: Whether browsing contacts is allowed type: boolean contactExport: description: Whether exporting contacts is allowed type: boolean contactForm: description: Whether contact form is allowed type: boolean contactSync: description: Whether contact sync to the platform is allowed type: boolean channelTemplate: description: Whether this permission enables channel templates type: boolean canManageUsersAndGroups: description: Whether the user can manage users & user groups in the OP type: boolean canManageAssets: description: Whether the user can manage assets in the OP type: boolean canManageExperiences: description: Whether the user can manage experiences type: boolean canDeleteExperiences: description: Whether the user can delete experiences type: boolean canViewUsers: description: Whether the user can view users type: boolean canManageUsers: description: Whether the user can manage users type: boolean canContentReporting: description: Whether the user has access to content reporting in the OP type: boolean canTrainingReporting: description: Whether the user can has access to training & coaching reporting in the OP type: boolean canManageAnnouncements: description: Whether the user can manage announcements in the OP type: boolean canManageTags: description: Whether the user can can manage tags in the OP type: boolean canManageCoursesAndChecklists: description: Whether the user can can manage courses & checklists in the OP type: boolean canManageAiRoleplays: description: Whether user can manage AI roleplays type: boolean sharing: description: Whether the user has access to sharing type: boolean sharedSpaces: description: Whether the user has access to shared spaces type: boolean canManageContentProfiles: description: Whether user can manage content profiles type: boolean security: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id description: ID of the UserPermission 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 - 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: advancedReporting: type: boolean collections: type: boolean contactBrowser: type: boolean contactExport: type: boolean contactForm: type: boolean contactSync: type: boolean crm: type: boolean externalFileSystemImport: type: boolean externalId: type: string fileCommenting: type: boolean fileRating: type: boolean kioskMode: type: boolean name: type: string notifications: type: boolean personalCatalog: type: boolean personalContent: type: boolean salesEngagement: type: boolean salesforceIntegration: type: boolean smartPhoneAccess: type: boolean tagSearch: type: boolean webAccess: type: boolean application/json: schema: type: object properties: advancedReporting: type: boolean collections: type: boolean contactBrowser: type: boolean contactExport: type: boolean contactForm: type: boolean contactSync: type: boolean crm: type: boolean externalFileSystemImport: type: boolean externalId: type: string fileCommenting: type: boolean fileRating: type: boolean kioskMode: type: boolean name: type: string notifications: type: boolean personalCatalog: type: boolean personalContent: type: boolean salesEngagement: type: boolean salesforceIntegration: type: boolean smartPhoneAccess: type: boolean tagSearch: type: boolean webAccess: type: boolean post: deprecated: false tags: - userpermissions operationId: post_userpermissions_id description: Update the UserPermission item with ID='id' summary: '/userpermissions/{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 createdAt: description: The date the tablet permission was created type: string format: date crm: description: Whether this permission enables the use of CRM type: boolean externalId: description: External ID of the tablet permission as used in the source application type: string fileCommenting: description: Whether this permission enables file commenting type: boolean name: description: Name of the Tablet Permission type: string personalCatalog: description: Whether this permission enables personal catalog viewing type: boolean updatedAt: description: The date the tablet permission was updated type: string format: date users: description: The users linked to this tablet permission type: string format: link webAccess: description: Whether this permission enables web access type: boolean smartPhoneAccess: description: Whether this permission enables smart phone access type: boolean personalContent: description: Whether this permission enables personal content type: boolean tagSearch: description: Whether this permission enables tag search type: boolean fileRating: description: Whether this permission enables file ratings type: boolean externalFileSystemImport: description: Whether this permission enables external file system import type: boolean advancedReporting: description: Whether this permission enables advanced reporting type: boolean salesforceIntegration: description: Whether this permission enables Salesforce Integration type: boolean salesEngagement: description: Whether this permission enables Sales engagement type: boolean locationSharing: description: What type of location sharing this user can undergo type: string collections: description: Whether to enable Collections type: boolean kioskMode: description: Whether kiosk mode is allowed type: boolean notifications: description: Whether receiving notifications is allowed type: boolean contactBrowser: description: Whether browsing contacts is allowed type: boolean contactExport: description: Whether exporting contacts is allowed type: boolean contactForm: description: Whether contact form is allowed type: boolean contactSync: description: Whether contact sync to the platform is allowed type: boolean channelTemplate: description: Whether this permission enables channel templates type: boolean canManageUsersAndGroups: description: Whether the user can manage users & user groups in the OP type: boolean canManageAssets: description: Whether the user can manage assets in the OP type: boolean canManageExperiences: description: Whether the user can manage experiences type: boolean canDeleteExperiences: description: Whether the user can delete experiences type: boolean canViewUsers: description: Whether the user can view users type: boolean canManageUsers: description: Whether the user can manage users type: boolean canContentReporting: description: Whether the user has access to content reporting in the OP type: boolean canTrainingReporting: description: Whether the user can has access to training & coaching reporting in the OP type: boolean canManageAnnouncements: description: Whether the user can manage announcements in the OP type: boolean canManageTags: description: Whether the user can can manage tags in the OP type: boolean canManageCoursesAndChecklists: description: Whether the user can can manage courses & checklists in the OP type: boolean canManageAiRoleplays: description: Whether user can manage AI roleplays type: boolean sharing: description: Whether the user has access to sharing type: boolean sharedSpaces: description: Whether the user has access to shared spaces type: boolean canManageContentProfiles: description: Whether user can manage content profiles type: boolean security: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id description: ID of the UserPermission 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 - 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: advancedReporting: type: boolean collections: type: boolean contactBrowser: type: boolean contactExport: type: boolean contactForm: type: boolean contactSync: type: boolean crm: type: boolean externalFileSystemImport: type: boolean externalId: type: string fileCommenting: type: boolean fileRating: type: boolean kioskMode: type: boolean name: type: string notifications: type: boolean personalCatalog: type: boolean personalContent: type: boolean salesEngagement: type: boolean salesforceIntegration: type: boolean smartPhoneAccess: type: boolean tagSearch: type: boolean webAccess: type: boolean application/json: schema: type: object properties: advancedReporting: type: boolean collections: type: boolean contactBrowser: type: boolean contactExport: type: boolean contactForm: type: boolean contactSync: type: boolean crm: type: boolean externalFileSystemImport: type: boolean externalId: type: string fileCommenting: type: boolean fileRating: type: boolean kioskMode: type: boolean name: type: string notifications: type: boolean personalCatalog: type: boolean personalContent: type: boolean salesEngagement: type: boolean salesforceIntegration: type: boolean smartPhoneAccess: type: boolean tagSearch: type: boolean webAccess: type: boolean delete: deprecated: false tags: - userpermissions operationId: delete_userpermissions_id description: Delete the UserPermission item with ID='id' summary: '/userpermissions/{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_user_management parameters: - name: id description: ID of the UserPermission 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 '/userpermissions/{id}/link.json': post: deprecated: false tags: - userpermissions operationId: link_userpermissions_id_link description: Link the UserPermission item with ID='id' summary: '/userpermissions/{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_user_management parameters: - name: id description: ID of the UserPermission 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 '/userpermissions/{id}/unlink.json': post: deprecated: false tags: - userpermissions operationId: unlink_userpermissions_id_unlink description: Link the UserPermission item with ID='id' summary: '/userpermissions/{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_user_management parameters: - name: id description: ID of the UserPermission 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 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). security: - oAuth: [] - bearerAuth: []