.png){kind=logo}
List Visits
🧾 List Visits
Endpoint: GET /api/v3/visits
Auth Required: ✅ Yes (Bearer Token)
📝 Description
Retrieves a paginated list of visits, optionally filtered by common criteria such as status, date range, or other metadata. This endpoint is used for visit dashboards, reports, and visit management features.
🔍 Query Parameters
Supports filtering and pagination.
Available parameters may include:
| Parameter | Type | Description |
|---|---|---|
status |
string | Filter visits by status (e.g., Scheduled ). |
page |
integer | Page number for paginated results. |
pageSize |
integer | Number of visits to return per page. |
startDate |
string | Filter visits starting on or after this date. |
endDate |
string | Filter visits ending on or before this date. |
📤 Request Example
GET https://api.briefingedge.com/api/v3/visits?page=1&pageSize=25&status=Scheduled Authorization: Bearer <token>
✅ Success Response (200 OK)
Returns a paginated array of Visit objects with metadata.
Example:
{ "Records": [ { "VisitID": 1234, "Name": "Tech Strategy Briefing", "Status": "Scheduled", "StartDate": "2025-10-10T09:00:00Z", "EndDate": "2025-10-10T11:00:00Z", "Site": "Silicon Valley HQ" } ], "Metadata": { "Page": 1, "PageSize": 25, "Total": 150 } }
❌ Error Responses
| Code | Message | Description |
|---|---|---|
| 401 | Unauthorized | Missing or invalid bearer token. |
| 500 | Internal Server Error | Unexpected server-side failure. |