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: 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: - 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 enum: - avatar - divisionpermissions - lastUsedDevice - managedUsergroups - promotedDivisions - usergroups - userpermission - 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: 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 /users/count.json: get: deprecated: false tags: - users operationId: get_users_count description: Retrieve the number of User items summary: /users/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: 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: externalId description: External ID of the user as used in the source application 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: 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: 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 servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /users/description.json: get: deprecated: false tags: - users operationId: get_users_description description: Generates information about the User model and available apis summary: /users/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_user_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 /users/invite.json: get: deprecated: false tags: - users operationId: get_users_invite description: Send an invite to all users who have a pending invitation summary: /users/invite.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: 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: 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 servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /users/me.json: get: deprecated: false tags: - users operationId: get_users_me description: Generates information about the current API user summary: /users/me.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: 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: 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: 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 servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /users/me/recommendations.json: get: deprecated: false tags: - users operationId: get_users_me_recommendations description: Get recommendations for the current user summary: /users/me/recommendations.json responses: default: description: successful operation content: application/json: schema: type: object security: - bearerAuth: [] - oAuth: - read_user_management - read_contentprofile_management parameters: - name: recommendationsType description: 'Indicates the type of recommendations you want to fetch (default: homescreen)' 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 /users/me/tickets.json: get: deprecated: false tags: - users operationId: get_users_me_tickets description: Get tickets for the current user summary: /users/me/tickets.json responses: default: description: successful operation content: application/json: schema: type: object security: - bearerAuth: [] - oAuth: - read_user_management - read_contentprofile_management parameters: - name: recommendationsType description: 'Indicates the type of recommendations you want to fetch (default: homescreen)' 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 /users/{id1}/usergroups/{id2}.json: get: deprecated: false tags: - users operationId: get_users_id1_usergroups_id2 description: Link or unlink an user with ID = 'id1' to a usergroup with ID = 'id2' summary: /users/{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 response: type: object security: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id1 description: ID of the User item required: true in: path schema: type: string - name: id2 description: ID of the Usergroup 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 /users/{id1}/usergroups/{id2}/link.json: post: deprecated: false tags: - users operationId: link_users_id1_usergroups_id2_link description: Link a user with ID = 'id1' to a usergroup with ID = 'id2' summary: /users/{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_user_management parameters: - name: id1 description: ID of the User item required: true in: path schema: type: string - name: id2 description: ID of the Usergroup 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 /users/{id1}/usergroups/{id2}/unlink.json: post: deprecated: false tags: - users operationId: unlink_users_id1_usergroups_id2_unlink description: Unlink a user with ID = 'id1' from an usergroup with ID = 'id2' summary: /users/{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_user_management parameters: - name: id1 description: ID of the User item required: true in: path schema: type: string - name: id2 description: ID of the Usergroup 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 /users/{id}.json: get: deprecated: true tags: - users operationId: get_users_id description: 'Retrieve User 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/getUserById). 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/{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 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: id 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: 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: 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: - users operationId: put_users_id description: Update the User item with ID='id' summary: /users/{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 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: - write_user_management parameters: - name: id description: ID of the User 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 enum: - avatar - divisionpermissions - lastUsedDevice - managedUsergroups - promotedDivisions - usergroups - userpermission - 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: bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean email: type: string emailNotifications: type: boolean emailSignature: type: string externalId: type: string firstName: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date isActive: type: boolean isSynced: type: boolean language: type: string lastName: type: string managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean timezone: type: string userName: type: string userType: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string application/json: schema: type: object properties: bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean email: type: string emailNotifications: type: boolean emailSignature: type: string externalId: type: string firstName: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date isActive: type: boolean isSynced: type: boolean language: type: string lastName: type: string managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean timezone: type: string userName: type: string userType: 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_id description: Update the User item with ID='id' summary: /users/{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 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: - write_user_management parameters: - name: id description: ID of the User 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 enum: - avatar - divisionpermissions - lastUsedDevice - managedUsergroups - promotedDivisions - usergroups - userpermission - 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: bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean email: type: string emailNotifications: type: boolean emailSignature: type: string externalId: type: string firstName: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date isActive: type: boolean isSynced: type: boolean description: When the value is changed from `true` to `false`, other property updates will be ignored. language: type: string lastName: type: string managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean timezone: type: string userName: type: string userType: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string application/json: schema: type: object properties: bccAddresses: type: array items: type: string companyName: type: string companyRole: type: string consentGiven: type: boolean email: type: string emailNotifications: type: boolean emailSignature: type: string externalId: type: string firstName: type: string forcePasswordReset: type: boolean ftueStatus: type: string insightsLastViewedAt: type: string format: date isActive: type: boolean isSynced: type: boolean language: type: string lastName: type: string managerId: type: string password: type: string phone: type: string productLicenseContent: type: string productLicenseTrainingCoaching: type: string provisionedBy: type: string scimId: type: string sendMailToUser: type: boolean timezone: type: string userName: type: string userType: type: string anyOf: - title: owner type: string - title: tablet type: string - title: manager type: string - title: admin type: string delete: deprecated: false tags: - users operationId: delete_users_id description: Delete the User item with ID='id' summary: /users/{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_user_management parameters: - name: id 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 /users/{id}/channels.json: get: deprecated: false tags: - users operationId: get_users_id_channels description: Get all channels that belong to the user with ID='id' summary: /users/{id}/channels.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 appLink: description: The app link to this channel type: string assets: description: The assets linked to this channel type: object properties: href: type: string format: link background: description: The background image linked to this channel type: - string - 'null' format: link backgroundPosition: description: Pivot point for the background type: string channelNodes: description: The channel nodes linked to this channel type: object properties: href: type: string format: link cover: description: The cover image linked to this channel type: - string - 'null' format: link coverFocalPoint: description: The gravity point of the cover image. Consists of a X and a Y coordinate between 0 and 1, where the origin indicates top left and the coordinates(1,1) represent bottom right type: - string - 'null' createdAt: description: The date that the user was created type: string format: date-time currentChannelTemplateConfig: description: The channel template config that is currently being used for this channel type: - object - 'null' properties: id: type: string href: type: string format: link currentTemplateAsset: description: The template app linked to this channel type: - string - 'null' format: link division: description: The division linked to this channel type: object properties: id: type: string href: type: string format: link externalId: description: External ID of the tag as used in the source application type: - string - 'null' isPersonal: description: Set if the channel is a personal (my) channel type: boolean lockedUntil: description: The date the channel will be unlocked (if null, the channel is unlocked) type: - string - 'null' format: date-time logo: description: The logo image linked to this channel type: - string - 'null' format: link logoPosition: description: The pivot point for the logo type: string name: description: The name of the channel type: string description: description: The description of the channel type: - string - 'null' isHidden: description: Defines if the experience should be shown in the UI type: boolean hideEmptyFolders: description: Defines if the folders should be hidden when they are empty type: boolean enableContentProfiles: description: Defines if dynamic content profiles are enabled type: boolean defaultViewMode: description: Defines the default view for the experience type: string rootChannelNode: description: The root channel node linked to this channel type: object properties: id: type: string href: type: string format: link status: description: The state of the profile, is one of "active", "lockedForDuplication", "pendingForDuplication" type: string template: description: Indicates the type of template the channel is using type: - string - 'null' type: description: Indicates the type of the channel (classic or template) type: string updatedAt: description: The date that the user was updated type: string format: date-time usergroups: description: The groups linked to this channel type: object properties: href: type: string format: link users: description: The users linked to this channel type: object properties: href: type: string format: link security: - bearerAuth: [] - oAuth: - read_user_management - read_content_profile_management parameters: - name: id description: ID of the User item required: true in: path schema: type: string - name: appLink description: The app link to this channel required: false in: query schema: type: string - name: defaultViewMode description: Defines the default view for the experience required: false in: query 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: description description: The description of the channel 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: 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: includeApps description: Include app channels required: false in: query schema: type: boolean - name: includeTemplateChannels description: Include template channels required: false in: query schema: type: boolean - name: isHidden description: Defines if the experience should be shown in the UI required: false in: query schema: type: boolean - name: isPersonal description: Set if the channel is a personal (my) channel 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 channel 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: personalContentIncluded description: Whether or not to include personal content when querying for a user 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 createdAt, name, updatedAt. 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: template description: Indicates the type of template the channel is using required: false in: query schema: type: string - name: type description: Indicates the type of the channel (classic or template) 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 /users/{id}/divisionpermissions.json: get: deprecated: false tags: - users operationId: get_users_id_divisionpermissions description: Get all division permissions that belong to the user with ID='id' summary: /users/{id}/divisionpermissions.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 createdAt: description: The date that the division permission was created type: string format: date-time division: description: The division this division permission belongs to type: object properties: id: type: string href: type: string format: link divisionId: description: Id of the division this division permission belongs to type: string externalId: description: External ID of the tag as used in the source application type: - string - 'null' updatedAt: description: The date that the division permission was updated type: string format: date-time user: description: The user this division permission belongs to type: object properties: id: type: string href: type: string format: link userId: description: Id of the user this division permission belongs to type: string manageAssets: description: Whether this permission enables assets management type: boolean manageExperiences: description: Whether this permission enables experiences management type: boolean deleteExperiences: description: Whether this permission enables experiences deletion type: boolean manageCoursesAndChecklists: description: Whether this permission enables courses and checklists management type: boolean manageAiRoleplays: description: Whether this permission enables management of AI roleplays type: boolean manageAnnouncements: description: Whether this permission enables announcements management type: boolean viewUsers: description: Whether this permission enables users view type: boolean manageUsers: description: Whether this permission enables users management type: boolean readinessReporting: description: Whether this permission enables readiness reporting type: boolean contentReporting: description: Whether this permission enables content reporting type: boolean reporting: description: Whether this permission enables reporting type: boolean messaging: description: Whether this permission enables messaging type: boolean manageContent: description: Whether this permission enables content management type: boolean createUserGroups: description: Whether this permission enables user group creation type: boolean manageTags: description: Whether this permission enables tag management type: boolean notifyUsersByEmail: description: Whether this permission enables email notification of users type: boolean expiredAt: description: The date that the division permission was expired type: - string - 'null' format: date-time metadata: description: Metadata field for different purposes type: - string - 'null' manageSharingThemes: description: Whether this permission allows sharing theme management in case the sharing feature would be enabled type: boolean security: - bearerAuth: [] - oAuth: - read_user_management - read_division_management parameters: - name: id description: ID of the User item required: true in: path schema: type: string - name: contentReporting description: Whether this permission enables content reporting required: false in: query schema: type: boolean - name: createUserGroups description: Whether this permission enables the creation of groups 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: expiredAt description: The date that the division permission was expired required: false in: query schema: type: string format: date - 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: manageAnnouncements description: Whether this permission enables announcements management required: false in: query schema: type: boolean - name: manageAssets description: Whether this permission enables assets management required: false in: query schema: type: boolean - name: manageContent description: Whether this permission enables managing content required: false in: query schema: type: boolean - name: manageCoursesAndChecklists description: Whether this permission enables courses and checklists management required: false in: query schema: type: boolean - name: manageAiRoleplays description: Whether this permission enables management of AI roleplays required: false in: query schema: type: boolean - name: manageExperiences description: Whether this permission enables experiences management required: false in: query schema: type: boolean - name: deleteExperiences description: Whether this permission enables experiences deletion required: false in: query schema: type: boolean - name: manageUsers description: Whether this permission enables users management required: false in: query schema: type: boolean - name: messaging description: Whether this permission enables messaging required: false in: query schema: type: boolean - name: metadata description: Metadata field for different purposes 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: post type: string - name: notifyUsersByEmail description: Whether this permission enables email notification of users 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: readinessReporting description: Whether this permission enables readiness reporting required: false in: query schema: type: boolean - name: reporting description: Whether this permission enables reporting 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: viewUsers description: Whether this permission enables users view required: false in: query schema: type: boolean post: deprecated: false tags: - users operationId: post_users_id_divisionpermissions description: Add a division permission to a user with ID='id' summary: /users/{id}/divisionpermissions.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 createdAt: description: The date that the division permission was created type: string format: date-time division: description: The division this division permission belongs to type: object properties: id: type: string href: type: string format: link divisionId: description: Id of the division this division permission belongs to type: string externalId: description: External ID of the tag as used in the source application type: - string - 'null' updatedAt: description: The date that the division permission was updated type: string format: date-time user: description: The user this division permission belongs to type: object properties: id: type: string href: type: string format: link userId: description: Id of the user this division permission belongs to type: string manageAssets: description: Whether this permission enables assets management type: boolean manageExperiences: description: Whether this permission enables experiences management type: boolean deleteExperiences: description: Whether this permission enables experiences deletion type: boolean manageCoursesAndChecklists: description: Whether this permission enables courses and checklists management type: boolean manageAiRoleplays: description: Whether this permission enables management of AI roleplays type: boolean manageAnnouncements: description: Whether this permission enables announcements management type: boolean viewUsers: description: Whether this permission enables users view type: boolean manageUsers: description: Whether this permission enables users management type: boolean readinessReporting: description: Whether this permission enables readiness reporting type: boolean contentReporting: description: Whether this permission enables content reporting type: boolean reporting: description: Whether this permission enables reporting type: boolean messaging: description: Whether this permission enables messaging type: boolean manageContent: description: Whether this permission enables content management type: boolean createUserGroups: description: Whether this permission enables user group creation type: boolean manageTags: description: Whether this permission enables tag management type: boolean notifyUsersByEmail: description: Whether this permission enables email notification of users type: boolean expiredAt: description: The date that the division permission was expired type: - string - 'null' format: date-time metadata: description: Metadata field for different purposes type: - string - 'null' manageSharingThemes: description: Whether this permission allows sharing theme management in case the sharing feature would be enabled type: boolean security: - bearerAuth: [] - oAuth: - write_user_management - write_division_management parameters: - name: id 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 requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: divisionId: type: string userId: type: string contentReporting: type: boolean expiredAt: type: string format: date externalId: type: string manageAnnouncements: type: boolean manageAssets: type: boolean manageCoursesAndChecklists: type: boolean manageAiRoleplays: type: boolean manageExperiences: type: boolean deleteExperiences: type: boolean manageUsers: type: boolean metadata: type: string notifyUsersByEmail: type: boolean readinessReporting: type: boolean viewUsers: type: boolean required: - divisionId - userId application/json: schema: type: object properties: divisionId: type: string userId: type: string contentReporting: type: boolean expiredAt: type: string format: date externalId: type: string manageAnnouncements: type: boolean manageAssets: type: boolean manageCoursesAndChecklists: type: boolean manageAiRoleplays: type: boolean manageExperiences: type: boolean deleteExperiences: type: boolean manageUsers: type: boolean metadata: type: string notifyUsersByEmail: type: boolean readinessReporting: type: boolean viewUsers: type: boolean required: - divisionId - userId servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /users/{id}/divisions.json: get: deprecated: false tags: - users operationId: get_users_id_divisions description: Get all divisions that belong to the user with ID='id' summary: /users/{id}/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: - read_user_management - read_division_management parameters: - name: id 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: 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 servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /users/{id}/email-preferences.json: get: deprecated: false tags: - users operationId: get_users_id_email-preferences description: Get the email preference that belongs to the current user summary: /users/{id}/email-preferences.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 - read_contentprofile_management parameters: - name: id 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: 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: 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 post: deprecated: false tags: - users operationId: post_users_id_email-preferences description: Get the email preference that belongs to the current user summary: /users/{id}/email-preferences.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_user_management - write_contentprofile_management parameters: - name: id 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 requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: activitiesSubscriptionEnabled: type: boolean commentsSubscriptionEnabled: type: boolean contentAddedSubscriptionEnabled: type: boolean insightsSubscriptionEnabled: type: boolean mentionsSubscriptionEnabled: type: boolean userJoinedSubscriptionEnabled: type: boolean application/json: schema: type: object properties: activitiesSubscriptionEnabled: type: boolean commentsSubscriptionEnabled: type: boolean contentAddedSubscriptionEnabled: type: boolean insightsSubscriptionEnabled: type: boolean mentionsSubscriptionEnabled: type: boolean userJoinedSubscriptionEnabled: type: boolean servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /users/{id}/externalservices.json: get: deprecated: false tags: - users operationId: get_users_id_externalservices description: Get the external service that belongs to the current user summary: /users/{id}/externalservices.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 division: description: The division of the external service type: string format: link type: description: The type of the external service type: string name: description: The name of the external service type: string externalId: description: The external id provided by the external service type: string createdAt: description: The created at of the external service type: string format: date updatedAt: description: The updated at of the external service type: string format: date security: - bearerAuth: [] - oAuth: - read_user_management - read_content_profile_management parameters: - name: id 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: expand description: Comma separated list of all expanded relationships that need to be retrieved. required: false in: query schema: type: string - name: externalId description: The external id provided by the external service 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: The name of the external service 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 - name: type description: The type of the external service 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 /users/{id}/invite.json: get: deprecated: false tags: - users operationId: get_users_id_invite description: Send an invitation email to a single user summary: /users/{id}/invite.json responses: default: description: successful operation content: application/json: schema: type: object security: - bearerAuth: [] - oAuth: - read_user_management parameters: - name: id description: '' required: true in: path 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 /users/{id}/link.json: post: deprecated: false tags: - users operationId: link_users_id_link description: Link the User item with ID='id' summary: /users/{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_user_management parameters: - name: id 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 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 /users/{id}/unlink.json: post: deprecated: false tags: - users operationId: unlink_users_id_unlink description: Link the User item with ID='id' summary: /users/{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_user_management parameters: - name: id 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 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 /users/{id}/usergroups.json: get: deprecated: false tags: - users operationId: get_users_id_usergroups description: Get all usergroups that belong to the user with ID='id' summary: /users/{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: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id 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: 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 post: deprecated: false tags: - users operationId: post_users_id_usergroups description: Add a usergroup to a user with ID='id' summary: /users/{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: - bearerAuth: [] - oAuth: - write_user_management parameters: - name: id 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 requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: name: type: string contentProfiles: type: array items: type: string description: type: string externalId: type: string provisionedBy: type: string required: - name application/json: schema: type: object properties: name: type: string contentProfiles: type: array items: type: string description: type: string externalId: type: string provisionedBy: type: string required: - name servers: - url: https://{subdomain}.showpad.biz/api/v3/ description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /users: get: operationId: getUsers summary: List Users description: 'Returns a list of existing Users that are available to the requester. **Note:** This API endpoint only support basic `GET` functionality in this version (`v4`). Please refer to version 3 (`/v3`) for more advanced operations. ' tags: - users security: - BearerAuth: [] parameters: - name: limit in: query description: A limit on the number of objects to be returned, between `0` and `1000`. schema: type: integer format: int32 default: 50 minimum: 0 maximum: 1000 - name: offset in: query description: Offset of the returned result, to be used in combination with `limit`. required: false schema: type: integer format: int32 default: 0 minimum: 0 - name: ids in: query description: One or multiple IDs to filter on. Combined in an **OR** fashion. explode: false style: form example: - abc123 - def456 schema: type: array items: type: string - name: emails in: query description: One or multiple emails to filter on. explode: false style: form example: - bob@example.com - john@example.com schema: type: array items: type: string responses: '200': description: OK. Request is successful. content: application/json: schema: type: object properties: count: description: Total number of results. type: integer format: int32 example: 1 items: type: array description: List of Users. items: type: object properties: id: type: string title: UserId description: Unique identifier for the object. example: c143c05d12c1433ba1358c7eb2e07c75 email: type: string description: The email address of the user. format: email example: bob.smith@example.com firstName: type: string example: Bob description: The first name of the user. lastName: type: string example: Smith description: The last name of the user. createdAt: type: string format: date-time description: 'Time at which the object was created. Serialized in the `ISO-8601` string format (UTC timezone). ' example: '2021-01-01T00:00:00Z' updatedAt: type: string format: date-time description: 'Time at which the object was last updated. Serialized in the `ISO-8601` string format (UTC timezone). ' example: '2021-01-01T08:00:00Z' '401': description: Unauthorized. Authorization is either invalid or expired. content: application/problem+json: schema: type: object required: - title - detail - status properties: title: type: string description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non-technical stakeholders and not localized). ' example: Invalid Payload detail: type: string description: 'A human readable explanation specific to this occurrence of the problem. ' example: Property value provided is not a valid. status: type: integer format: int32 description: 'The HTTP status code generated by the origin server for this occurrence of the problem. ' minimum: 400 maximum: 599 example: 400 meta: type: - array - 'null' description: Additional information to support the error. items: anyOf: - type: object description: Additional payload to support the encountered error. required: - name - reason - category properties: name: type: string example: color description: The name of the affected resource attribute. reason: type: string example: must be 'green', 'red' or 'blue' description: The explanation of the problem. category: type: string example: propertyRequired description: The error category. examples: UnauthorizedExample: value: title: Unauthorized detail: Authorization is either invalid or expired. status: 401 '403': description: Forbidden. Requester does not have the right permissions to execute request. content: application/problem+json: schema: type: object required: - title - detail - status properties: title: type: string description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non-technical stakeholders and not localized). ' example: Invalid Payload detail: type: string description: 'A human readable explanation specific to this occurrence of the problem. ' example: Property value provided is not a valid. status: type: integer format: int32 description: 'The HTTP status code generated by the origin server for this occurrence of the problem. ' minimum: 400 maximum: 599 example: 400 meta: type: - array - 'null' description: Additional information to support the error. items: anyOf: - type: object description: Additional payload to support the encountered error. required: - name - reason - category properties: name: type: string example: color description: The name of the affected resource attribute. reason: type: string example: must be 'green', 'red' or 'blue' description: The explanation of the problem. category: type: string example: propertyRequired description: The error category. examples: ForbiddenExample: value: title: Forbidden detail: Server refuses to authorize the request. status: 403 servers: - url: https://{subdomain}.api.showpad.com/v4 description: Production server x-environment: production variables: subdomain: default: customer description: Showpad customer subdomain /users/{userId}: parameters: - name: userId in: path required: true description: The user ID. schema: type: string example: c143c05d12c1433ba1358c7eb2e07c75 get: operationId: getUserById summary: Retrieve a User description: 'Retrieves the details of an existing User object. **Note:** This API endpoint only support basic `GET` functionality in this version (`v4`). Please refer to version 3 (`/v3`) for more advanced operations. ' tags: - users security: - BearerAuth: [] responses: '200': description: Returns the requested User object. x-summary: OK. Request is successful. content: application/json: schema: type: object properties: id: type: string title: UserId description: Unique identifier for the object. example: c143c05d12c1433ba1358c7eb2e07c75 email: type: string description: The email address of the user. format: email example: bob.smith@example.com firstName: type: string example: Bob description: The first name of the user. lastName: type: string example: Smith description: The last name of the user. createdAt: type: string format: date-time description: 'Time at which the object was created. Serialized in the `ISO-8601` string format (UTC timezone). ' example: '2021-01-01T00:00:00Z' updatedAt: type: string format: date-time description: 'Time at which the object was last updated. Serialized in the `ISO-8601` string format (UTC timezone). ' example: '2021-01-01T08:00:00Z' '401': description: Unauthorized. Authorization is either invalid or expired. content: application/problem+json: schema: type: object required: - title - detail - status properties: title: type: string description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non-technical stakeholders and not localized). ' example: Invalid Payload detail: type: string description: 'A human readable explanation specific to this occurrence of the problem. ' example: Property value provided is not a valid. status: type: integer format: int32 description: 'The HTTP status code generated by the origin server for this occurrence of the problem. ' minimum: 400 maximum: 599 example: 400 meta: type: - array - 'null' description: Additional information to support the error. items: anyOf: - type: object description: Additional payload to support the encountered error. required: - name - reason - category properties: name: type: string example: color description: The name of the affected resource attribute. reason: type: string example: must be 'green', 'red' or 'blue' description: The explanation of the problem. category: type: string example: propertyRequired description: The error category. examples: UnauthorizedExample: value: title: Unauthorized detail: Authorization is either invalid or expired. status: 401 '403': description: Forbidden. Requester does not have the right permissions to execute request. content: application/problem+json: schema: type: object required: - title - detail - status properties: title: type: string description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non-technical stakeholders and not localized). ' example: Invalid Payload detail: type: string description: 'A human readable explanation specific to this occurrence of the problem. ' example: Property value provided is not a valid. status: type: integer format: int32 description: 'The HTTP status code generated by the origin server for this occurrence of the problem. ' minimum: 400 maximum: 599 example: 400 meta: type: - array - 'null' description: Additional information to support the error. items: anyOf: - type: object description: Additional payload to support the encountered error. required: - name - reason - category properties: name: type: string example: color description: The name of the affected resource attribute. reason: type: string example: must be 'green', 'red' or 'blue' description: The explanation of the problem. category: type: string example: propertyRequired description: The error category. examples: ForbiddenExample: value: title: Forbidden detail: Server refuses to authorize the request. status: 403 '404': description: Not found. Resource does not exists. content: application/problem+json: schema: type: object required: - title - detail - status properties: title: type: string description: 'A short, summary of the problem type. Written in english and readable for engineers (usually not suited for non-technical stakeholders and not localized). ' example: Invalid Payload detail: type: string description: 'A human readable explanation specific to this occurrence of the problem. ' example: Property value provided is not a valid. status: type: integer format: int32 description: 'The HTTP status code generated by the origin server for this occurrence of the problem. ' minimum: 400 maximum: 599 example: 400 meta: type: - array - 'null' description: Additional information to support the error. items: anyOf: - type: object description: Additional payload to support the encountered error. required: - name - reason - category properties: name: type: string example: color description: The name of the affected resource attribute. reason: type: string example: must be 'green', 'red' or 'blue' description: The explanation of the problem. category: type: string example: propertyRequired description: The error category. examples: NotFoundExample: value: title: Missing Resource detail: The requested resource does not exist. status: 404 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