Showpad Exports API

openapi: 3.2.0
info:
  title: Showpad Exports API
  version: '3'
  termsOfService: https://www.showpad.com/terms-of-service
  contact:
    name: Showpad
    email: support@showpad.com
    url: https://help.showpad.com/hc/en-us/requests/new
  x-audience: external-partner
servers:
- url: https://{subdomain}.showpad.biz/api/v3/
  description: Production server
  x-environment: production
  variables:
    subdomain:
      default: customer
      description: Showpad customer subdomain
security:
- oAuth: []
- bearerAuth: []
tags:
- name: exports
  description: ''
paths:
  /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
                              - 'null'
                            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
                              - 'null'
                              format: date-time
                            releasedAt:
                              description: Release date of the asset.
                              type:
                              - string
                              - 'null'
                              format: date-time
                            draftedAt:
                              description: Draft date of the asset.
                              type:
                              - string
                              - 'null'
                              format: date-time
                            deletedAt:
                              description: Timestamp when the asset was deleted. In the Online Platform, all reporting will exclude events after this date.
                              type:
                              - string
                              - 'null'
                              format: date-time
                            uploadedAt:
                              description: Timestamp when the asset is uploaded.
                              type:
                              - string
                              - 'null'
                              format: date-time
                            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
                              - 'null'
                              format: date-time
                            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
                              - 'null'
                            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
                              - 'null'
                              format: int64
                            originalFileSize:
                              description: Filesize of the original asset in bytes.
                              type:
                              - integer
                              - 'null'
                              format: int64
                            originalAssetId:
                              description: The unique identifier of the original asset (in case of edited assets).
                              type:
                              - string
                              - 'null'
                            slug:
                              description: The slug of an asset
                              type:
                              - string
                              - 'null'
      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:
            

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