DevelopersReference
Meetings
Bookings the agent made, as objects.
Base URL https://api.showpilot.com/v1. Every call needs Authorization: Bearer <api key>; see Authentication.
Bookings, newest first
GET /meetings
Scope: meetings:read. Operation id: listMeetings.
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. |
visitorId | query | string (uuid) |
Example request
curl "https://api.showpilot.com/v1/meetings?limit=50" \
-H "Authorization: Bearer $SHOWPILOT_API_KEY"Runs against your sandbox with a test key.
Response
One page of meetings.
| Field | Type | Always | Meaning |
|---|---|---|---|
items | array of Meeting | yes | |
nextCursor | NextCursor | yes |
Meeting
| Field | Type | Always | Meaning |
|---|---|---|---|
id | string (uuid) | yes | |
visitorId | string or null (uuid) | yes | |
conversationId | string or null (uuid) | yes | |
agentId | string or null (uuid) | yes | |
leadId | string or null (uuid) | yes | |
provider | string or null | yes | The booking provider. |
repUserId | string or null | yes | |
startAt | string or null (date-time) | yes | |
durationMinutes | integer or null | yes | |
attendee | object | yes | |
bookedAt | 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 booking
GET /meetings/{id}
Scope: meetings:read. Operation id: getMeeting.
Parameters
| Name | In | Type | Meaning |
|---|---|---|---|
id | path | string (uuid) |
Example request
curl "https://api.showpilot.com/v1/meetings/d0000001-0000-4000-8000-000000000000" \
-H "Authorization: Bearer $SHOWPILOT_API_KEY"Runs against your sandbox with a test key.
Response
The meeting.
Meeting
| Field | Type | Always | Meaning |
|---|---|---|---|
id | string (uuid) | yes | |
visitorId | string or null (uuid) | yes | |
conversationId | string or null (uuid) | yes | |
agentId | string or null (uuid) | yes | |
leadId | string or null (uuid) | yes | |
provider | string or null | yes | The booking provider. |
repUserId | string or null | yes | |
startAt | string or null (date-time) | yes | |
durationMinutes | integer or null | yes | |
attendee | object | yes | |
bookedAt | 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. |