openapi: 3.2.0
info:
  title: Showpad Tickets 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: tickets
  description: ''
paths:
  /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
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).