Showpad

Showpad Users API

The users API from Showpad — 22 operation(s) for users.

GitHub OpenAPI

Operations 29

GET /users.json /users.json #
POST /users.json /users.json #
GET /users/count.json /users/count.json #
GET /users/description.json /users/description.json #
GET /users/invite.json /users/invite.json #
GET /users/me.json /users/me.json #
GET /users/me/recommendations.json /users/me/recommendations.json #
GET /users/me/tickets.json /users/me/tickets.json #
GET /users/{id1}/usergroups/{id2}.json /users/{id1}/usergroups/{id2}.json #
GET /users/{id}.json /users/{id}.json #
PUT /users/{id}.json /users/{id}.json #
POST /users/{id}.json /users/{id}.json #
DELETE /users/{id}.json /users/{id}.json #
GET /users/{id}/channels.json /users/{id}/channels.json #
GET /users/{id}/divisionpermissions.json /users/{id}/divisionpermissions.json #
POST /users/{id}/divisionpermissions.json /users/{id}/divisionpermissions.json #
GET /users/{id}/divisions.json /users/{id}/divisions.json #
GET /users/{id}/email-preferences.json /users/{id}/email-preferences.json #
POST /users/{id}/email-preferences.json /users/{id}/email-preferences.json #
GET /users/{id}/externalservices.json /users/{id}/externalservices.json #
GET /users/{id}/invite.json /users/{id}/invite.json #
GET /users/{id}/usergroups.json /users/{id}/usergroups.json #
POST /users/{id}/usergroups.json /users/{id}/usergroups.json #
GET /users List Users #
GET /users/{userId} Retrieve a User #

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-users-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-users-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-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Showpad Users 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 users 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: users
  description: ''
paths:
  /users.json:
    get:
      deprecated: true
      tags:
      - users
      operationId: get_users
      description: 'Generates a list of User 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/getUsers).

        For more detailed information on when to use V3 or V4, please refer to [User Management](https://developer.showpad.com/docs/apis/users/user-management).'
      summary: /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_user_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: 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
          enum:
          - avatar
          - divisionpermissions
          - lastUsedDevice
          - managedUsergroups
          - promotedDivisions
          - usergroups
          - userpermission
      - 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:
      - users
      operationId: post_users
      description: Create a User item
      summary: /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:
                      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: in

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