Read Visit Itinerary
๐งพ Read Visit Itinerary
Endpoint: GET /api/v3/visits/{visitId}/itinerary
Auth Required: โ Yes (Bearer Token)
๐ Description
Retrieves the full itinerary for a specific visit, including scheduled sessions, topics, speakers, and time blocks. Often used in agenda builders, customer previews, and internal coordination views.
๐ข URL Parameters
Parameter | Type | Required | Description |
---|---|---|---|
visitId |
integer/string | โ Yes | Unique identifier of the visit. |
๐ Query Parameters
None.
๐ค Request Example
GET https://api.briefingedge.com/api/v3/visits/555/itinerary Authorization: Bearer <token>
โ Success Response (200 OK)
Returns the full itinerary object for the visit.
Example:
{ "VisitID": 555, "Agenda": [ { "StartTime": "2025-11-05T09:00:00Z", "EndTime": "2025-11-05T10:00:00Z", "Topic": "Cybersecurity Trends", "Presenter": "Dr. Alex Kim" }, { "StartTime": "2025-11-05T10:15:00Z", "EndTime": "2025-11-05T11:00:00Z", "Topic": "Product Roadmap", "Presenter": "Sarah Lopez" } ] }
โ Error Responses
Code | Message | Description |
---|---|---|
401 | Unauthorized | Missing or invalid bearer token. |
404 | Not Found | No itinerary found for the given visit ID. |
500 | Internal Server Error | Unexpected server-side failure. |