Showpad

Showpad User Groups API

The User Groups API from Showpad — 14 operation(s) for user groups.

GitHub OpenAPI
Business capability
Identity & Access Management BC-620.20

Operations 20

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 /usergroups.json List user groups · /usergroups.json #
Ask an LLM
“Which user groups exist in our Showpad organization?”
“Can I list only the groups synced from our identity provider?”
Tell an agent
List all user groups.
Find user groups named {name}.
POST /usergroups.json Create a user group · /usergroups.json #
Ask an LLM
“How do I create a new user group for a team?”
“Can I attach content profiles when creating a group?”
Tell an agent
Create a user group called {name}.
Create group {name} with content profiles {contentProfiles}.
GET /usergroups/count.json Count user groups · /usergroups/count.json #
Ask an LLM
“How many user groups do we have?”
“What's the number of synced groups?”
Tell an agent
Count all user groups.
Count the groups with synced set to {isSynced}.
GET /usergroups/description.json Describe the user group data model · /usergroups/description.json #
Ask an LLM
“What fields does a user group object have?”
“Where can I see the API calls supported for user groups?”
Tell an agent
Describe the user group model and its available API calls.
Show me the property definitions for the usergroup resource.
GET /usergroups/{id1}/divisions/{id2}.json Link or unlink a group and division via GET · /usergroups/{id1}/divisions/{id2}.json #
Ask an LLM
“Is there a GET override for adding or removing a user group's division access?”
“Can I toggle a group's division assignment with the method parameter?”
Tell an agent
Use method {method} to change the link between user group {id1} and division {id2}.
Through GET, apply {method} to group {id1}'s access to division {id2}.
GET /usergroups/{id1}/users/{id2}.json Link or unlink a group member via GET · /usergroups/{id1}/users/{id2}.json #
Ask an LLM
“Is there a GET override for adding or removing a member of a user group?”
“Can I change someone's group membership with the method query parameter?”
Tell an agent
For member {id2} of group {id1}, send method {method} on the membership endpoint.
Through GET with method {method}, add or remove person {id2} in group {id1}.
GET /usergroups/{id}.json Get a user group · /usergroups/{id}.json #
Ask an LLM
“How do I fetch one user group's details?”
“What does a single user group record include?”
Tell an agent
Get user group {id}.
Show the details of group {id}.
PUT /usergroups/{id}.json Update a user group (PUT) · /usergroups/{id}.json #
Ask an LLM
“How do I rename a user group with a PUT request?”
“Can I change a group's content profiles with PUT?”
Tell an agent
PUT an update renaming user group {id} to {name}.
Using PUT, set group {id}'s content profiles to {contentProfiles}.
POST /usergroups/{id}.json Update a user group (POST) · /usergroups/{id}.json #
Ask an LLM
“Can I update a user group with POST instead of PUT?”
“Is there a POST variant for changing a group's description or sync flag?”
Tell an agent
Via POST, set group {id}'s description to {description}.
Using the POST update, set synced to {isSynced} on user group {id}.
DELETE /usergroups/{id}.json Delete a user group · /usergroups/{id}.json #
Ask an LLM
“How do I delete a user group?”
“What happens when I remove a group we no longer need?”
Tell an agent destructive · confirm first
Delete user group {id}.
Remove group {id} from Showpad.
GET /usergroups/{id}/divisions.json List a user group's divisions · /usergroups/{id}/divisions.json #
Ask an LLM
“Which divisions can a given user group access?”
“Can I see only the divisions with asset sharing enabled for a group?”
Tell an agent
List the divisions of user group {id}.
Show divisions of group {id} with asset sharing {hasDivisionAssetSharingEnabled}.
POST /usergroups/{id}/divisions.json Create a division for a user group · /usergroups/{id}/divisions.json #
Ask an LLM
“How do I create a new division and attach it to a user group?”
“Can I enable division asset sharing on a division I create for a group?”
Tell an agent
Create division {name} for user group {id}.
Add a new division {name} to group {id} with asset sharing {hasDivisionAssetSharingEnabled}.
GET /usergroups/{id}/users.json List members of a user group · /usergroups/{id}/users.json #
Ask an LLM
“Who are the members of a specific user group?”
“Can I list only the active or invited members of a group?”
Tell an agent
List the users in user group {id}.
Show members of group {id} with active set to {isActive}.
POST /usergroups/{id}/users.json Create a new user inside a group · /usergroups/{id}/users.json #
Ask an LLM
“How do I create a new user and put them in a group in one step?”
“What details does a new group member need?”
Tell an agent
Create user {userName} ({firstName} {lastName}, {email}) in group {id} with language {language} and active {isActive}.
Add a brand-new user with email {email} to user group {id}.

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://artifacts.apis.io/showpad/openapi/showpad-user-groups-api-openapi.yml

Other Resources

🔗
Versioning
https://developer.showpad.com/docs/apis/concepts/versions
🔗
ErrorCatalog
https://artifacts.apis.io/showpad/errors/showpad-problem-types.yml
🔗
DataModel
https://artifacts.apis.io/showpad/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-user-groups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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-user-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Showpad Usergroups API
  version: '3'
  termsOfService: https://www.showpad.com/terms-of-service
  contact:
    name: Showpad
    email: support@showpad.com
    url: https://help.showpad.com/hc/en-us/requests/new
  x-audience: external-partner
servers:
- url: https://{subdomain}.showpad.biz/api/v3/
  description: Production server
  x-environment: production
  variables:
    subdomain:
      default: customer
      description: Showpad customer subdomain
security:
- oAuth: []
- bearerAuth: []
tags:


# --- truncated at 32 KB (132 KB total) ---
# Full source: https://artifacts.apis.io/showpad/openapi/showpad-user-groups-api-openapi.yml