Showpad

Showpad Userpermissions API

The userpermissions API from Showpad — 6 operation(s) for userpermissions.

GitHub OpenAPI

Operations 10

GET /userpermissions.json /userpermissions.json #
POST /userpermissions.json /userpermissions.json #
GET /userpermissions/count.json /userpermissions/count.json #
GET /userpermissions/description.json /userpermissions/description.json #
GET /userpermissions/{id}.json /userpermissions/{id}.json #
PUT /userpermissions/{id}.json /userpermissions/{id}.json #
POST /userpermissions/{id}.json /userpermissions/{id}.json #
DELETE /userpermissions/{id}.json /userpermissions/{id}.json #

Documentation

📖
Documentation
https://developer.showpad.com/docs/apis/
📖
APIReference
https://developer.showpad.com/docs/apis/references/v3
📖
Authentication
https://developer.showpad.com/docs/apis/concepts/authentication
📖
APIReference
https://developer.showpad.com/docs/apis/references/v4
📖
Documentation
https://developer.showpad.com/docs/apis/users/SCIM

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/showpad/refs/heads/main/openapi/showpad-userpermissions-api-openapi.yml

Other Resources

🔗
Versioning
https://developer.showpad.com/docs/apis/concepts/versions
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/showpad/refs/heads/main/errors/showpad-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/showpad/refs/heads/main/data-model/showpad-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/showpad-userpermissions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

showpad-userpermissions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Showpad Userpermissions API
  version: '3'
  termsOfService: https://www.showpad.com/terms-of-service
  contact:
    name: Showpad
    email: support@showpad.com
    url: https://help.showpad.com/hc/en-us/requests/new
  x-audience: external-partner
servers:
- url: https://{subdomain}.showpad.biz/api/v3/
  description: Production server
  x-environment: production
  variables:
    subdomain:
      default: customer
      description: Showpad customer subdomain
security:
- oAuth: []
- bearerAuth: []
tags:
- name: userpermissions
  description: ''
