Showpad

Showpad Users API

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

GitHub OpenAPI

Operations 29

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /users.json List users with filters (v3) · /users.json #
Ask an LLM
“Which users in our Showpad instance are still only invited and haven't activated yet?”
“Can I filter the older v3 user list by last name, language or user type?”
Tell an agent
List v3 users whose email is {email}.
Show users of type {userType} with active status {isActive}, {limit} at a time, using the v3 users list.
POST /users.json Create a new user · /users.json #
Ask an LLM
“How do I add a new salesperson as a user in Showpad?”
“Which fields are mandatory when creating a user account?”
Tell an agent
Create a user {firstName} {lastName} with email {email}, username {userName}, language {language}, active {isActive}.
Add new user {email} reporting to manager {managerId} and email them on creation via {sendMailToUser}.
GET /users/count.json Count users · /users/count.json #
Ask an LLM
“How many users do we have in total?”
“What is the number of active users with a content license?”
Tell an agent
Count the users where isActive is {isActive}.
Give me a headcount of users of type {userType}.
GET /users/description.json Describe the User model and its APIs · /users/description.json #
Ask an LLM
“What fields does the User model have and which user APIs are available?”
“Is there a self-describing schema for the user resource?”
Tell an agent
Show me the User model description and available user endpoints.
Fetch the metadata describing the user resource.
GET /users/invite.json Resend invites to all pending users · /users/invite.json #
Ask an LLM
“How can I nudge everyone who still has a pending invitation?”
“Is there a bulk way to resend all outstanding user invitations?”
Tell an agent
Send invites to every user with a pending invitation.
Re-invite all users who never accepted their invite.
GET /users/me.json Get the current API user · /users/me.json #
Ask an LLM
“Who am I authenticated as when calling the API?”
“What account details belong to the token I'm using right now?”
Tell an agent
Show my own user profile for the current API token.
Get the current user's details with only the fields {fields}.
GET /users/me/recommendations.json Get recommendations for the current user · /users/me/recommendations.json #
Ask an LLM
“What content recommendations does Showpad have for me?”
“Can I narrow my personal recommendations to a particular recommendation type?”
Tell an agent
Show my recommendations of type {recommendationsType}.
List the recommendations made for me.
GET /users/me/tickets.json Get tickets for the current user · /users/me/tickets.json #
Ask an LLM
“Which tickets are assigned to me?”
“Where can I see my own open tickets?”
Tell an agent
List my tickets.
Get the tickets for the current user filtered by type {recommendationsType}.
GET /users/{id1}/usergroups/{id2}.json Link or unlink a user and group via GET method · /users/{id1}/usergroups/{id2}.json #
Ask an LLM
“Is there a single GET call that can either link or unlink a user and a user group?”
“Can I toggle a user's group membership by passing a method parameter?”
Tell an agent
Use method {method} to link or unlink user {id1} with user group {id2} through the combined GET call.
Run the method-switched membership call {method} for user {id1} and group {id2}.
GET /users/{id}.json Retrieve a user (v3) · /users/{id}.json #
Ask an LLM
“How do I look up a single user's full record on the older v3 endpoint?”
“Can I expand related data when fetching one user by ID in v3?”
Tell an agent
Get user {id} from the v3 users endpoint.
Fetch v3 user {id} with expanded {expand}.
PUT /users/{id}.json Update a user with PUT · /users/{id}.json #
Ask an LLM
“How do I change a user's email or name with a PUT request?”
“Can I deactivate a user by updating isActive via PUT?”
Tell an agent
PUT an update to user {id} setting their email to {email}.
Using PUT, set user {id} active status to {isActive}.
POST /users/{id}.json Update a user with POST · /users/{id}.json #
Ask an LLM
“Is there a POST alternative for updating a user's profile when PUT isn't available?”
“Can I change a user's timezone or phone using a POST update?”
Tell an agent
Via the POST update call, set user {id}'s timezone to {timezone}.
POST a change of manager for user {id} to {managerId}.
DELETE /users/{id}.json Delete a user · /users/{id}.json #
Ask an LLM
“How do I permanently remove a user account?”
“What happens when I delete a user by ID?”
Tell an agent destructive · confirm first
Delete user {id}.
Remove the user account with ID {id}.
GET /users/{id}/channels.json List a user's channels · /users/{id}/channels.json #
Ask an LLM
“Which channels does a given user have?”
“Can I see only a user's personal channels or hide template channels?”
Tell an agent
List the channels belonging to user {id}.
Show user {id}'s channels named {name}.
GET /users/{id}/divisionpermissions.json List a user's division permissions · /users/{id}/divisionpermissions.json #
Ask an LLM
“What division-level rights has a particular user been granted?”
“Can I check whether a user can manage assets in their divisions?”
Tell an agent
List division permissions for user {id}.
Show user {id}'s division permissions where manageUsers is {manageUsers}.
POST /users/{id}/divisionpermissions.json Grant a user a division permission · /users/{id}/divisionpermissions.json #
Ask an LLM
“How do I give a user admin rights in a specific division?”
“Can a division permission granted to a user expire automatically?”
Tell an agent
Give user {id} a permission in division {divisionId} for user {userId}.
Grant user {userId} asset management in division {divisionId} through user {id}, expiring {expiredAt}.
GET /users/{id}/divisions.json List the divisions a user belongs to · /users/{id}/divisions.json #
Ask an LLM
“Which divisions is this user a member of?”
“Can I find a user's divisions that have asset sharing turned on?”
Tell an agent
List the divisions for user {id}.
Show user {id}'s divisions named {name}.
GET /users/{id}/email-preferences.json Get a user's email preferences · /users/{id}/email-preferences.json #
Ask an LLM
“Which email notifications is a user subscribed to?”
“Where do I read someone's current email subscription settings?”
Tell an agent
Show the email preferences for user {id}.
Get user {id}'s notification email settings.
POST /users/{id}/email-preferences.json Change a user's email preferences · /users/{id}/email-preferences.json #
Ask an LLM
“How do I turn off comment or mention emails for a user?”
“Can I unsubscribe someone from insights digest emails?”
Tell an agent
Set comment email subscriptions for user {id} to {commentsSubscriptionEnabled}.
Update user {id} so mentions emails are {mentionsSubscriptionEnabled} and insights emails are {insightsSubscriptionEnabled}.
GET /users/{id}/externalservices.json List a user's external services · /users/{id}/externalservices.json #
Ask an LLM
“Which external services are connected to a user's account?”
“Can I filter a user's connected integrations by type?”
Tell an agent
List external services connected for user {id}.
Show user {id}'s external services of type {type}.
GET /users/{id}/invite.json Send an invitation email to one user · /users/{id}/invite.json #
Ask an LLM
“How do I resend the invitation email to just one person?”
“Can I invite a single user rather than everyone pending?”
Tell an agent
Send an invitation email to user {id}.
Re-invite only user {id}.
GET /users/{id}/usergroups.json List a user's user groups · /users/{id}/usergroups.json #
Ask an LLM
“Which user groups does a given person belong to?”
“Can I see only the synced groups a user is in?”
Tell an agent
List the user groups of user {id}.
Show groups for user {id} where isSynced is {isSynced}.
POST /users/{id}/usergroups.json Create a user group for a user · /users/{id}/usergroups.json #
Ask an LLM
“How do I create a new group and add a user to it in one step?”
“Can I give the new group a description and external ID when adding it to a user?”
Tell an agent
Create a user group named {name} for user {id}.
Add a new group {name} described as {description} to user {id}.
GET /users List users (v4) · List Users #
Ask an LLM
“What's the newer v4 way to list users?”
“Can I look up several users at once by a list of emails?”
Tell an agent
Using the v4 API, list users with emails {emails}.
Get the v4 users with IDs {ids}.
GET /users/{userId} Retrieve a user (v4) · Retrieve a User #
Ask an LLM
“How do I fetch one user's details with the v4 API?”
“What does the v4 user object contain?”
Tell an agent
Retrieve v4 user {userId}.
Get the details of user {userId} from the v4 endpoint.

Documentation

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

Specifications

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

Other Resources

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

Work with this as data

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

MCP server

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

https://apis.io/mcp

Tools for apis

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

Call it yourself

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

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

Get an API key

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

GitHub Google LinkedIn

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

OpenAPI Specification

showpad-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Showpad Users API
  contact:
    name: Showpad
    email: support@showpad.com
    url: https://help.showpad.com/hc/en-us/requests/new
  termsOfService: https://www.showpad.com/terms-of-service
  x-audience: external-partner
  x-refined-note:
  - x-logo differs across the merged source definitions and was not carried
  - x-serviceName differs across the merged source definitions and was not carried
  version: '1.0'
  description: 'Operations tagged users across 2 of this provider''s published API definitions: showpad-v3-openapi-original.yml, showpad-v4-openapi-original.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{subdomain}.showpad.biz/api/v3/
  description: Production server
  x-environment: production
  variables:
    subdomain:
      default: customer
      description: Showpad customer subdomain
- url: https://{subdomain}.api.showpad.com/v4
  description: Production server
  x-environment: production
  variables:
    subdomain:
      default: customer
      description: Showpad customer subdomain
tags:


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