Shared Space Templates
Shared Space templates let you boost Shared Spaces adoption and promote best practices. They help create on-brand, pre-filled content tailored to specific scenarios. Shared Space templates can significantly reduce the time needed to create engaging Shared Spaces.
What you'll learn:
- How to retrieve a single Shared Space template by ID
- How to list all available templates in your organization
- Understanding template properties and usage metrics
TL;DR
- Get one template? Use
GET /shared-space-templates/{templateId}with the template ID - List all templates? Use
GET /shared-space-templatesto retrieve all templates - Track usage? Check the
usageCountfield to see how often a template is used
When to use the API
| Sync Templates to External Systems | Build Custom Template Selectors | Monitor Template Usage | Automate Shared Space Creation |
|---|---|---|---|
| Export template data to your CRM or sales enablement tools. | Create custom UIs that let users browse and select templates. | Track which templates are most popular with your sales team. | Use template data to programmatically create consistent Shared Spaces. |
Prerequisites
- Plan: Ultimate | Advanced or Expert
- Permissions: Administrator access to Showpad's Admin App
- Authentication: Valid OAuth 2.0 access token (learn more)
- Config: Shared Spaces enabled
Base Endpoint
The base endpoint for Shared Space template calls is:
https://{{subdomain}}.api.showpad.com/v4
Every API v4 request needs to be prefixed with the base endpoint.
Single Shared Space Template
| Method | Endpoint | Description |
|---|---|---|
GET | /shared-space-templates/{templateId} | Returns a single Shared Space Template (specified by {templateId}). |
Request
- cURL
- JavaScript
- Python
curl -X GET \
'https://{{subdomain}}.api.showpad.com/v4/shared-space-templates/976491ea-d7cb-42ca-a576-eff0ccd1957d' \
--header 'Authorization: Bearer MyApiToken' \
--header 'Content-Type: application/json'
const response = await fetch(
'https://{{subdomain}}.api.showpad.com/v4/shared-space-templates/976491ea-d7cb-42ca-a576-eff0ccd1957d',
{
method: 'GET',
headers: {
Authorization: 'Bearer MyApiToken',
'Content-Type': 'application/json',
},
}
);
const data = await response.json();
console.log(data);
import requests
url = "https://{{subdomain}}.api.showpad.com/v4/shared-space-templates/976491ea-d7cb-42ca-a576-eff0ccd1957d"
headers = {
"Authorization": "Bearer MyApiToken",
"Content-Type": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())
Response
{
"id": "976491ea-d7cb-42ca-a576-eff0ccd1957d",
"isPublished": true,
"creator": {
"id": "b5f5e881324f61479002be5cda41b1ca"
},
"name": "Marketing & Revenue Collaboration Template",
"description": "A template for creating shared spaces where marketing and revenue teams collaborate, adding resources to support sellers and drive business growth",
"division": {
"id": "26092c300714ba38ecc245b0da65daef"
},
"sharedSpaceData": {
"title": "Marketing & Revenue Collaboration",
"description": "A shared space that centralizes resources, strategies, and tools for marketing and revenue teams to collaborate effectively.",
"theme": {
"id": "51be10f001cd0303a4e308a22e051ecb5385615a564eeef116fec329acb33276"
}
},
"usageCount": 0,
"createdAt": "2025-01-09T09:53:50.000Z",
"updatedAt": "2025-01-09T11:20:45.000Z",
"users": [
{
"id": "b5f5e881324f61479002be5cda41b1ca"
}
],
"userGroups": [
{
"id": "9c11d0bcd2c45f6825c05c716a55bc29"
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
id | string | Unique identifier for the template. |
isPublished | boolean | Whether the template is published and available for use. |
creator | object | The user who created the template. |
name | string | Display name of the template. |
description | string | Description of the template's purpose. |
division | object | The division this template belongs to. |
sharedSpaceData | object | Default values applied when creating a Shared Space from this template. |
usageCount | integer | Number of times this template has been used to create Shared Spaces. |
createdAt | string | ISO 8601 timestamp of when the template was created. |
updatedAt | string | ISO 8601 timestamp of when the template was last modified. |
users | array | Users who have access to this template. |
userGroups | array | User groups who have access to this template. |
List of Shared Space Templates
| Method | Endpoint | Description |
|---|---|---|
GET | /shared-space-templates | Returns a list of all Shared Space templates. |
Request
- cURL
- JavaScript
- Python
curl -X GET \
'https://{{subdomain}}.api.showpad.com/v4/shared-space-templates' \
--header 'Authorization: Bearer MyApiToken' \
--header 'Content-Type: application/json'
const response = await fetch('https://{{subdomain}}.api.showpad.com/v4/shared-space-templates', {
method: 'GET',
headers: {
Authorization: 'Bearer MyApiToken',
'Content-Type': 'application/json',
},
});
const data = await response.json();
console.log(data);
import requests
url = "https://{{subdomain}}.api.showpad.com/v4/shared-space-templates"
headers = {
"Authorization": "Bearer MyApiToken",
"Content-Type": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())
Response
{
"count": 1,
"items": [
{
"id": "976491ea-d7cb-42ca-a576-eff0ccd1957d",
"isPublished": true,
"creator": {
"id": "b5f5e881324f61479002be5cda41b1ca"
},
"name": "Marketing & Revenue Collaboration Template",
"description": "A template for creating shared spaces where marketing and revenue teams collaborate.",
"division": {
"id": "26092c300714ba38ecc245b0da65daef"
},
"sharedSpaceData": {
"title": "Marketing & Revenue Collaboration",
"description": "A shared space that centralizes resources for marketing and revenue teams.",
"theme": {
"id": "51be10f001cd0303a4e308a22e051ecb5385615a564eeef116fec329acb33276"
}
},
"usageCount": 0,
"createdAt": "2025-01-09T09:53:50.000Z",
"updatedAt": "2025-01-09T10:01:30.000Z"
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
count | integer | Total number of templates returned. |
items | array | Array of template objects. See Single Shared Space Template for field descriptions. |
Next steps
- Mutual Action Plans - Add collaborative task lists to Shared Spaces
- Quick Actions - Configure quick action buttons for Shared Spaces
- CRM Recommendation Rules - Configure content recommendations based on CRM data
- Webhooks - Subscribe to Shared Space events for real-time updates
Was this page helpful?