Showpad Divisions API

openapi: 3.2.0
info:
  title: Showpad Divisions 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 divisions 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: divisions
  description: ''
paths:
  /divisions.json:
    get:
      deprecated: true
      tags:
      - divisions
      operationId: get_divisions
      description: 'Generates a list of Division items.


        *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getDivisions).'
      summary: /divisions.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                required:
                - response
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
                            type: string
                          name:
                            type: string
                  response:
                    type: object
                    properties:
                      count:
                        description: Total number of results.
                        type: integer
                        format: int32
                        example: 20
                      items:
                        type: array
                        description: List of resources.
                        items:
                          type: object
                          properties:
                            id:
                              description: Unique identifier for the resource
                              type: string
                            resourcetype:
                              description: The type of resource
                              type: string
                            href:
                              description: Location of the resource
                              type: string
                              format: link
                            assets:
                              description: The assets linked to this division
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
                            comments:
                              description: The comments linked to this division
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
                            channels:
                              description: The channels linked to this division
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
                            createdAt:
                              description: The date that the division was created
                              type: string
                              format: date-time
                            updatedAt:
                              description: The date that the division was updated
                              type: string
                              format: date-time
                            externalId:
                              description: External ID of the tag as used in the source application
                              type:
                              - string
                              - 'null'
                            hasDivisionAssetSharingEnabled:
                              description: If the division has enabled assets sharing
                              type: boolean
                            name:
                              description: The name of the division
                              type: string
                            tags:
                              description: The tags linked to this division
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
                            tickets:
                              description: The tickets linked to this division
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
                            usergroups:
                              description: The groups linked to this division
                              type: object
                              properties:
                                href:
                                  type: string
                                  format: link
                            defaultCatalogSetting:
                              type:
                              - string
                              - 'null'
                              format: link
      security:
      - bearerAuth: []
      - oAuth:
        - read_division_management
      parameters:
      - name: describe_apis
        description: Describes the different api calls available together with the allowed parameters
        required: false
        in: query
        schema:
          type: boolean
      - name: describe_model
        description: Describes the data model behind the resource including properties and their description
        required: false
        in: query
        schema:
          type: boolean
      - name: expand
        description: Comma separated list of all expanded relationships that need to be retrieved.
        required: false
        in: query
        schema:
          type: string
      - name: externalId
        description: External ID of the tag as used in the source application
        required: false
        in: query
        schema:
          type: string
      - name: fields
        description: Comma separated list of all fields that need to be retrieved.
        required: false
        in: query
        schema:
          type: string
      - name: hasDivisionAssetSharingEnabled
        description: If the division has enabled assets sharing
        required: false
        in: query
        schema:
          type: boolean
      - name: limit
        description: Sets the maximum number of returned items. The maximum limit is set to 1000. For example, if 'limit' is 0, only 0 items will be retrieved.
        required: false
        in: query
        schema:
          type: integer
          format: int32
          minimum: 0
          maximum: 1000
      - name: method
        description: '''method'' can be used by HTTP clients who are not able to set certain HTTP verbs such as a DELETE of a PUT'
        required: false
        in: query
        schema:
          type: string
          anyOf:
          - title: post
            type: string
      - name: name
        description: The name of the division
        required: false
        in: query
        schema:
          type: string
      - name: offset
        description: Set the offset of the returned items.For example, if 'offset' is 5 and 'limit' is 10,  items 6 to 15 will be returned.
        required: false
        in: query
        schema:
          type: integer
          format: int32
          minimum: 0
      - name: sort
        description: The field you want to sort on. Adding a '-' in front of the field name allows you to sort descending. Allowed values are name.
        required: false
        in: query
        schema:
          type: string
      - name: suppress_response_codes
        description: 'This forces the HTTP status code of the response to be set to 200 '
        required: false
        in: query
        schema:
          type: boolean
    post:
      deprecated: false
      tags:
      - divisions
      operationId: post_divisions
      description: Create a Division item
      summary: /divisions.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                required:
                - response
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
                            type: string
                          name:
                            type: string
                  response:
                    type: object
                    properties:
                      id:
                        description: Unique identifier for the resource
                        type: string
                      resourcetype:
                        description: The type of resource
                        type: string
                      href:
                        description: Location of the resource
                        type: string
                        format: link
                      assets:
                        description: The assets linked to this division
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
                      comments:
                        description: The comments linked to this division
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
                      channels:
                        description: The channels linked to this division
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
                      createdAt:
                        description: The date that the division was created
                        type: string
                        format: date-time
                      updatedAt:
                        description: The date that the division was updated
                        type: string
                        format: date-time
                      externalId:
                        description: External ID of the tag as used in the source application
                        type:
                        - string
                        - 'null'
                      hasDivisionAssetSharingEnabled:
                        description: If the division has enabled assets sharing
                        type: boolean
                      name:
                        description: The name of the division
                        type: string
                      tags:
                        description: The tags linked to this division
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
                      tickets:
                        description: The tickets linked to this division
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
                      usergroups:
                        description: The groups linked to this division
                        type: object
                        properties:
                          href:
                            type: string
                            format: link
                      defaultCatalogSetting:
                        type:
                        - string
                        - 'null'
                        format: link
      security:
      - bearerAuth: []
      - oAuth:
        - write_division_management
      parameters:
      - name: Link
        description: A comma-separated list of '<resourceID>; rel="ResourceType"'
        required: false
        in: header
        schema:
          type: string
      - name: describe_apis
        description: Describes the different api calls available together with the allowed parameters
        required: false
        in: query
        schema:
          type: boolean
      - name: describe_model
        description: Describes the data model behind the resource including properties and their description
        required: false
        in: query
        schema:
          type: boolean
      - name: expand
        description: Comma separated list of all expanded relationships that need to be retrieved.
        required: false
        in: query
        schema:
          type: string
      - name: fields
        description: Comma separated list of all fields that need to be retrieved.
        required: false
        in: query
        schema:
          type: string
      - name: suppress_response_codes
        description: 'This forces the HTTP status code of the response to be set to 200 '
        required: false
        in: query
        schema:
          type: boolean
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                name:
                  type: string
                externalId:
                  type: string
                hasDivisionAssetSharingEnabled:
                  type: boolean
              required:
              - name
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                externalId:
                  type: string
                hasDivisionAssetSharingEnabled:
                  type: boolean
              required:
              - name
    servers:
    - url: https://{subdomain}.showpad.biz/api/v3/
      description: Production server
      x-environment: production
      variables:
        subdomain:
          default: customer
          description: Showpad customer subdomain
  /divisions/count.json:
    get:
      deprecated: false
      tags:
      - divisions
      operationId: get_divisions_count
      description: Retrieve the number of Division items
      summary: /divisions/count.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
                            type: string
                          name:
                            type: string
                  response:
                    type: object
                    properties:
                      count:
                        type: integer
                        format: int32
      security:
      - bearerAuth: []
      - oAuth:
        - read_division_management
      parameters:
      - name: describe_apis
        description: Describes the different api calls available together with the allowed parameters
        required: false
        in: query
        schema:
          type: boolean
      - name: describe_model
        description: Describes the data model behind the resource including properties and their description
        required: false
        in: query
        schema:
          type: boolean
      - name: externalId
        description: External ID of the tag as used in the source application
        required: false
        in: query
        schema:
          type: string
      - name: hasDivisionAssetSharingEnabled
        description: If the division has enabled assets sharing
        required: false
        in: query
        schema:
          type: boolean
      - name: name
        description: The name of the division
        required: false
        in: query
        schema:
          type: string
      - name: suppress_response_codes
        description: 'This forces the HTTP status code of the response to be set to 200 '
        required: false
        in: query
        schema:
          type: boolean
    servers:
    - url: https://{subdomain}.showpad.biz/api/v3/
      description: Production server
      x-environment: production
      variables:
        subdomain:
          default: customer
          description: Showpad customer subdomain
  /divisions/description.json:
    get:
      deprecated: false
      tags:
      - divisions
      operationId: get_divisions_description
      description: Generates information about the Division model and available apis
      summary: /divisions/description.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
                            type: string
                          name:
                            type: string
                  response:
                    type: object
      security:
      - bearerAuth: []
      - oAuth:
        - read_division_management
      parameters:
      - name: suppress_response_codes
        description: 'This forces the HTTP status code of the response to be set to 200 '
        required: false
        in: query
        schema:
          type: boolean
    servers:
    - url: https://{subdomain}.showpad.biz/api/v3/
      description: Production server
      x-environment: production
      variables:
        subdomain:
          default: customer
          description: Showpad customer subdomain
  /divisions/{id1}/usergroups/{id2}.json:
    get:
      deprecated: false
      tags:
      - divisions
      operationId: get_divisions_id1_usergroups_id2
      description: Link or unlink an division with ID = 'id1' to a usergroup with ID = 'id2'
      summary: /divisions/{id1}/usergroups/{id2}.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
                            type: string
                          name:
                            type: string
      security:
      - bearerAuth: []
      - oAuth:
        - write_division_management
        - write_user_management
      parameters:
      - name: id1
        description: ID of the Division item
        required: true
        in: path
        schema:
          type: string
      - name: id2
        description: ID of the User item
        required: true
        in: path
        schema:
          type: string
      - name: method
        description: '''method'' can be used by HTTP clients who are not able to set certain HTTP verbs such as a DELETE of a PUT'
        required: true
        in: query
        schema:
          type: string
          anyOf:
          - title: link
            type: string
          - title: unlink
            type: string
      - name: describe_apis
        description: Describes the different api calls available together with the allowed parameters
        required: false
        in: query
        schema:
          type: boolean
      - name: describe_model
        description: Describes the data model behind the resource including properties and their description
        required: false
        in: query
        schema:
          type: boolean
      - name: suppress_response_codes
        description: 'This forces the HTTP status code of the response to be set to 200 '
        required: false
        in: query
        schema:
          type: boolean
    servers:
    - url: https://{subdomain}.showpad.biz/api/v3/
      description: Production server
      x-environment: production
      variables:
        subdomain:
          default: customer
          description: Showpad customer subdomain
  /divisions/{id1}/usergroups/{id2}/link.json:
    post:
      deprecated: false
      tags:
      - divisions
      operationId: link_divisions_id1_usergroups_id2_link
      description: Link an division with ID = 'id1' to a usergroup with ID = 'id2'
      summary: /divisions/{id1}/usergroups/{id2}/link.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
                            type: string
                          name:
                            type: string
                  response:
                    type: object
      security:
      - bearerAuth: []
      - oAuth:
        - write_division_management
        - write_user_management
      parameters:
      - name: id1
        description: ID of the Division item
        required: true
        in: path
        schema:
          type: string
      - name: id2
        description: ID of the User item
        required: true
        in: path
        schema:
          type: string
      - name: describe_apis
        description: Describes the different api calls available together with the allowed parameters
        required: false
        in: query
        schema:
          type: boolean
      - name: describe_model
        description: Describes the data model behind the resource including properties and their description
        required: false
        in: query
        schema:
          type: boolean
      - name: suppress_response_codes
        description: 'This forces the HTTP status code of the response to be set to 200 '
        required: false
        in: query
        schema:
          type: boolean
    servers:
    - url: https://{subdomain}.showpad.biz/api/v3/
      description: Production server
      x-environment: production
      variables:
        subdomain:
          default: customer
          description: Showpad customer subdomain
  /divisions/{id1}/usergroups/{id2}/unlink.json:
    post:
      deprecated: false
      tags:
      - divisions
      operationId: unlink_divisions_id1_usergroups_id2_unlink
      description: Unlink an division with ID = 'id1' from a usergroup with ID = 'id2'
      summary: /divisions/{id1}/usergroups/{id2}/unlink.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
                            type: string
                          name:
                            type: string
                  response:
                    type: object
      security:
      - bearerAuth: []
      - oAuth:
        - write_division_management
        - write_user_management
      parameters:
      - name: id1
        description: ID of the Division item
        required: true
        in: path
        schema:
          type: string
      - name: id2
        description: ID of the User item
        required: true
        in: path
        schema:
          type: string
      - name: describe_apis
        description: Describes the different api calls available together with the allowed parameters
        required: false
        in: query
        schema:
          type: boolean
      - name: describe_model
        description: Describes the data model behind the resource including properties and their description
        required: false
        in: query
        schema:
          type: boolean
      - name: suppress_response_codes
        description: 'This forces the HTTP status code of the response to be set to 200 '
        required: false
        in: query
        schema:
          type: boolean
    servers:
    - url: https://{subdomain}.showpad.biz/api/v3/
      description: Production server
      x-environment: production
      variables:
        subdomain:
          default: customer
          description: Showpad customer subdomain
  /divisions/{id}.json:
    get:
      deprecated: true
      tags:
      - divisions
      opera

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