.png){kind=logo}
Read Site by ID
🧾 Read Site by ID
Endpoint: GET /api/v3/sites/{siteId}
Auth Required: ✅ Yes (Bearer Token)
📝 Description
Retrieves full details of a specific site by its unique ID. Site records include location information, program metadata, and scheduling constraints. Commonly used in visit setup, site management, and reporting tools.
🔢 URL Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
siteId |
integer/string | ✅ Yes | Unique identifier of the site. |
🔍 Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
languageId |
integer | No | Language ID for localized site fields. |
📤 Request Example
GET https://api.briefingedge.com/api/v3/sites/1001?languageId=1 Authorization: Bearer <token>
✅ Success Response (200 OK)
Returns the full Site object.
Example:
{ "SiteID": 1001, "Name": "Silicon Valley HQ", "City": "San Jose", "State": "California", "Country": "USA", "IsActive": true, "MaxVisitsPerDay": 10, "AllowWeekendVisits": false }
❌ Error Responses
| Code | Message | Description |
|---|---|---|
| 401 | Unauthorized | Missing or invalid bearer token. |
| 404 | Not Found | No site found with the specified ID. |
| 500 | Internal Server Error | Unexpected server-side failure. |