paths:
  /userpermissions.json:
    get:
      deprecated: false
      tags:
      - userpermissions
      operationId: get_userpermissions
      description: Generates a list of UserPermission items
      summary: /userpermissions.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 the tablet permission was created
                              type: string
                              format: date
                            crm:
                              description: Whether this permission enables the use of CRM
                              type: boolean
                            externalId:
                              description: External ID of the tablet permission as used in the source application
                              type: string
                            fileCommenting:
                              description: Whether this permission enables file commenting
                              type: boolean
                            name:
                              description: Name of the Tablet Permission
                              type: string
                            personalCatalog:
                              description: Whether this permission enables personal catalog viewing
                              type: boolean
                            updatedAt:
                              description: The date the tablet permission was updated
                              type: string
                              format: date
                            users:
                              description: The users linked to this tablet permission
                              type: string
                              format: link
                            webAccess:
                              description: Whether this permission enables web access
                              type: boolean
                            smartPhoneAccess:
                              description: Whether this permission enables smart phone access
                              type: boolean
                            personalContent:
                              description: Whether this permission enables personal content
                              type: boolean
                            tagSearch:
                              description: Whether this permission enables tag search
                              type: boolean
                            fileRating:
                              description: Whether this permission enables file ratings
                              type: boolean
                            externalFileSystemImport:
                              description: Whether this permission enables external file system import
                              type: boolean
                            advancedReporting:
                              description: Whether this permission enables advanced reporting
                              type: boolean
                            salesforceIntegration:
                              description: Whether this permission enables Salesforce Integration
                              type: boolean
                            salesEngagement:
                              description: Whether this permission enables Sales engagement
                              type: boolean
                            locationSharing:
                              description: What type of location sharing this user can undergo
                              type: string
                            collections:
                              description: Whether to enable Collections
                              type: boolean
                            kioskMode:
                              description: Whether kiosk mode is allowed
                              type: boolean
                            notifications:
                              description: Whether receiving notifications is allowed
                              type: boolean
                            contactBrowser:
                              description: Whether browsing contacts is allowed
                              type: boolean
                            contactExport:
                              description: Whether exporting contacts is allowed
                              type: boolean
                            contactForm:
                              description: Whether contact form is allowed
                              type: boolean
                            contactSync:
                              description: Whether contact sync to the platform is allowed
                              type: boolean
                            channelTemplate:
                              description: Whether this permission enables channel templates
                              type: boolean
                            canManageUsersAndGroups:
                              description: Whether the user can manage users & user groups in the OP
                              type: boolean
                            canManageAssets:
                              description: Whether the user can manage assets in the OP
                              type: boolean
                            canManageExperiences:
                              description: Whether the user can manage experiences
                              type: boolean
                            canDeleteExperiences:
                              description: Whether the user can delete experiences
                              type: boolean
                            canViewUsers:
                              description: Whether the user can view users
                              type: boolean
                            canManageUsers:
                              description: Whether the user can manage users
                              type: boolean
                            canContentReporting:
                              description: Whether the user has access to content reporting in the OP
                              type: boolean
                            canTrainingReporting:
                              description: Whether the user can has access to training & coaching reporting in the OP
                              type: boolean
                            canManageAnnouncements:
                              description: Whether the user can manage announcements in the OP
                              type: boolean
                            canManageTags:
                              description: Whether the user can can manage tags in the OP
                              type: boolean
                            canManageCoursesAndChecklists:
                              description: Whether the user can can manage courses & checklists in the OP
                              type: boolean
                            canManageAiRoleplays:
                              description: Whether user can manage AI roleplays
                              type: boolean
                            sharing:
                              description: Whether the user has access to sharing
                              type: boolean
                            sharedSpaces:
                              description: Whether the user has access to shared spaces
                              type: boolean
                            canManageContentProfiles:
                              description: Whether user can manage content profiles
                              type: boolean
      security:
      - bearerAuth: []
      - oAuth:
        - read_user_management
      parameters:
      - name: advancedReporting
        description: Whether this permission enables advanced reporting
        required: false
        in: query
        schema:
          type: boolean
      - name: channelTemplate
        description: Whether this permission enables channel templates
        required: false
        in: query
        schema:
          type: boolean
      - name: collections
        description: Whether to enable Collections
        required: false
        in: query
        schema:
          type: boolean
      - name: contactBrowser
        description: Whether browsing contacts is allowed
        required: false
        in: query
        schema:
          type: boolean
      - name: contactExport
        description: Whether exporting contacts is allowed
        required: false
        in: query
        schema:
          type: boolean
      - name: contactForm
        description: Whether contact form is allowed
        required: false
        in: query
        schema:
          type: boolean
      - name: contactSync
        description: Whether contact sync to the platform is allowed
        required: false
        in: query
        schema:
          type: boolean
      - name: crm
        description: Whether this permission enables the use of CRM
        required: false
        in: query
        schema:
          type: boolean
      - 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: externalFileSystemImport
        description: Whether this permission enables external file system import
        required: false
        in: query
        schema:
          type: boolean
      - name: externalId
        description: External ID of the tablet permission 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: fileCommenting
        description: Whether this permission enables file commenting
        required: false
        in: query
        schema:
          type: boolean
      - name: fileRating
        description: Whether this permission enables file ratings
        required: false
        in: query
        schema:
          type: boolean
      - name: kioskMode
        description: Whether kiosk mode is allowed
        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 Tablet Permission
        required: false
        in: query
        schema:
          type: string
      - name: notifications
        description: Whether receiving notifications is allowed
        required: false
        in: query
        schema:
          type: boolean
      - 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: personalCatalog
        description: Whether this permission enables personal catalog viewing
        required: false
        in: query
        schema:
          type: boolean
      - name: personalContent
        description: Whether this permission enables personal content
        required: false
        in: query
        schema:
          type: boolean
      - name: salesEngagement
        description: Whether this permission enables Sales engagement
        required: false
        in: query
        schema:
          type: boolean
      - name: salesforceIntegration
        description: Whether this permission enables Salesforce Integration
        required: false
        in: query
        schema:
          type: boolean
      - name: smartPhoneAccess
        description: Whether this permission enables smart phone access
        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.
        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: tagSearch
        description: Whether this permission enables tag search
        required: false
        in: query
        schema:
          type: boolean
      - name: webAccess
        description: Whether this permission enables web access
        required: false
        in: query
        schema:
          type: boolean
    post:
      deprecated: false
      tags:
      - userpermissions
      operationId: post_userpermissions
      description: Create a UserPermission item
      summary: /userpermissions.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 the tablet permission was created
                        type: string
                        format: date
                      crm:
                        description: Whether this permission enables the use of CRM
                        type: boolean
                      externalId:
                        description: External ID of the tablet permission as used in the source application
                        type: string
                      fileCommenting:
                        description: Whether this permission enables file commenting
                        type: boolean
                      name:
                        description: Name of the Tablet Permission
                        type: string
                      personalCatalog:
                        description: Whether this permission enables personal catalog viewing
                        type: boolean
                      updatedAt:
                        description: The date the tablet permission was updated
                        type: string
                        format: date
                      users:
                        description: The users linked to this tablet permission
                        type: string
                        format: link
                      webAccess:
                        description: Whether this permission enables web access
                        type: boolean
                      smartPhoneAccess:
                        description: Whether this permission enables smart phone access
                        type: boolean
                      personalContent:
                        description: Whether this permission enables personal content
                        type: boolean
                      tagSearch:
                        description: Whether this permission enables tag search
                        type: boolean
                      fileRating:
                        description: Whether this permission enables file ratings
                        type: boolean
                      externalFileSystemImport:
                        description: Whether this permission enables external file system import
                        type: boolean
                      advancedReporting:
                        description: Whether this permission enables advanced reporting
                        type: boolean
                      salesforceIntegration:
                        description: Whether this permission enables Salesforce Integration
                        type: boolean
                      salesEngagement:
                        description: Whether this permission enables Sales engagement
                        type: boolean
                      locationSharing:
                        description: What type of location sharing this user can undergo
                        type: string
                      collections:
                        description: Whether to enable Collections
                        type: boolean
                      kioskMode:
                        description: Whether kiosk mode is allowed
                        type: boolean
                      notifications:
                        description: Whether receiving notifications is allowed
                        type: boolean
                      contactBrowser:
                        description: Whether browsing contacts is allowed
                        type: boolean
                      contactExport:
                        description: Whether exporting contacts is allowed
                        type: boolean
                      contactForm:
                        description: Whether contact form is allowed
                        type: boolean
                      contactSync:
                        description: Whether contact sync to the platform is allowed
                        type: boolean
                      channelTemplate:
                        description: Whether this permission enables channel templates
                        type: boolean
                      canManageUsersAndGroups:
                        description: Whether the user can manage users & user groups in the OP
                        type: boolean
                      canManageAssets:
                        description: Whether the user can manage assets in the OP
                        type: boolean
                      canManageExperiences:
                        description: Whether the user can manage experiences
                        type: boolean
                      canDeleteExperiences:
                        description: Whether the user can delete experiences
                        type: boolean
                      canViewUsers:
                        description: Whether the user can view users
                        type: boolean
                      canManageUsers:
                        description: Whether the user can manage users
                        type: boolean
                      canContentReporting:
                        description: Whether the user has access to content reporting in the OP
                        type: boolean
                      canTrainingReporting:
                        description: Whether the user can has access to training & coaching reporting in the OP
                        type: boolean
                      canManageAnnouncements:
                        description: Whether the user can manage announcements in the OP
                        type: boolean
                      canManageTags:
                        description: Whether the user can can manage tags in the OP
                        type: boolean
                      canManageCoursesAndChecklists:
                        description: Whether the user can can manage courses & checklists in the OP
                        type: boolean
                      canManageAiRoleplays:
                        description: Whether user can manage AI roleplays
                        type: boolean
                      sharing:
                        description: Whether the user has access to sharing
                        type: boolean
                      sharedSpaces:
                        description: Whether the user has access to shared spaces
                        type: boolean
                      canManageContentProfiles:
                        description: Whether user can manage content profiles
                        type: boolean
      security:
      - bearerAuth: []
      - oAuth:
        - write_user_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:
                advancedReporting:
                  type: boolean
                collections:
                  type: boolean
                contactBrowser:
                  type: boolean
                contactExport:
                  type: boolean
                contactForm:
                  type: boolean
                contactSync:
                  type: boolean
                crm:
                  type: boolean
                externalFileSystemImport:
                  type: boolean
                fileCommenting:
                  type: boolean
                fileRating:
                  type: boolean
                kioskMode:
                  type: boolean
                name:
                  type: string
                notifications:
                  type: boolean
                personalCatalog:
                  type: boolean
                personalContent:
                  type: boolean
                salesEngagement:
                  type: boolean
                salesforceIntegration:
                  type: boolean
                smartPhoneAccess:
                  type: boolean
                tagSearch:
                  type: boolean
                webAccess:
                  type: boolean
                externalId:
                  type: string
              required:
              - advancedReporting
              - collections
              - contactBrowser
              - contactExport
              - contactForm
              - contactSync
              - crm
              - externalFileSystemImport
              - fileCommenting
              - fileRating
              - kioskMode
              - name
              - notifications
              - personalCatalog
              - personalContent
              - salesEngagement
              - salesforceIntegration
              - smartPhoneAccess
              - tagSearch
              - webAccess
          application/json:
            schema:
              type: object
              properties:
                advancedReporting:
                  type: boolean
                collections:
                  type: boolean
                contactBrowser:
                  type: boolean
                contactExport:
                  type: boolean
                contactForm:
                  type: boolean
                contactSync:
                  type: boolean
                crm:
                  type: boolean
                externalFileSystemImport:
                  type: boolean
                fileCommenting:
                  type: boolean
                fileRating:
                  type: boolean
                kioskMode:
                  type: boolean
                name:
                  type: string
                notifications:
                  type: boolean
                personalCatalog:
                  type: boolean
                personalContent:
                  type: boolean
                salesEngagement:
                  type: boolean
                salesforceIntegration:
                  type: boolean
                smartPhoneAccess:
                  type: boolean
                tagSearch:
                  type: boolean
                webAccess:
                  type: boolean
                externalId:
                  type: string
              required:
              - advancedReporting
              - collections
              - contactBrowser
              - contactExport
              - contactForm
              - contactSync
              - crm
              - externalFileSystemImport
              - fileCommenting
              - fileRating
              - kioskMode
              - name
              - notifications
              - personalCatalog
              - personalContent
              - salesEngagement
              - salesforceIntegration
              - smartPhoneAccess
              - tagSearch
              - webAccess
  /userpermissions/count.json:
    get:
      deprecated: false
      tags:
      - userpermissions
      operationId: get_userpermissions_count
      description: Retrieve the number of UserPermission items
      summary: /userpermissions/count.json
      responses:
        default:
          description: successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  meta:
                    type: object
                    properties:
                      code:
                        type: integer
                        format: int32
                      message:
                        type: string
                      serverTime:
                        type: string
                        format: date-time
                      lastUpdatedTime:
                        type: string
                        format: date-time
                      requestRateLimit:
                        type: integer
                        format: int32
                      requestRateLimitReset:
                        type: integer
                        format: int32
                      requestsRemaining:
                        type: integer
                        format: int32
                      location:
                        type: string
                        format: link
                      userTimezone:
                        type: object
                        properties:
                          offset:
                            type: string
                          name:
                            type: string
                  response:
                    type: object
      security:
      - bearerAuth: []
      - oAuth:
        - read_user_management
      parameters:
      - name: advancedReporting
        description: Whether this permission enables advanced reporting
        required: false
      

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