List Sites

🧾 List Sites

Endpoint: GET /api/v3/sites

Auth Required: ✅ Yes (Bearer Token)

📝 Description

Retrieves a paginated list of sites, which represent physical or virtual locations available for visits. Commonly used to populate site selectors in scheduling, reporting, or visit creation workflows.

🔍 Query Parameters

Parameter	Type	Required	Default	Description
`includeInactive`	boolean	No	—	If true, includes inactive sites.
`languageId`	integer	No	—	Language ID for localized site names.
`page`	integer	No	1	Page number for pagination.
`pageSize`	integer	No	25	Number of records per page.

📤 Request Example

GET https://api.briefingedge.com/api/v3/sites?page=1&pageSize=25&includeInactive=false&languageId=1 Authorization: Bearer <token>

✅ Success Response (200 OK)

Returns an array of Site objects with pagination metadata.

Example:

{  "Records": [    {      "SiteID": 101,      "Name": "Silicon Valley HQ",      "City": "San Jose",      "IsActive": true    },    {      "SiteID": 102,      "Name": "New York Innovation Center",      "City": "New York",      "IsActive": true    }  ],  "Metadata": {    "Page": 1,    "PageSize": 25,    "Total": 200  } }

❌ Error Responses

Code	Message	Description
401	Unauthorized	Missing or invalid bearer token.
500	Internal Server Error	Unexpected server-side failure.