Showpad Assets API

openapi: 3.2.0
info:
  title: Showpad Assets API
  contact:
    name: Showpad
    email: support@showpad.com
    url: https://help.showpad.com/hc/en-us/requests/new
  termsOfService: https://www.showpad.com/terms-of-service
  x-audience: external-partner
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged assets across 2 of this provider''s published API definitions: showpad-v3-openapi-original.yml, showpad-v4-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{subdomain}.showpad.biz/api/v3/
  description: Production server
  x-environment: production
  variables:
    subdomain:
      default: customer
      description: Showpad customer subdomain
- url: https://{subdomain}.api.showpad.com/v4
  description: Production server
  x-environment: production
  variables:
    subdomain:
      default: customer
      description: Showpad customer subdomain
tags:
- name: assets
  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
                              - 'null'
                            href:
                              description: Location of the asset
                              type: string
                            division:
                              description: The location of the divisions related to this asset
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
                                id:
                                  type: string
                            downloadLink:
                              description: Link where the file can be downloaded.
                              type:
                              - string
                              - 'null'
                            shortLivedDownloadLink:
                              description: Short-lived link where the file can be publicly downloaded.
                              type:
                              - string
                              - 'null'
                            shortLivedDownloadDuration:
                              description: Amount of days the short-lived download link will be valid for.
                              type:
                              - integer
                              - 'null'
                              format: int32
                            externalId:
                              description: External ID of the asset as used in the source application
                              type:
                              - string
                              - 'null'
                            fileSize:
                              description: Size of the file in bytes
                              type: integer
                              format: int32
                            filetype:
                              description: Type of file
                              type: string
                            processedDownloadLink:
                              description: Link where the processed file can be downloaded
                              type: string
                            isAnnotatable:
                              description: Set to true if you want to allow tablet users to share to annotate this file
                              type: boolean
                            isSensitive:
                              description: Set to true if you do not want this file to be visible in Kiosk mode on the tablet
                              type: boolean
                            isShareable:
                              description: Set to true if you want to allow users to share this file with other people
                              type: boolean
                            isDownloadable:
                              description: Set to true if you want to allow recipients to be able to download this file
                              type: boolean
                            isDivisionShared:
                              description: Set to true if you want to share this file across divisions
                              type: boolean
                            useOptimized:
                              description: Set to true if you want to use the optimized version of this file
                              type: boolean
                            name:
                              description: Display name of the file
                              type: string
                            url:
                              description: Url to link to
                              type:
                              - string
                              - 'null'
                            originalName:
                              description: Original name of the file
                              type: string
                            previewDownloadLink:
                              description: Link where the preview of the file can be downloaded.
                              type: string
                            thumbnailDownloadLink:
                              description: Link where the thumbnail of the file can be downloaded.
                              type: string
                            tags:
                              description: The location of the tags related to this asset
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
                            assetView:
                              description: The location of the asset view related to this asset
                              type: object
                              properties:
                                id:
                                  type: string
                                href:
                                  type: string
                                  format: link
                            updatedAt:
                              description: The date that the file was updated
                              type: string
                              format: date-time
                            views:
                              description: The number of views by tablet users on this file
                              type: integer
                              format: int32
                            appLink:
                              description: Link to asset inside application
                              type: string
                            liked:
                              description: The asset was liked by the current user
                              type: boolean
                            likesCount:
                              description: Count of people who have liked an asset
                              type: integer
                              format: int32
                            standardId:
                              description: Standard ID with version (e.g. ph-135.v1)
                              type: string
                            externalDate:
                              description: An external date of the asset as used in the source application
                              type:
                              - string
                              - 'null'
                              format: date
                            archivedAt:
                              description: The date that the file was sent to trash
                              type:
                              - string
                              - 'null'
                              format: date
                            expiresAt:
                              description: The expiry date of the asset
                              type:
                              - string
                              - 'null'
                              format: date
                            releasedAt:
                              description: The release date of the asset
                              type:
                              - string
                              - 'null'
                              format: date
                            draftedAt:
                              description: The draft date of the asset
                              type:
                              - string
                              - 'null'
                              format: date
                            extension:
                              description: Extension of the file
                              type: string
                            lockedPages:
                              description: The pages that are locked together in this asset
                              type:
                              - array
                              - 'null'
                              items:
                                type: string
                            pageCount:
                              description: The number of pages the document has, if applicable
                              type:
                              - integer
                              - 'null'
                              format: int32
                            onlyShareEntireDocument:
                              description: Whether or not we can only share the entire document
                              type: boolean
                            isPersonal:
                              description: Whether or not the asset is a 'personal' asset - in your own division
                              type: boolean
                            isMarketing:
                              description: Whether or not the asset is a 'marketing' asset - not a personal division
                              type: boolean
                            externalServiceId:
                              description: External Service ID of the asset as used in the source application
                              type:
                              - string
                              - 'null'
                            currentChannelTemplateConfigId:
                              description: Current channel template config ID corresponding to this asset
                              type:
                              - string
                              - 'null'
                              format: link
                            channelTemplateConfigId:
                              description: Channel template config ID
                              type:
                              - string
                              - 'null'
                              format: link
                            slug:
                              description: The slug of the asset (valid and unique UUIDv4)
                              type: string
                            hideLabel:
                              description: Set to true if you want to hide the label for this asset
                              type: boolean
                            isEditable:
                              description: Set true if the asset can be edited in the Showpad Edit App
                              type: boolean
                            sourceAsset:
                              description: The original asset from which this asset was created from
                              type:
                              - string
                              - 'null'
                              format: link
                            sourceAssetName:
                              description: The original asset name from which this asset was created from
                              type: string
                            sourceAssetLink:
                              description: The link to the original asset
                              type: string
                            videoLength:
                              description: Length of the video
                              type:
                              - integer
                              - 'null'
                              format: int32
                            duration:
                              description: Duration of the media
                              type:
                              - integer
                              - 'null'
                              format: int32
                            wordCount:
                              description: The number of words the asset contains, if applicable
                              type:
                              - integer
                              - 'null'
                              format: int32
                            allowRenderExternal:
                              description: Indicates if a url asset should be opened in a new window, or rendered inside showpad (iframe)
                              type: boolean
                            downloadableInternal:
                              description: Indicates type of content that can be downloaded by internal users
                              type:
                              - array
                              - 'null'
                              items:
                                type: string
                            downloadableExternal:
                              description: Indicates type of content that can be downloaded by external users
                              type:
                              - array
                              - 'null'
                              items:
                                type: string
                            md5Checksum:
                              description: The MD5 checksum of the contents of the original file
                              type:
                              - string
                              - 'null'
                            fileUuid:
                              description: The Uuid of the current file
                              type:
                              - string
                              - 'null'
                            version:
                              description: The version of asset as an integer
                              type: integer
                              format: int32
                            parentAssetId:
                              description: The ID of the parent asset if it exist
                              type:
                              - string
                              - 'null'
                            oAuth2ClientId:
                              description: The OAuth2 client that can manage the asset via an external service
                              type: string
      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
                        - 'null'
                      href:
                        description: Location of the asset
                        type: string
                      division:
                        description: The location of the divisions related to this asset
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
                          id:
                            type: string
                      downloadLink:
                        description: Link where the file can be downloaded.
                        type:
                        - string
                        - 'null'
                      shortLivedDownloadLink:
                        description: Short-lived link where the file can be publicly downloaded.
                        type:
                        - string
                        - 'null'
                      shortLivedDownloadDuration:
                        description: Amount of days the short-lived download link will be valid for.
                        type:
                        - integer
                        - 'null'
                        format: int32
                      externalId:
                        description: External ID of the asset as used in the source application
                        type:
                        - string
                        - 'null'
                      fileSize:
                        description: Size of the file in bytes
                        type: integer
                        format: int32
                      filetype:
                        description: Type of file
                        type: string
                      processedDownloadLink:
                        description: Link where the processed file can be downloaded
                        type: string
                      isAnnotatable:
                        description: Set to true if you want to allow tablet users to share to annotate this file
                        type: boolean
                      isSensitive:
                        description: Set to true if you do not want this file to be visible in Kiosk mode on the tablet
                        type: boolean
                      isShareable:
                        description: Set to true if you want to allow users to share this file with other people
                        type: boolean
                      isDownloadable:
                        description: Set to true if you want to allow recipients to be able to download this file
                        type: boolean
                      isDivisionShared:
                        description: Set to true if you want to share this file across divisions
                        type: boolean
                      useOptimized:
                        description: Set to true if you want to use the optimized version of this file
                        type: boolean
                      name:
                        description: Display name of the file
                        type: string
                      url:
                        description: Url to link to
                        type:
                        - string
                        - 'null'
                      originalName:
                        description: Original name of the file
                        type: string
                      previewDownloadLink:
                        description: Link where the preview of the file can be downloaded.
                        type: string
                      thumbnailDownloadLink:
                        description: Link where the thumbnail of the file can be downloaded.
                        type: string
                      tags:
                        description: The location of the tags related to this asset
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
                      assetView:
                        description: The location of the asset view related to this asset
                        type: object
                        properties:
                          id:
                            type: string
                          href:
                            type: string
                            format: link
                      updatedAt:
                        description: The date that the file was updated
                        type: string
                        format: date-time
                      views:
                        descripti

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