DevelopersReference
Hubs
Collections of tours for an account, with their tour ids.
Base URL https://api.showpilot.com/v1. Every call needs Authorization: Bearer <api key>; see Authentication.
List hubs, newest first
GET /hubs
Scope: hubs:read. Operation id: listHubs.
Parameters
| Name | In | Type | Meaning |
|---|---|---|---|
limit | query | integer | Page size, 1 to 200. Default 50. |
cursor | query | string | The nextCursor from the previous page. Opaque; never build one. |
Example request
curl "https://api.showpilot.com/v1/hubs?limit=50" \
-H "Authorization: Bearer $SHOWPILOT_API_KEY"Runs against your sandbox with a test key.
Response
One page of hubs.
| Field | Type | Always | Meaning |
|---|---|---|---|
items | array of Hub | yes | |
nextCursor | NextCursor | yes |
Hub
| Field | Type | Always | Meaning |
|---|---|---|---|
id | string (uuid) | yes | |
publicId | string or null | yes | |
name | string | yes | |
description | string or null | yes | |
status | string | yes | |
startTourId | string or null (uuid) | yes | |
tourCount | integer | yes | |
publishedTourCount | integer | yes | |
publishedAt | string or null (date-time) | yes | |
createdAt | string (date-time) | yes | |
updatedAt | string (date-time) | yes |
NextCursor
Pass as cursor for the next page; null on the last page.
Errors
| Status | When |
|---|---|
| 400 | A parameter is malformed, such as a cursor this API did not issue, a limit under 1, or an unknown status. Code invalid-request. |
| 401 | No key, or an unknown or revoked key. Code unauthorized. |
| 403 | A valid key without the operation's scope (code insufficient-scope), or a plan without API access (code plan-api-off). |
| 429 | The key's bucket is empty. Code rate-limited; wait the Retry-After seconds. |
One hub with its tour ids
GET /hubs/{id}
Scope: hubs:read. Operation id: getHub.
Parameters
| Name | In | Type | Meaning |
|---|---|---|---|
id | path | string | The hub's UUID or public id. |
Example request
curl "https://api.showpilot.com/v1/hubs/h_2m8x1p" \
-H "Authorization: Bearer $SHOWPILOT_API_KEY"Runs against your sandbox with a test key.
Response
The hub and the ids of its tours.
Every field of Hub, plus:
| Field | Type | Always | Meaning |
|---|---|---|---|
tourIds | array of string (uuid) | yes |
Hub
| Field | Type | Always | Meaning |
|---|---|---|---|
id | string (uuid) | yes | |
publicId | string or null | yes | |
name | string | yes | |
description | string or null | yes | |
status | string | yes | |
startTourId | string or null (uuid) | yes | |
tourCount | integer | yes | |
publishedTourCount | integer | yes | |
publishedAt | string or null (date-time) | yes | |
createdAt | string (date-time) | yes | |
updatedAt | string (date-time) | yes |
Errors
| Status | When |
|---|---|
| 401 | No key, or an unknown or revoked key. Code unauthorized. |
| 403 | A valid key without the operation's scope (code insufficient-scope), or a plan without API access (code plan-api-off). |
| 404 | No object with that id in this workspace. Code not-found. |
| 429 | The key's bucket is empty. Code rate-limited; wait the Retry-After seconds. |