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 operationId: get_divisions_id description: 'Retrieve Division item with ID=''id''. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getDivisionById).' summary: /divisions/{id}.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string href: description: Location of the resource type: string format: link assets: description: The assets linked to this division type: object properties: href: type: string format: link comments: description: The comments linked to this division type: object properties: href: type: string format: link channels: description: The channels linked to this division type: object properties: href: type: string format: link createdAt: description: The date that the division was created type: string format: date-time updatedAt: description: The date that the division was updated type: string format: date-time externalId: description: External ID of the tag as used in the source application type: - string - '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: id description: ID of the Division item required: true in: path schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string - name: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - name: method description: '''method'' can be used by HTTP clients who are not able to set certain HTTP verbs such as a DELETE of a PUT' required: false in: query schema: type: string anyOf: - title: get type: string - title: post type: string - title: put type: string - title: delete type: string - title: link type: string - title: unlink type: string - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean put: deprecated: false tags: - divisions operationId: put_divisions_id description: Update the Division item with ID='id' summary: /divisions/{id}.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string href: description: Location of the resource type: string format: link assets: description: The assets linked to this division type: object properties: href: type: string format: link comments: description: The comments linked to this division type: object properties: href: type: string format: link channels: description: The channels linked to this division type: object properties: href: type: string format: link createdAt: description: The date that the division was created type: string format: date-time updatedAt: description: The date that the division was updated type: string format: date-time externalId: description: External ID of the tag as used in the source application type: - string - '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: id description: ID of the Division item required: true in: path schema: type: string - name: Link description: A comma-separated list of '<resourceID>; rel="ResourceType"' required: false in: header schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string - name: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: externalId: type: string hasDivisionAssetSharingEnabled: type: boolean name: type: string application/json: schema: type: object properties: externalId: type: string hasDivisionAssetSharingEnabled: type: boolean name: type: string post: deprecated: false tags: - divisions operationId: post_divisions_id description: Update the Division item with ID='id' summary: /divisions/{id}.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string href: description: Location of the resource type: string format: link assets: description: The assets linked to this division type: object properties: href: type: string format: link comments: description: The comments linked to this division type: object properties: href: type: string format: link channels: description: The channels linked to this division type: object properties: href: type: string format: link createdAt: description: The date that the division was created type: string format: date-time updatedAt: description: The date that the division was updated type: string format: date-time externalId: description: External ID of the tag as used in the source application type: - string - '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: id description: ID of the Division item required: true in: path schema: type: string - name: Link description: A comma-separated list of '<resourceID>; rel="ResourceType"' required: false in: header schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string - name: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: externalId: type: string hasDivisionAssetSharingEnabled: type: boolean name: type: string application/json: schema: type: object properties: externalId: type: string hasDivisionAssetSharingEnabled: type: boolean name: type: string delete: deprecated: false tags: - divisions operationId: delete_divisions_id description: Delete the Division item with ID='id' summary: /divisions/{id}.json responses: default: description: successful operation content: application/json: schema: type: object properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object security: - bearerAuth: [] - oAuth: - write_division_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /divisions/{id}/assets.json: get: deprecated: true tags: - divisions operationId: get_divisions_id_assets description: 'Get all assets that belong to the division with ID=''id''. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/postAssetsQuery) or this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getAssets).' summary: /divisions/{id}/assets.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: count: description: Total number of results. type: integer format: int32 example: 20 items: type: array description: List of resources. items: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string createdAt: description: The date that the file was created type: string format: date-time uploadedAt: description: The date that the file was uploaded type: string format: date-time description: description: Custom description about the file type: - string - 'null' href: description: Location of the asset type: string division: description: The location of the divisions related to this asset type: object properties: href: type: string format: link id: type: string downloadLink: description: Link where the file can be downloaded. type: - string - 'null' shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: - string - 'null' shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: - integer - 'null' format: int32 externalId: description: External ID of the asset as used in the source application type: - string - 'null' fileSize: description: Size of the file in bytes type: integer format: int32 filetype: description: Type of file type: string processedDownloadLink: description: Link where the processed file can be downloaded type: string isAnnotatable: description: Set to true if you want to allow tablet users to share to annotate this file type: boolean isSensitive: description: Set to true if you do not want this file to be visible in Kiosk mode on the tablet type: boolean isShareable: description: Set to true if you want to allow users to share this file with other people type: boolean isDownloadable: description: Set to true if you want to allow recipients to be able to download this file type: boolean isDivisionShared: description: Set to true if you want to share this file across divisions type: boolean useOptimized: description: Set to true if you want to use the optimized version of this file type: boolean name: description: Display name of the file type: string url: description: Url to link to type: - string - 'null' originalName: description: Original name of the file type: string previewDownloadLink: description: Link where the preview of the file can be downloaded. type: string thumbnailDownloadLink: description: Link where the thumbnail of the file can be downloaded. type: string tags: description: The location of the tags related to this asset type: object properties: href: type: string format: link assetView: description: The location of the asset view related to this asset type: object properties: id: type: string href: type: string format: link updatedAt: description: The date that the file was updated type: string format: date-time views: description: The number of views by tablet users on this file type: integer format: int32 appLink: description: Link to asset inside application type: string liked: description: The asset was liked by the current user type: boolean likesCount: description: Count of people who have liked an asset type: integer format: int32 standardId: description: Standard ID with version (e.g. ph-135.v1) type: string externalDate: description: An external date of the asset as used in the source application type: - string - 'null' format: date archivedAt: description: The date that the file was sent to trash type: - string - 'null' format: date expiresAt: description: The expiry date of the asset type: - string - 'null' format: date releasedAt: description: The release date of the asset type: - string - 'null' format: date draftedAt: description: The draft date of the asset type: - string - 'null' format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: - array - 'null' items: type: string pageCount: description: The number of pages the document has, if applicable type: - integer - 'null' format: int32 onlyShareEntireDocument: description: Whether or not we can only share the entire document type: boolean isPersonal: description: Whether or not the asset is a 'personal' asset - in your own division type: boolean isMarketing: description: Whether or not the asset is a 'marketing' asset - not a personal division type: boolean externalServiceId: description: External Service ID of the asset as used in the source application type: - string - 'null' currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: - string - 'null' format: link channelTemplateConfigId: description: Channel template config ID type: - string - 'null' format: link slug: description: The slug of the asset (valid and unique UUIDv4) type: string hideLabel: description: Set to true if you want to hide the label for this asset type: boolean isEditable: description: Set true if the asset can be edited in the Showpad Edit App type: boolean sourceAsset: description: The original asset from which this asset was created from type: - string - 'null' format: link sourceAssetName: description: The original asset name from which this asset was created from type: string sourceAssetLink: description: The link to the original asset type: string videoLength: description: Length of the video type: - integer - 'null' format: int32 duration: description: Duration of the media type: - integer - 'null' format: int32 wordCount: description: The number of words the asset contains, if applicable type: - integer - 'null' format: int32 allowRenderExternal: description: Indicates if a url asset should be opened in a new window, or rendered inside showpad (iframe) type: boolean downloadableInternal: description: Indicates type of content that can be downloaded by internal users type: - array - 'null' items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: - array - 'null' items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: - string - 'null' fileUuid: description: The Uuid of the current file type: - string - 'null' version: description: The version of asset as an integer type: integer format: int32 parentAssetId: description: The ID of the parent asset if it exist type: - string - 'null' oAuth2ClientId: description: The OAuth2 client that can manage the asset via an external service type: string security: - bearerAuth: [] - oAuth: - read_division_management - read_contentprofile_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: archivedAt description: The date that the file was sent to trash required: false in: query schema: type: string format: date - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string - name: externalId description: External ID of the asset as used in the source application required: false in: query schema: type: string - name: externalServiceId description: External Service ID of the asset as used in the source application required: false in: query schema: type: string - name: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - name: filetype description: Type of file required: false in: query schema: type: string anyOf: - title: 3d-model type: string - title: audio type: string - title: document type: string - title: personal-video-recording type: string - title: photo type: string - title: raw type: string - title: scorm type: string - title: video type: string - title: webapp type: string - title: url type: string - title: page type: string - name: hideLabel description: Set to true if you want to hide the label for this asset required: false in: query schema: type: boolean - name: isAnnotatable description: Set to true if you want to allow tablet users to share to annotate this file required: false in: query schema: type: boolean - name: isDivisionShared description: Set to true if you want to share this file across divisions required: false in: query schema: type: boolean - name: isDownloadable description: Set to true if you want to allow recipients to be able to download this file required: false in: query schema: type: boolean - name: isEditable description: Set true if the asset can be edited in the Showpad Edit App required: false in: query schema: type: boolean - name: isPersonal description: Whether or not the asset is a 'personal' asset - in your own division required: false in: query schema: type: boolean - name: isSensitive description: Set to true if you do not want this file to be visible in Kiosk mode on the tablet required: false in: query schema: type: boolean - name: isShareable description: Set to true if you want to allow users to share this file with other people required: false in: query schema: type: boolean - name: limit description: Sets the maximum number of returned items. The maximum limit is set to 1000. For example, if 'limit' is 0, only 0 items will be retrieved. required: false in: query schema: type: integer format: int32 minimum: 0 maximum: 1000 - name: lockedPages description: The pages that are locked together in this asset required: false in: query schema: type: array items: type: string - name: method description: '''method'' can be used by HTTP clients who are not able to set certain HTTP verbs such as a DELETE of a PUT' required: false in: query schema: type: string anyOf: - title: post type: string - name: name description: Display name of the file required: false in: query schema: type: string - name: offset description: Set the offset of the returned items.For example, if 'offset' is 5 and 'limit' is 10, items 6 to 15 will be returned. required: false in: query schema: type: integer format: int32 minimum: 0 - name: onlyShareEntireDocument description: Whether or not we can only share the entire document required: false in: query schema: type: boolean - name: originalName description: Original name of the file required: false in: query schema: type: string - name: slug description: The slug of the asset (valid and unique UUIDv4) required: false in: query schema: type: string - name: sort description: The field you want to sort on. Adding a '-' in front of the field name allows you to sort descending. required: false in: query schema: type: string - name: standardId description: Standard ID with version (e.g. ph-135.v1) required: false in: query schema: type: string - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean - name: url description: Url to link to required: false in: query schema: type: string - name: useOptimized description: Set to true if you want to use the optimized version of this file required: false in: query schema: type: boolean - name: version description: The version of asset as an integer required: false in: query schema: type: integer format: int32 post: deprecated: true tags: - divisions operationId: post_divisions_id_assets description: "Add an asset to the division with ID='id'.\n\n *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend\nswitching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/postAssets)." summary: /divisions/{id}/assets.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string createdAt: description: The date that the file was created type: string format: date-time uploadedAt: description: The date that the file was uploaded type: string format: date-time description: description: Custom description about the file type: - string - 'null' href: description: Location of the asset type: string division: description: The location of the divisions related to this asset type: object properties: href: type: string format: link id: type: string downloadLink: description: Link where the file can be downloaded. type: - string - 'null' shortLivedDownloadLink: description: Short-lived link where the file can be publicly downloaded. type: - string - 'null' shortLivedDownloadDuration: description: Amount of days the short-lived download link will be valid for. type: - integer - 'null' format: int32 externalId: description: External ID of the asset as used in the source application type: - string - 'null' fileSize: description: Size of the file in bytes type: integer format: int32 filetype: description: Type of file type: string processedDownloadLink: description: Link where the processed file can be downloaded type: string isAnnotatable: description: Set to true if you want to allow tablet users to share to annotate this file type: boolean isSensitive: description: Set to true if you do not want this file to be visible in Kiosk mode on the tablet type: boolean isShareable: description: Set to true if you want to allow users to share this file with other people type: boolean isDownloadable: description: Set to true if you want to allow recipients to be able to download this file type: boolean isDivisionShared: description: Set to true if you want to share this file across divisions type: boolean useOptimized: description: Set to true if you want to use the optimized version of this file type: boolean name: description: Display name of the file type: string url: description: Url to link to type: - string - 'null' originalName: description: Original name of the file type: string previewDownloadLink: description: Link where the preview of the file can be downloaded. type: string thumbnailDownloadLink: description: Link where the thumbnail of the file can be downloaded. type: string tags: description: The location of the tags related to this asset type: object properties: href: type: string format: link assetView: description: The location of the asset view related to this asset type: object properties: id: type: string href: type: string format: link updatedAt: description: The date that the file was updated type: string format: date-time views: description: The number of views by tablet users on this file type: integer format: int32 appLink: description: Link to asset inside application type: string liked: description: The asset was liked by the current user type: boolean likesCount: description: Count of people who have liked an asset type: integer format: int32 standardId: description: Standard ID with version (e.g. ph-135.v1) type: string externalDate: description: An external date of the asset as used in the source application type: - string - 'null' format: date archivedAt: description: The date that the file was sent to trash type: - string - 'null' format: date expiresAt: description: The expiry date of the asset type: - string - 'null' format: date releasedAt: description: The release date of the asset type: - string - 'null' format: date draftedAt: description: The draft date of the asset type: - string - 'null' format: date extension: description: Extension of the file type: string lockedPages: description: The pages that are locked together in this asset type: - array - 'null' items: type: string pageCount: description: The number of pages the document has, if applicable type: - integer - 'null' format: int32 onlyShareEntireDocument: description: Whether or not we can only share the entire document type: boolean isPersonal: description: Whether or not the asset is a 'personal' asset - in your own division type: boolean isMarketing: description: Whether or not the asset is a 'marketing' asset - not a personal division type: boolean externalServiceId: description: External Service ID of the asset as used in the source application type: - string - 'null' currentChannelTemplateConfigId: description: Current channel template config ID corresponding to this asset type: - string - 'null' format: link channelTemplateConfigId: description: Channel template config ID type: - string - 'null' format: link slug: description: The slug of the asset (valid and unique UUIDv4) type: string hideLabel: description: Set to true if you want to hide the label for this asset type: boolean isEditable: description: Set true if the asset can be edited in the Showpad Edit App type: boolean sourceAsset: description: The original asset from which this asset was created from type: - string - 'null' format: link sourceAssetName: description: The original asset name from which this asset was created from type: string sourceAssetLink: description: The link to the original asset type: string videoLength: description: Length of the video type: - integer - 'null' format: int32 duration: description: Duration of the media type: - integer - 'null' format: int32 wordCount: description: The number of words the asset contains, if applicable type: - integer - 'null' format: int32 allowRenderExternal: description: Indicates if a url asset should be opened in a new window, or rendered inside showpad (iframe) type: boolean downloadableInternal: description: Indicates type of content that can be downloaded by internal users type: - array - 'null' items: type: string downloadableExternal: description: Indicates type of content that can be downloaded by external users type: - array - 'null' items: type: string md5Checksum: description: The MD5 checksum of the contents of the original file type: - string - 'null' fileUuid: description: The Uuid of the current file type: - string - 'null' version: description: The version of asset as an integer type: integer format: int32 parentAssetId: description: The ID of the parent asset if it exist type: - string - 'null' oAuth2ClientId: description: The OAuth2 client that can manage the asset via an external service type: string security: - bearerAuth: [] - oAuth: - write_division_management - write_contentprofile_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean requestBody: required: true content: multipart/form-data: schema: type: object properties: channelTemplateConfigId: type: string description: type: string expiresAt: type: string format: date externalDate: type: string format: date externalId: type: string externalServiceId: type: string file: type: string format: binary filetype: type: string anyOf: - title: 3d-model type: string - title: audio type: string - title: document type: string - title: personal-video-recording type: string - title: photo type: string - title: raw type: string - title: scorm type: string - title: video type: string - title: webapp type: string - title: url type: string - title: page type: string hideLabel: type: boolean icon: type: string format: binary isAnnotatable: type: boolean isDivisionShared: type: boolean isDownloadable: type: boolean isEditable: type: boolean isPersonal: type: boolean isSensitive: type: boolean isShareable: type: boolean liked: type: boolean lockedPages: type: array items: type: string name: type: string oAuth2ClientId: type: string onlyShareEntireDocument: type: boolean postProcessingInstructions: type: string releasedAt: type: string format: date draftedAt: type: string format: date slug: type: string url: type: string useOptimized: type: boolean servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /divisions/{id}/comments.json: get: deprecated: false tags: - divisions operationId: get_divisions_id_comments description: Get all comments that belong to the division with ID='id' summary: /divisions/{id}/comments.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object location: type: - string - 'null' properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string href: description: Url link to the tag type: string assets: description: The assets linked to this tag type: object properties: href: type: string format: link type: description: The type of tag type: string createdAt: description: The date that the tag was created type: string format: date-time description: description: Description of the tag type: string division: description: The division of the tag type: object properties: href: type: string format: link id: type: string divisionId: description: The division ID of the tag type: string externalId: description: External ID of the tag as used in the source application type: - string - 'null' name: description: Name of the tag type: string updatedAt: description: The date that the tag was updated type: string format: date-time externalService: description: External Service of the tag as used in the source application type: - string - 'null' format: link security: - bearerAuth: [] - oAuth: - read_division_management - read_contentprofile_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string - name: externalId description: External ID of the tag as used in the source application required: false in: query schema: type: string - name: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - name: limit description: Sets the maximum number of returned items. The maximum limit is set to 1000. For example, if 'limit' is 0, only 0 items will be retrieved. required: false in: query schema: type: integer format: int32 minimum: 0 maximum: 1000 - name: method description: '''method'' can be used by HTTP clients who are not able to set certain HTTP verbs such as a DELETE of a PUT' required: false in: query schema: type: string anyOf: - title: post type: string - name: name description: Name of the tag required: false in: query schema: type: string - name: offset description: Set the offset of the returned items.For example, if 'offset' is 5 and 'limit' is 10, items 6 to 15 will be returned. required: false in: query schema: type: integer format: int32 minimum: 0 - name: sort description: The field you want to sort on. Adding a '-' in front of the field name allows you to sort descending. required: false in: query schema: type: string - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /divisions/{id}/link.json: post: deprecated: true tags: - divisions operationId: link_divisions_id_link description: "Link the Division item with ID='id' to a user group.\n\n *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend\nusing a v4 endpoint whenever possible." summary: /divisions/{id}/link.json responses: default: description: successful operation content: application/json: schema: type: object properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object security: - bearerAuth: [] - oAuth: - write_division_management - write_contentprofile_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: Link: type: string required: - Link application/json: schema: type: object properties: Link: type: string required: - Link servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /divisions/{id}/tags.json: get: deprecated: true tags: - divisions operationId: get_divisions_id_tags description: "Get all tags that belong to the division with ID='id'.\n\n *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend\nswitching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/getTags)." summary: /divisions/{id}/tags.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: count: description: Total number of results. type: integer format: int32 example: 20 items: type: array description: List of resources. items: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string href: description: Url link to the tag type: string assets: description: The assets linked to this tag type: object properties: href: type: string format: link type: description: The type of tag type: string createdAt: description: The date that the tag was created type: string format: date-time description: description: Description of the tag type: string division: description: The division of the tag type: object properties: href: type: string format: link id: type: string divisionId: description: The division ID of the tag type: string externalId: description: External ID of the tag as used in the source application type: - string - 'null' name: description: Name of the tag type: string updatedAt: description: The date that the tag was updated type: string format: date-time externalService: description: External Service of the tag as used in the source application type: - string - 'null' format: link security: - bearerAuth: [] - oAuth: - read_division_management - read_contentprofile_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: divisionId description: The id of the division required: false in: query schema: type: string - name: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string - name: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - name: includeNonRequired description: Include non-required jobs required: false in: query schema: type: boolean - name: limit description: Sets the maximum number of returned items. The maximum limit is set to 1000. For example, if 'limit' is 0, only 0 items will be retrieved. required: false in: query schema: type: integer format: int32 minimum: 0 maximum: 1000 - name: method description: '''method'' can be used by HTTP clients who are not able to set certain HTTP verbs such as a DELETE of a PUT' required: false in: query schema: type: string anyOf: - title: post type: string - name: offset description: Set the offset of the returned items.For example, if 'offset' is 5 and 'limit' is 10, items 6 to 15 will be returned. required: false in: query schema: type: integer format: int32 minimum: 0 - name: onlyCustomerTypes description: Only include asset types which are customer facing required: false in: query schema: type: boolean - name: onlyUnfinished description: Only include jobs which have not finished required: false in: query schema: type: boolean - name: sort description: The field you want to sort on. Adding a '-' in front of the field name allows you to sort descending. Allowed values are queuedAt, status. required: false in: query schema: type: string - name: status description: Current status of the asset required: false in: query schema: type: string anyOf: - title: queued type: string - title: processing type: string - title: completed type: string - title: failed type: string - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean post: deprecated: true tags: - divisions operationId: post_divisions_id_tags description: 'Add a tag to the division with ID=''id''. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend switching to this [v4 version](https://developer.showpad.com/docs/apis/references/v4#/operations/updateTag).' summary: /divisions/{id}/tags.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string asset: description: The location of the asset type: string format: link completedAt: description: The date processing was completed type: string format: date division: description: The location of the division type: string format: link divisionId: description: The id of the division type: string queuedAt: description: The date the asset was queued for processing type: string format: date startedAt: description: The date Showpad started processing the asset type: string format: date status: description: Current status of the asset type: string user: description: The location of the user responsible for submitting the asset type: string format: link type: description: The type of the ticket resource type: string provisionalAssetId: description: Asset ID that will be used if the file is processed correctly type: string assetFilename: description: The filename of the file that's being processed type: string materialisedPath: description: The materialised path that describes the location of the asset (when available) type: string assetFileType: description: The type of the asset file type: string previewUrl: description: The preview URL for the ticket type: string thumbnailUrl: description: The thumbnail URL for the ticket type: string canBeForceUsed: description: Is the related element allowed to be used on failure of this ticket type: boolean onlyCustomerTypes: description: Only include asset types which are customer facing type: boolean onlyUnfinished: description: Only include jobs which have not finished type: boolean includeNonRequired: description: Include non-required jobs type: boolean security: - bearerAuth: [] - oAuth: - write_division_management - write_contentprofile_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: divisionId: type: string type: type: string required: - divisionId - type application/json: schema: type: object properties: divisionId: type: string type: type: string required: - divisionId - type servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /divisions/{id}/tickets.json: get: deprecated: false tags: - divisions operationId: get_divisions_id_tickets description: Get all tickets that belong to the division with ID='id' summary: /divisions/{id}/tickets.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string href: description: Location of the resource type: string format: link name: description: Name of the usergroup type: string description: description: Description of the usergroup type: string externalId: description: External ID of the usergroup as used in the source application type: - string - 'null' updatedAt: description: The date that the usergroup was updated type: string format: date-time createdAt: description: The date that the usergroup was created type: string format: date-time divisions: description: The division linked to this usergroup type: object properties: href: type: string format: link users: description: The users linked to this usergroup type: object properties: href: type: string format: link anonymizedUserData: description: Displays if this groups has anonymized data. type: boolean isDefault: description: Default usergroup containing all users. type: boolean userCount: description: The amount of users in this group. type: - integer - 'null' format: int32 deactivatedUserCount: description: The amount of deactivated users in this group. type: - integer - 'null' format: int32 pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: - integer - 'null' format: int32 neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: - integer - 'null' format: int32 numberOfDirectLicenses: description: The number of direct licenses. type: - integer - 'null' format: int32 numberOfPartnerLicenses: description: The number of partner licenses. type: - integer - 'null' format: int32 numberOfViewOnlyLicenses: description: The number of view only licenses. type: - integer - 'null' format: int32 isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: - boolean - 'null' provisionedBy: description: The system that provisioned this usergroup. type: - string - 'null' security: - bearerAuth: [] - oAuth: - read_division_management - read_contentprofile_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string - name: externalId description: External ID of the usergroup as used in the source application required: false in: query schema: type: string - name: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - name: isSynced description: Show that usergroup is synced required: false in: query schema: type: boolean - name: limit description: Sets the maximum number of returned items. The maximum limit is set to 1000. For example, if 'limit' is 0, only 0 items will be retrieved. required: false in: query schema: type: integer format: int32 minimum: 0 maximum: 1000 - name: method description: '''method'' can be used by HTTP clients who are not able to set certain HTTP verbs such as a DELETE of a PUT' required: false in: query schema: type: string anyOf: - title: post type: string - name: name description: Name of the usergroup required: false in: query schema: type: string - name: offset description: Set the offset of the returned items.For example, if 'offset' is 5 and 'limit' is 10, items 6 to 15 will be returned. required: false in: query schema: type: integer format: int32 minimum: 0 - name: sort description: The field you want to sort on. Adding a '-' in front of the field name allows you to sort descending. Allowed values are name. required: false in: query schema: type: string - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /divisions/{id}/unlink.json: post: deprecated: true tags: - divisions operationId: unlink_divisions_id_unlink description: 'Link the Division item with ID=''id''. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend using a v4 endpoint whenever possible.' summary: /divisions/{id}/unlink.json responses: default: description: successful operation content: application/json: schema: type: object properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object security: - bearerAuth: [] - oAuth: - write_division_management - write_contentprofile_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: Link: type: string required: - Link application/json: schema: type: object properties: Link: type: string required: - Link servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /divisions/{id}/usergroups.json: get: deprecated: false tags: - divisions operationId: get_divisions_id_usergroups description: Get all usergroups that belong to the division with ID='id' summary: /divisions/{id}/usergroups.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: count: description: Total number of results. type: integer format: int32 example: 20 items: type: array description: List of resources. items: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string href: description: Location of the resource type: string format: link name: description: Name of the usergroup type: string description: description: Description of the usergroup type: string externalId: description: External ID of the usergroup as used in the source application type: - string - 'null' updatedAt: description: The date that the usergroup was updated type: string format: date-time createdAt: description: The date that the usergroup was created type: string format: date-time divisions: description: The division linked to this usergroup type: object properties: href: type: string format: link users: description: The users linked to this usergroup type: object properties: href: type: string format: link anonymizedUserData: description: Displays if this groups has anonymized data. type: boolean isDefault: description: Default usergroup containing all users. type: boolean userCount: description: The amount of users in this group. type: - integer - 'null' format: int32 deactivatedUserCount: description: The amount of deactivated users in this group. type: - integer - 'null' format: int32 pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: - integer - 'null' format: int32 neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: - integer - 'null' format: int32 numberOfDirectLicenses: description: The number of direct licenses. type: - integer - 'null' format: int32 numberOfPartnerLicenses: description: The number of partner licenses. type: - integer - 'null' format: int32 numberOfViewOnlyLicenses: description: The number of view only licenses. type: - integer - 'null' format: int32 isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: - boolean - 'null' provisionedBy: description: The system that provisioned this usergroup. type: - string - 'null' security: - bearerAuth: [] - oAuth: - read_division_management - read_user_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: email description: Email of the user required: false in: query schema: type: string - name: emailNotifications description: Set to true if the user will receive email notifications for activities performed by recipients required: false in: query schema: type: boolean - name: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string - name: externalId description: External ID of the user as used in the source application required: false in: query schema: type: string - name: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - name: firstName description: First name of the user required: false in: query schema: type: string - name: isActive description: Indicates whether a user is active required: false in: query schema: type: boolean - name: isAnonymized description: Show that user is anonymized required: false in: query schema: type: boolean - name: isInvited description: Shows that user is invited required: false in: query schema: type: boolean - name: isSynced description: Shows that user is synced required: false in: query schema: type: boolean - name: language description: The user's language required: false in: query schema: type: string - name: lastName description: Last name of the user required: false in: query schema: type: string - name: limit description: Sets the maximum number of returned items. The maximum limit is set to 1000. For example, if 'limit' is 0, only 0 items will be retrieved. required: false in: query schema: type: integer format: int32 minimum: 0 maximum: 1000 - name: method description: '''method'' can be used by HTTP clients who are not able to set certain HTTP verbs such as a DELETE of a PUT' required: false in: query schema: type: string anyOf: - title: post type: string - name: offset description: Set the offset of the returned items.For example, if 'offset' is 5 and 'limit' is 10, items 6 to 15 will be returned. required: false in: query schema: type: integer format: int32 minimum: 0 - name: productLicenseContent description: Show user's productLicenseContent required: false in: query schema: type: string - name: productLicenseTrainingCoaching description: Show user's productLicenseTrainingCoaching required: false in: query schema: type: string - name: scimId description: External id for scim integration required: false in: query schema: type: string - name: sort description: The field you want to sort on. Adding a '-' in front of the field name allows you to sort descending. required: false in: query schema: type: string - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean - name: userName description: Unique name of the user within the organization required: false in: query schema: type: string - name: userType description: Type of user required: false in: query schema: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string post: deprecated: false tags: - divisions operationId: post_divisions_id_usergroups description: Add a group to the division with ID='id' summary: /divisions/{id}/usergroups.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string href: description: Location of the resource type: string format: link name: description: Name of the usergroup type: string description: description: Description of the usergroup type: string externalId: description: External ID of the usergroup as used in the source application type: - string - 'null' updatedAt: description: The date that the usergroup was updated type: string format: date-time createdAt: description: The date that the usergroup was created type: string format: date-time divisions: description: The division linked to this usergroup type: object properties: href: type: string format: link users: description: The users linked to this usergroup type: object properties: href: type: string format: link anonymizedUserData: description: Displays if this groups has anonymized data. type: boolean isDefault: description: Default usergroup containing all users. type: boolean userCount: description: The amount of users in this group. type: - integer - 'null' format: int32 deactivatedUserCount: description: The amount of deactivated users in this group. type: - integer - 'null' format: int32 pendingInvitationUserCount: description: The amount of users in this group for which an invitation is still pending. type: - integer - 'null' format: int32 neverLoggedInUserCount: description: The amount of users in this group that never logged in. type: - integer - 'null' format: int32 numberOfDirectLicenses: description: The number of direct licenses. type: - integer - 'null' format: int32 numberOfPartnerLicenses: description: The number of partner licenses. type: - integer - 'null' format: int32 numberOfViewOnlyLicenses: description: The number of view only licenses. type: - integer - 'null' format: int32 isSynced: description: Show that usergroup is synced type: boolean hasManageGroupsPermission: description: Has permission to manage groups. type: - boolean - 'null' provisionedBy: description: The system that provisioned this usergroup. type: - string - 'null' security: - write_division_management - write_user_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: email: type: string firstName: type: string isActive: type: boolean language: type: string lastName: type: string userName: type: string bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean emailNotifications: type: boolean emailSignature: type: string externalId: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean sha512PasswordHash: type: string timezone: type: string userType: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string required: - email - firstName - isActive - language - lastName - userName application/json: schema: type: object properties: email: type: string firstName: type: string isActive: type: boolean language: type: string lastName: type: string userName: type: string bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean emailNotifications: type: boolean emailSignature: type: string externalId: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean sha512PasswordHash: type: string timezone: type: string userType: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string required: - email - firstName - isActive - language - lastName - userName servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /divisions/{id}/users.json: get: deprecated: true tags: - divisions operationId: get_divisions_id_users description: 'Get all users that belong to the division with ID=''id''. *Note*: This endpoint continues to function, but future improvements will only be available in v4. We recommend using a v4 endpoint whenever possible.' summary: /divisions/{id}/users.json responses: default: description: successful operation content: application/json: schema: type: object required: - response properties: meta: type: object properties: code: type: integer format: int32 message: type: string serverTime: type: string format: date-time lastUpdatedTime: type: string format: date-time requestRateLimit: type: integer format: int32 requestRateLimitReset: type: integer format: int32 requestsRemaining: type: integer format: int32 location: type: string format: link userTimezone: type: object properties: offset: type: string name: type: string response: type: object properties: count: description: Total number of results. type: integer format: int32 example: 20 items: type: array description: List of resources. items: type: object properties: id: description: Unique identifier for the resource type: string resourcetype: description: The type of resource type: string apiKey: description: The API key of the user type: - string - 'null' avatar: description: The Avatar linked to this user type: - string - 'null' format: link companyName: description: User's company name type: string companyRole: description: User's company role type: - string - 'null' consentGivenAt: description: The date at which the user consented to the current privacy policy type: - string - 'null' format: date consentGivenFrom: description: The ip address the user consented to the current privacy policy from type: - string - 'null' createdAt: description: The date that the user was created type: string format: date-time divisionpermissions: description: The Division Permissions linked to this user type: - string - 'null' format: link email: description: Email of the user type: string emailNotifications: description: Set to true if the user will receive email notifications for activities performed by recipients type: boolean emailSignature: description: User's email signature type: - string - 'null' externalId: description: External ID of the user as used in the source application. Can only be used by the owner, admin or promoted users. type: - string - 'null' firstName: description: First name of the user type: string forcePasswordReset: description: 'Determines whether a user should change their password on first login after having had their password reset. When provided without a password, this value will be ignored.' type: boolean ftueStatus: description: FTUE dialogs acknowledged by the user type: - string - 'null' insightsLastViewedAt: description: Last time Showpad Insights was viewed type: - string - 'null' format: date invitationConfirmedAt: description: Confirmation date of the initial user invitation type: - string - 'null' format: date-time isActive: description: Indicates whether a user is active type: boolean isAnonymized: description: Show that user is anonymized. Can only be used by the owner, admin or promoted users. type: boolean isInvited: description: Shows that user is invited. Can only be used by the owner, admin or promoted users. type: boolean isPasswordSet: description: Indicates if user password is set type: boolean isSynced: description: Shows that user is synced. Can only be used by the owner, admin or promoted users. type: boolean isTrainingCoachingManager: description: Shows whether the user training coaching manager is or not type: boolean language: description: The user's language type: string lastConfirmedContentUpdate: description: The date the user last updated his content type: - string - 'null' format: date lastInvitationSentAt: description: Date of the last sent invitation email type: - string - 'null' format: date-time lastInvitationStatus: description: Status of the last sent invitation email type: - string - 'null' lastLogin: description: The date the user last logged in type: - string - 'null' format: date lastName: description: Last name of the user type: string managedUsergroups: description: A list of usergroups managed by the user. Can only be used by the owner, admin or promoted users. type: - string - 'null' format: link multiPillarNavigation: description: Indicates whether the multi pillar navigation is enabled type: boolean myUploadsCollectionId: description: ID of the uploads collection for this user type: string myUploadsDivisionId: description: ID of the my uploads channel for this user type: string personalContentFileSizeUsed: description: Total used space for this user's My Uploads section type: integer format: int32 personalContentIndividualFileSizeLimit: description: Limit of a My Uploads upload for this user type: integer format: int64 personalContentTotalFileSizeLimit: description: Limit of this user's My Uploads quote type: integer format: int64 isPersonalContentTotalUnlimited: description: Should the personal storage limit be interpreted as unlimited? type: boolean phone: description: User's phone number type: - string - 'null' productLicenseContent: description: Show user's productLicenseContent type: string productLicenseTrainingCoaching: description: Show user's productLicenseTrainingCoaching type: string timezone: description: "User timezone (or company timezone if not specified). Must be a tz database identifier i.e. Country/City. \nIf the city part contains multiple words it must be split by underscores i.e. America/New_York.\n" type: string updatedAt: description: The date that the user was updated type: string format: date-time usergroups: description: Groups linked to this user. Can only be retrieved by the owner, admin or promoted users. type: object properties: href: type: string format: link userName: description: Unique name of the user within the organization type: string userpermission: description: The User Permission linked to this user type: object properties: id: type: string href: type: string format: link userType: description: Type of user type: string scimId: description: External id for scim integration type: - string - 'null' href: description: External id for scim integration type: string bccAddresses: description: BCC addresses type: array items: type: string collectionsVersion: description: The version of the user's collections type: integer consentGiven: description: If the current privacy policy was approved by the user type: - boolean - 'null' consentRequired: description: Whether or not the user should give consent (again) type: boolean isPromotedMember: description: Indicated whether or not the user has active promoted memberships type: boolean lastUsedDevice: type: object properties: href: description: The URL to access the resource type: string id: type: string description: the resource identifier password: description: Password of the user (If no password is given, an invitation mail will be send unless it is specifically specified not to send a mail) type: string promotedDivisions: type: object properties: href: description: The URL to access the resource type: string sendMailToUser: description: Allows overwriting the default user activation email behavior. Can only be used by the owner, admin or promoted users. type: boolean provisionedBy: description: "Indicate how this user was provisioned. Can only be used by the owner, admin or promoted users.\nWhen the provisionedBy field is set to scim2.0, the reference ID can optionally be found in the scimId field. \nOther provisioning methods will have the externalId field populated.\nsftp, sfns and scim2.0 are currently reserved for Showpad owned provisioning mechanisms.\n" type: string managerId: description: ID of the direct manager. Can only be used by the owner, admin or promoted users. type: - string - 'null' uuid: description: Uuid of the user type: - string - 'null' security: - bearerAuth: [] - oAuth: - read_division_management - read_user_management parameters: - name: id description: ID of the Division item required: true in: path schema: type: string - name: createdSince description: Filter comments on createdAt greater than or equal to this value required: false in: query schema: type: string format: date - name: describe_apis description: Describes the different api calls available together with the allowed parameters required: false in: query schema: type: boolean - name: describe_model description: Describes the data model behind the resource including properties and their description required: false in: query schema: type: boolean - name: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string - name: externalId description: External ID of the comment as used in the source application required: false in: query schema: type: string - name: fields description: Comma separated list of all fields that need to be retrieved. required: false in: query schema: type: string - name: isUnregisteredUserComment description: Indicates whether this comment is made by an unregistered user required: false in: query schema: type: boolean - name: limit description: Sets the maximum number of returned items. The maximum limit is set to 1000. For example, if 'limit' is 0, only 0 items will be retrieved. required: false in: query schema: type: integer format: int32 minimum: 0 maximum: 1000 - name: method description: '''method'' can be used by HTTP clients who are not able to set certain HTTP verbs such as a DELETE of a PUT' required: false in: query schema: type: string anyOf: - title: post type: string - name: offset description: Set the offset of the returned items.For example, if 'offset' is 5 and 'limit' is 10, items 6 to 15 will be returned. required: false in: query schema: type: integer format: int32 minimum: 0 - name: sort description: The field you want to sort on. Adding a '-' in front of the field name allows you to sort descending. required: false in: query schema: type: string - name: suppress_response_codes description: 'This forces the HTTP status code of the response to be set to 200 ' required: false in: query schema: type: boolean - name: unregisteredUserFirstName description: First Name of the unregistered user required: false in: query schema: type: string - name: unregisteredUserLastName description: Last Name of the unregistered user required: false in: query schema: type: string servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /divisions: get: operationId: getDivisions summary: List all Divisions description: 'Retrieve a list of all Divisions available in your Showpad instance. Divisions represent organizational groupings that control access, content visibility, and administrative boundaries within the platform. Use this endpoint when you need to: - Display Division options in custom interfaces or admin tools - Sync Division metadata with external systems - Filter or segment content and users based on organizational structure Supports pagination for large datasets and is ideal for reporting, permission modeling, or building integrations that rely on Division hierarchy or availability.' tags: - divisions security: - BearerAuth: [] parameters: - name: limit in: query description: Defines the maximum number of items to return in the response. Useful for paginating results when fetching items in batches. example: limit=100 schema: type: integer format: int32 default: 50 minimum: 0 maximum: 1000 - name: offset in: query description: Specifies the number of items to skip before returning results. Use in combination with `limit` to implement pagination when retrieving large datasets. required: false example: offset=0 schema: type: integer format: int32 default: 0 minimum: 0 responses: '200': description: OK. The request was successful. Returns a paginated list of Divisions matching the applied filters. content: application/json: schema: type: object properties: count: description: Total number of results matching the request criteria. type: integer format: int32 example: 20 items: type: array description: List of Divisions. items: type: object properties: id: type: string description: Unique identifier of the Division. example: f541710283954a89bdfd40f221882451 name: type: string example: My Global Division description: Name of the Division. isAssetSharingEnabled: type: boolean description: Whether or not `Share content globally` is enabled on the Division. createdAt: type: string format: date-time description: 'Timestamp when the resource was created, in `ISO 8601` UTC format. ' updatedAt: type: string format: date-time description: 'Timestamp when the resource was last updated, in `ISO 8601` UTC format. ' '400': description: Bad Request. Returned when the request payload is invalid or incomplete. The response provides structured error details to help identify and correct the issue. content: application/problem+json: schema: type: object required: - title - detail - status properties: title: type: string description: 'A short summary of the error type. This is intended for engineers and technical users. It is always in English and not localized. ' example: Invalid Payload detail: type: string description: 'A human-readable explanation of the specific reason for the failure. ' example: Property value provided is not valid. status: type: integer format: int32 description: 'The HTTP status code returned by the server. ' minimum: 400 maximum: 599 example: 400 meta: type: - array - 'null' description: Additional metadata entries providing field-level context about the error. Null if not applicable. items: type: object description: Additional metadata entries providing field-level context about the error. required: - name - reason - category properties: name: type: string example: color description: The name of the field or parameter associated with the error, if applicable. reason: type: string example: Value must be 'green', 'red' or 'blue'. description: A descriptive message explaining what is wrong with the field or parameter. category: type: string example: propertyRequired description: Classification of the error, useful for programmatic handling. type: type: - string - 'null' description: URI reference to a resource that defines the error type, if available. Null if not applicable. '401': description: Unauthorized. The request lacks valid authentication credentials, or the provided token has expired. content: application/problem+json: schema: type: object required: - title - detail - status properties: title: type: string description: 'A short summary of the error type. This is intended for engineers and technical users. It is always in English and not localized. ' example: Invalid Payload detail: type: string description: 'A human-readable explanation of the specific reason for the failure. ' example: Property value provided is not valid. status: type: integer format: int32 description: 'The HTTP status code returned by the server. ' minimum: 400 maximum: 599 example: 400 meta: type: - array - 'null' description: Additional metadata entries providing field-level context about the error. Null if not applicable. items: type: object description: Additional metadata entries providing field-level context about the error. required: - name - reason - category properties: name: type: string example: color description: The name of the field or parameter associated with the error, if applicable. reason: type: string example: Value must be 'green', 'red' or 'blue'. description: A descriptive message explaining what is wrong with the field or parameter. category: type: string example: propertyRequired description: Classification of the error, useful for programmatic handling. type: type: - string - 'null' description: URI reference to a resource that defines the error type, if available. Null if not applicable. '403': description: Forbidden. The server understood the request but refuses to authorize it. The authenticated user does not have the necessary permissions to perform this action. content: application/problem+json: schema: type: object required: - title - detail - status properties: title: type: string description: 'A short summary of the error type. This is intended for engineers and technical users. It is always in English and not localized. ' example: Invalid Payload detail: type: string description: 'A human-readable explanation of the specific reason for the failure. ' example: Property value provided is not valid. status: type: integer format: int32 description: 'The HTTP status code returned by the server. ' minimum: 400 maximum: 599 example: 400 meta: type: - array - 'null' description: Additional metadata entries providing field-level context about the error. Null if not applicable. items: type: object description: Additional metadata entries providing field-level context about the error. required: - name - reason - category properties: name: type: string example: color description: The name of the field or parameter associated with the error, if applicable. reason: type: string example: Value must be 'green', 'red' or 'blue'. description: A descriptive message explaining what is wrong with the field or parameter. category: type: string example: propertyRequired description: Classification of the error, useful for programmatic handling. type: type: - string - 'null' description: URI reference to a resource that defines the error type, if available. Null if not applicable. servers: - url: https://{subdomain}.api.showpad.com/v4 description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /divisions/{divisionId}: parameters: - name: divisionId in: path required: true description: The division ID. schema: type: string example: f541710283954a89bdfd40f221882451 get: operationId: getDivisionById summary: Retrieve a Division description: 'Retrieve detailed information for a single Division in your Showpad environment. Divisions help organize content, users, and permissions across your organization. Use this endpoint when you need to: - Display Division details in an admin or reporting interface - Validate Division configuration before creating or updating related resources - Sync organizational structure between Showpad and an external system Returns the Division''s name, settings, and timestamps, making it useful for management, auditing, and system integrations.' tags: - divisions security: - BearerAuth: [] responses: '200': description: OK. The request was successful. Returns the requested Division object. x-summary: OK. Request is successful. content: application/json: schema: type: object properties: id: type: string description: Unique identifier of the Division. example: f541710283954a89bdfd40f221882451 name: type: string example: My Global Division description: Name of the Division. isAssetSharingEnabled: type: boolean description: Whether or not `Share content globally` is enabled on the Division. createdAt: type: string format: date-time description: 'Timestamp when the resource was created, in `ISO 8601` UTC format. ' updatedAt: type: string format: date-time description: 'Timestamp when the resource was last updated, in `ISO 8601` UTC format. ' '401': description: Unauthorized. The request lacks valid authentication credentials, or the provided token has expired. content: application/problem+json: schema: type: object required: - title - detail - status properties: title: type: string description: 'A short summary of the error type. This is intended for engineers and technical users. It is always in English and not localized. ' example: Invalid Payload detail: type: string description: 'A human-readable explanation of the specific reason for the failure. ' example: Property value provided is not valid. status: type: integer format: int32 description: 'The HTTP status code returned by the server. ' minimum: 400 maximum: 599 example: 400 meta: type: - array - 'null' description: Additional metadata entries providing field-level context about the error. Null if not applicable. items: type: object description: Additional metadata entries providing field-level context about the error. required: - name - reason - category properties: name: type: string example: color description: The name of the field or parameter associated with the error, if applicable. reason: type: string example: Value must be 'green', 'red' or 'blue'. description: A descriptive message explaining what is wrong with the field or parameter. category: type: string example: propertyRequired description: Classification of the error, useful for programmatic handling. type: type: - string - 'null' description: URI reference to a resource that defines the error type, if available. Null if not applicable. '403': description: Forbidden. The server understood the request but refuses to authorize it. The authenticated user does not have the necessary permissions to perform this action. content: application/problem+json: schema: type: object required: - title - detail - status properties: title: type: string description: 'A short summary of the error type. This is intended for engineers and technical users. It is always in English and not localized. ' example: Invalid Payload detail: type: string description: 'A human-readable explanation of the specific reason for the failure. ' example: Property value provided is not valid. status: type: integer format: int32 description: 'The HTTP status code returned by the server. ' minimum: 400 maximum: 599 example: 400 meta: type: - array - 'null' description: Additional metadata entries providing field-level context about the error. Null if not applicable. items: type: object description: Additional metadata entries providing field-level context about the error. required: - name - reason - category properties: name: type: string example: color description: The name of the field or parameter associated with the error, if applicable. reason: type: string example: Value must be 'green', 'red' or 'blue'. description: A descriptive message explaining what is wrong with the field or parameter. category: type: string example: propertyRequired description: Classification of the error, useful for programmatic handling. type: type: - string - 'null' description: URI reference to a resource that defines the error type, if available. Null if not applicable. '404': description: Not Found. Returned when the requested resource does not exist or the user does not have permission to access it. content: application/problem+json: schema: type: object required: - title - detail - status properties: title: type: string description: 'A short summary of the error type. This is intended for engineers and technical users. It is always in English and not localized. ' example: Invalid Payload detail: type: string description: 'A human-readable explanation of the specific reason for the failure. ' example: Property value provided is not valid. status: type: integer format: int32 description: 'The HTTP status code returned by the server. ' minimum: 400 maximum: 599 example: 400 meta: type: - array - 'null' description: Additional metadata entries providing field-level context about the error. Null if not applicable. items: type: object description: Additional metadata entries providing field-level context about the error. required: - name - reason - category properties: name: type: string example: color description: The name of the field or parameter associated with the error, if applicable. reason: type: string example: Value must be 'green', 'red' or 'blue'. description: A descriptive message explaining what is wrong with the field or parameter. category: type: string example: propertyRequired description: Classification of the error, useful for programmatic handling. type: type: - string - 'null' description: URI reference to a resource that defines the error type, if available. Null if not applicable. servers: - url: https://{subdomain}.api.showpad.com/v4 description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain 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). 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. ' x-refined-from: - showpad-v3-openapi-original.yml - showpad-v4-openapi-original.yml