Showpad · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Showpad Exports API
26 actions
26 updates
phrasing
extends
openapi/showpad-exports-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Showpad's API. It is a proposal applied on top of the contract, not a document Showpad publishes.
What the actions change
x-apievangelist-phrasing
Targets 26 · first 16 shown; the file carries all of them
$.info
$.paths['/exports/asset-authors.json'].get
$.paths['/exports/asset-countries.json'].get
$.paths['/exports/asset-languages.json'].get
$.paths['/exports/asset-tags.json'].get
$.paths['/exports/assets.json'].get
$.paths['/exports/channel-usergroups.json'].get
$.paths['/exports/channel-users.json'].get
$.paths['/exports/channels.json'].get
$.paths['/exports/collectionitems.json'].get
$.paths['/exports/collections.json'].get
$.paths['/exports/contacts.json'].get
$.paths['/exports/devices.json'].get
$.paths['/exports/division-usergroups.json'].get
$.paths['/exports/divisions.json'].get
$.paths['/exports/events.json'].get
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Showpad Exports API
version: 1.0.0
extends: openapi/showpad-exports-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 25
- target: $.paths['/exports/asset-authors.json'].get
update:
x-apievangelist-phrasing:
intent: Export asset authors
effect: read
questions:
- Who authored each asset in our library, as a bulk export?
- Can I page through the asset-to-author mapping for reporting?
instructions:
- text: Export the asset authors list.
- text: Pull {limit} asset-author rows starting at offset {offset}.
slots:
limit: query.limit
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/asset-countries.json'].get
update:
x-apievangelist-phrasing:
intent: Export asset country assignments
effect: read
questions:
- Which countries is each piece of content assigned to?
- Is there a bulk dump of asset-country links for our data warehouse?
instructions:
- text: Export every asset's country assignments.
- text: Fetch {limit} asset-country records.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/asset-languages.json'].get
update:
x-apievangelist-phrasing:
intent: Export asset language assignments
effect: read
questions:
- What language is each asset tagged with across the whole library?
- Can I extract asset-language pairs in pages?
instructions:
- text: Export the languages assigned to assets.
- text: Download asset-language records from offset {offset}.
slots:
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/asset-tags.json'].get
update:
x-apievangelist-phrasing:
intent: Export asset-to-tag links
effect: read
questions:
- Which tags are applied to which assets, in one export?
- How can I audit tagging coverage across all content?
instructions:
- text: Export all asset-tag links.
- text: Get {limit} asset-tag associations per page.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/assets.json'].get
update:
x-apievangelist-phrasing:
intent: Export all assets
effect: read
questions:
- How do I bulk export our entire content library metadata?
- Can I sync every asset record into a BI tool in batches?
instructions:
- text: Export every asset in the library.
- text: Pull the asset export {limit} records at a time from offset {offset}.
slots:
limit: query.limit
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/channel-usergroups.json'].get
update:
x-apievangelist-phrasing:
intent: Export channel-to-user-group access
effect: read
questions:
- Which user groups have access to which channels?
- Can I export channel group assignments for an access review?
instructions:
- text: Export channel user-group assignments.
- text: Get {limit} channel-usergroup rows.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/channel-users.json'].get
update:
x-apievangelist-phrasing:
intent: Export channel-to-user access
effect: read
questions:
- Which individual users are assigned to each channel?
- Is there an export of direct user access per channel?
instructions:
- text: Export the users assigned to each channel.
- text: Fetch channel-user records starting at {offset}.
slots:
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/channels.json'].get
update:
x-apievangelist-phrasing:
intent: Export all channels
effect: read
questions:
- How can I get a full extract of every channel we've built?
- What does the bulk channel export include?
instructions:
- text: Export all channels.
- text: Page through the channel export with page size {limit}.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/collectionitems.json'].get
update:
x-apievangelist-phrasing:
intent: Export collection items
effect: read
questions:
- What items are inside every collection, as one bulk export?
- Can I extract which assets sit in which collections?
instructions:
- text: Export the contents of all collections.
- text: Retrieve {limit} collection-item rows from offset {offset}.
slots:
limit: query.limit
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/collections.json'].get
update:
x-apievangelist-phrasing:
intent: Export all collections
effect: read
questions:
- How do I get a list of every collection users have created?
- Is there a paged export of collection records?
instructions:
- text: Export all collections themselves, not their items.
- text: Get collection records {limit} per page.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/contacts.json'].get
update:
x-apievangelist-phrasing:
intent: Export contacts
effect: read
questions:
- How do I pull all customer contacts out of Showpad?
- Can I export recipients our reps have shared with?
instructions:
- text: Export all contacts.
- text: Fetch contacts in batches of {limit}.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/devices.json'].get
update:
x-apievangelist-phrasing:
intent: Export registered devices
effect: read
questions:
- Which devices are registered to our users?
- Can I export device records to check app adoption?
instructions:
- text: Export all registered devices.
- text: List device export rows from offset {offset}.
slots:
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/division-usergroups.json'].get
update:
x-apievangelist-phrasing:
intent: Export division-to-user-group links
effect: read
questions:
- Which user groups belong to which divisions?
- Can I extract division group membership in bulk?
instructions:
- text: Export division user-group links.
- text: Get {limit} division-usergroup rows.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/divisions.json'].get
update:
x-apievangelist-phrasing:
intent: Export all divisions
effect: read
questions:
- How do I get a bulk extract of our divisions?
- Is there a division export for syncing org structure elsewhere?
instructions:
- text: Export all divisions.
- text: Pull divisions from the export starting at offset {offset}.
slots:
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/events.json'].get
update:
x-apievangelist-phrasing:
intent: Export usage events
effect: read
questions:
- How do I export content usage events between two dates?
- Can I get only events of one type or for one user?
- Is there a way to filter exported events to specific channels?
instructions:
- text: Export events that started after {startedAt} and ended before {endedAt}.
slots:
startedAt: query.startedAt
endedAt: query.endedAt
- text: Export {eventType} events for user {userId}.
slots:
eventType: query.eventType
userId: query.userId
- text: Get events logged after {loggedAfter} in channels {channelIds}.
slots:
loggedAfter: query.loggedAfter
channelIds: query.channelIds
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/sharedspace-items.json'].get
update:
x-apievangelist-phrasing:
intent: Export shared space items
effect: read
questions:
- What content has been placed in each shared space?
- Can I bulk export the items inside all shared spaces?
instructions:
- text: Export the items in all shared spaces.
- text: Fetch shared-space item rows, {limit} at a time.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/sharedspaceparticipants.json'].get
update:
x-apievangelist-phrasing:
intent: Export shared space participants
effect: read
questions:
- Who has joined each shared space, across all of them?
- Can I export buyer participation in shared spaces?
instructions:
- text: Export every shared space participant.
- text: Get shared space participants from offset {offset}.
slots:
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/sharedspaces.json'].get
update:
x-apievangelist-phrasing:
intent: Export all shared spaces
effect: read
questions:
- How do I extract a list of all shared spaces in the account?
- Is there a paged dump of shared space records?
instructions:
- text: Export all shared spaces.
- text: Pull {limit} shared space records per request.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/shares.json'].get
update:
x-apievangelist-phrasing:
intent: Export content shares
effect: read
questions:
- Which content did reps share with customers, in bulk?
- Can I export all share records for engagement analysis?
instructions:
- text: Export all shares sent by users.
- text: Fetch share records starting at offset {offset}.
slots:
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/tagcategories.json'].get
update:
x-apievangelist-phrasing:
intent: Export tag categories
effect: read
questions:
- How do I export every tag category we've defined?
- Is there a bulk extract of the tag category hierarchy?
instructions:
- text: Export all tag categories.
- text: Get tag category records in pages of {limit}.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/tagcategory-tags.json'].get
update:
x-apievangelist-phrasing:
intent: Export tag-to-category links
effect: read
questions:
- Which tags sit under which tag category?
- Can I export the mapping between categories and their tags?
instructions:
- text: Export tag category membership for every tag.
- text: Retrieve tagcategory-tag links from offset {offset}.
slots:
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/tags.json'].get
update:
x-apievangelist-phrasing:
intent: Export all tags
effect: read
questions:
- How do I get every tag in the account as an export?
- Can I page through all tags for cleanup?
instructions:
- text: Export all tags.
- text: Fetch {limit} tags from the tag export.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/user-usergroups.json'].get
update:
x-apievangelist-phrasing:
intent: Export user-to-group memberships
effect: read
questions:
- Which users are in which user groups, in one extract?
- Can I export group membership for an access audit?
instructions:
- text: Export every user's group memberships.
- text: Get user-usergroup rows starting at {offset}.
slots:
offset: query.offset
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/usergroups.json'].get
update:
x-apievangelist-phrasing:
intent: Export all user groups
effect: read
questions:
- How do I export the full list of user groups?
- Is there a bulk user group extract I can page through?
instructions:
- text: Export all user groups.
- text: Pull user group records with a page size of {limit}.
slots:
limit: query.limit
method: generated
generated: '2026-10-01'
- target: $.paths['/exports/users.json'].get
update:
x-apievangelist-phrasing:
intent: Export all users
effect: read
questions:
- How do I bulk export every user account for HR reconciliation?
- Can I extract all users in pages for a data warehouse load?
instructions:
- text: Export all users in bulk.
- text: Fetch the user export from offset {offset}, {limit} rows at a time.
slots:
offset: query.offset
limit: query.limit
method: generated
generated: '2026-10-01'