Read Visit by ID
๐งพ Read Visit by ID
Endpoint: GET /api/v3/visits/{visitId}
Auth Required: โ Yes (Bearer Token)
๐ Description
Retrieves detailed information about a specific visit by its unique ID. This endpoint is used to fetch visit metadata, such as schedule, site, attendees, and visit status.
๐ข 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 Authorization: Bearer <token>
โ Success Response (200 OK)
Returns the full Visit
object.
Example:
{ "VisitID": 555, "Name": "Enterprise Security Briefing", "Status": "Confirmed", "StartDate": "2025-11-05T09:00:00Z", "EndDate": "2025-11-05T12:00:00Z", "Site": "New York Innovation Center", "Requester": "jane.doe@example.com" }
โ Error Responses
Code | Message | Description |
---|---|---|
401 | Unauthorized | Missing or invalid bearer token. |
404 | Not Found | No visit found with the specified ID. |
500 | Internal Server Error | Unexpected server-side failure. |