For the complete documentation index, see llms.txt. This page is also available as Markdown.

Retrieve a Site

This endpoint retrieves detailed information about a specific site by its ID.

Endpoint Description:

  • Endpoint: GET /api/sites/{site_id}/

  • Base URL: https://api.vomevolunteer.com

Path Parameter:

  • site_id (string): The unique identifier for the site to be retrieved.

Example Request:

GET https://api.vomevolunteer.com/api/sites/8f2c1e5a-..../

Authorization:

Requests to this endpoint must include an API-KEY in the header for authentication.

headers = {
    "API-KEY": "your_unique_api_key_here"
}
response = requests.get("https://api.vomevolunteer.com/api/sites/8f2c1e5a-..../", headers=headers)

Response Structure:

Returns the same fields as a list item. Returns a 404 if the site does not exist in your organization.

{
    "id": "8f2c1e5a-....",
    "name": "Downtown Clinic",
    "description": "",
    "address": "12 King St",
    "general_email": "downtown@example.org",
    "general_phone": "+15551234567",
    "website": "https://downtown.example.org"
}

Last updated