Shared Spaces

Shared Spaces are secure and collaborative spaces that host content, comments, and more all in one place. Access is by invitation only to ensure your content remains secure and visible only to the intended audience.

The following sections explain how you can manage your Shared Spaces.

Prequisites

Showpad Ultimate package
Showpad admin account
Shared Spaces enabled

Base Endpoint

The base endpoint for asset management calls is:

https://{{subdomain}}.api.showpad.com

Every request needs to be prefixed with the base endpoint.

List of Shared Spaces

You can retreive a list of all of the Shared Spaces a user participates in or owns with the following request:

Method	Endpoint	Description
`GET`	`/v4/shared-spaces`	Returns a list of all Shared Spaces for the given ID(s).

tip

You can filter the list by participant email, owner email, title, etc.

Example

The following example retrieves a list of Shared Spaces with a particpant whose email is ‘bob.smith@showpad.com’.

curl -X 'GET' \
  'https://{{subdomain}}.api.showpad.com/v4/shared-spaces?participantEmail=bob.smith%40showpad.com&offset=0&limit=1000' \
  -H 'accept: application/json'

Response

200: Request is successful

{
  "count": 0,
  "items": [
    {
      "id": "{{shared space ID}}",
      "title": "Sales and Marketing teams",
      "status": "ACTIVE",
      "createdAt": "2019-08-24T14:15:22.000Z",
      "lastActivityAt": "2019-08-24T14:15:22.000Z",
      "archivedAt": "2019-08-24T14:15:22.000Z"
    }
  ]
}

Transfer Ownership

While sellers belonging to a Shared Space can manage certain aspects of a Shared Space, there are some that only the owner can manage. There are two ways to transfer ownership of a Shared Space:

via the Showpad Web App - Only the current owner can transfer the ownership.
via API - The current owner or an admin can transfer the ownership. Note: The new owner of a Shared Space does not receive a notification of the transfer of ownership.

Method	Endpoint	Description
`POST`	`/v4/shared-spaces/{shared space ID}/transfer-ownership`	Transfers the ownership of a Shared Space from one user to another. The Shared Space's new owner's ID is specified in the request body.

In order to transfer the ownership of a Shared Spaces, you must first have:

The identifier of the Shared Space
The identifier of the Shared Space's new owner

Now that you've retrieved both of the necessary IDs, you can make a request to this endpoint:

Example

curl -X 'POST' \
  'https://{{subdomain}}.api.showpad.com/v4/shared-spaces/{{shared space ID}}/transfer-ownership' \
  -H 'accept: application/problem+json' \
  -H 'Content-Type: application/json' \
  -d '{
  "userId": "{{owner ID}}"
}'

Response

204: Ownership was successfully transferred`

Troubleshooting

Code	Description
`403 Forbidden`	Requester has no admin right and is not owner of requested shared-space.
`400 Bad Request`	New owner is not found.
`400 Bad Request`	New owner is deactivated user.
`400 Bad Request`	New owner has no content license.
`404 Not found`	Shared space not found.

Base Endpoint​

List of Shared Spaces​

Transfer Ownership​

Troubleshooting​

Base Endpoint

List of Shared Spaces

Transfer Ownership

Troubleshooting