---
title: "Retrieve Site Survey"
method: GET
path: "/tenants/{tenant_id}/site_surveys/{site_survey_id}"
tags: ["Site Surveys"]
---

# Retrieve Site Survey

`GET /tenants/{tenant_id}/site_surveys/{site_survey_id}`

## Request

- Base URL: `https://api-sandbox.aurorasolar.com`
- URL: `https://api-sandbox.aurorasolar.com/tenants/{tenant_id}/site_surveys/{site_survey_id}`
- Auth: HTTP bearer

Returns a site survey.

---

[block:callout]
{
"type": "warning",
"body": "Please note that the Site Surveys API is in beta. As a beta product, the API will not be supported via our normal support channels. You may also experience some gaps and changes as the product is refined and documentation is updated before general release."
}
[/block]

## Path parameters

- `tenant_id` string, uuid, required
- `site_survey_id` string, uuid, required

## Response `200`

Site survey successfully retrieved.

- object
  - `site_survey` object, required
    - `id` string, uuid, required: The ID of the site survey.
    - `project_id` string, uuid, required: The ID of the project the site survey is for.
    - `status` 'in-progress' | 'completed', required: The status of the site survey.
    - `requested_at` string, date-time, nullable: The timestamp when the site survey was requested in UTC.
    - `completed_at` string, date-time, nullable: The timestamp when the site survey was completed in UTC.
    - `created_at` string, date-time, required: The timestamp when the site survey was created in UTC.
    - `report` object, nullable: PDF report to associate with the site survey
      - `url` string, uri, required: URL of the report. If the filename field is not provided, the URL must contain a filename with a `.pdf` extension
      - `filename` string: The filename of the report. It must have a `.pdf` extension
    - `notes` string: Overall notes for the site survey.
    - `images` object[]: List of images to associate with the site survey
      - `url` string, uri, required: URL of the image. If the filename field is not provided, the URL must contain a filename with one of the following extensions: .jpg, .jpeg, .png, .gif, .webp
      - `filename` string: The filename of the image that uses one of the following extensions: .jpg, .jpeg, .png, .gif, .webp
    - `electrical` object: Site survey electrical data.
      - `main_panel_location` 'north_interior' | 'north_exterior' | 'south_interior' | 'south_exterior' | 'east_interior' | 'east_exterior' | 'west_interior' | 'west_exterior' | 'ne_interior' | 'ne_exterior' | 'nw_interior' | 'nw_exterior' | 'se_interior' | 'se_exterior' | 'sw_interior' | 'sw_exterior' | 'basement' | 'garage' | 'barn' | 'pole_mounted' | 'main_floor' | 'roof_top', nullable, required: The location of the main panel.
      - `main_bus_rating` number, nullable, required: The rating of the main bus, in amperes.
      - `main_breaker_rating` number, nullable, required: The rating of the main breaker, in amperes.
      - `service_type` 'single_phase_3_wire' | 'single_phase_2_wire' | '3_phase_4_wire' | '3_phase_3_wire', nullable, required: The service type.
      - `feeder_type` 'overhead' | 'underground' | 'pole_mounted' | 'ct_cabinet' | 'other', nullable, required: The feeder type. If "other", specify in `notes`.
      - `utility_meter_location` 'north_interior' | 'north_exterior' | 'south_interior' | 'south_exterior' | 'east_interior' | 'east_exterior' | 'west_interior' | 'west_exterior' | 'ne_interior' | 'ne_exterior' | 'nw_interior' | 'nw_exterior' | 'se_interior' | 'se_exterior' | 'sw_interior' | 'sw_exterior' | 'basement' | 'garage' | 'barn' | 'pole_mounted' | 'main_floor' | 'roof_top', nullable, required: The location of the utility meter.
      - `existing_grounding` 'ground_rod' | 'cold_water_pipe' | 'ufer' | 'other', nullable, required: The method of the existing grounding. If "other", specify in `notes`.
      - `existing_grounding_location` string, nullable, required: The location of the existing grounding.
      - `main_panel_manufacturer` string, nullable, required: The manufacturer of the main panel.
      - `images` object[], required: List of images to associate with the electrical data
        - `url` string, uri, required: URL of the image. If the filename field is not provided, the URL must contain a filename with one of the following extensions: .jpg, .jpeg, .png, .gif, .webp
        - `filename` string: The filename of the image that uses one of the following extensions: .jpg, .jpeg, .png, .gif, .webp
      - `notes` string, required: Additional notes for the site survey electrical data.
      - `subpanels` object[]: List of electrical subpanels for the site survey.
        - `location` string, nullable, required: Subpanel location
        - `disconnect_location` string, nullable, required: Subpanel disconnect location
        - `bus_rating` number, nullable, required: Rating of the bus in amperes.
        - `disconnect_size` number, nullable, required: Size of the disconnect in amperes.
        - `notes` string, required: Additional notes about the subpanel.
        - `images` object[], required: List of images to associate with the subpanel data
          - `url` string, uri, required: URL of the image. If the filename field is not provided, the URL must contain a filename with one of the following extensions: .jpg, .jpeg, .png, .gif, .webp
          - `filename` string: The filename of the image that uses one of the following extensions: .jpg, .jpeg, .png, .gif, .webp
    - `roof` object, required
      - `mounting_planes` object[], required: Array of mounting planes to store with the site survey.
        - `units_of_measurement` 'Imperial' | 'Metric': The units of measurement to be used for the mounting planes. Uses the tenant default if not provided.
        - `pitch` number, required: The pitch of the mounting plane, measured in degrees.
        - `azimuth` number, required: The azimuth of the mounting plane, measured in degrees from North.
        - `roof_type` 'composition_shingles' | 'tile_flat_concrete' | 'tile_s_concrete' | 'tile_w_concrete' | 'tile_slate' | 'tile_clay' | 'rolled_asphalt' | 'metal_standing_seam' | 'metal_corrugated' | 'other', required: The roof type of the mounting plane. If "other", specify in `notes`.
        - `framing_type` 'trussed' | 'rafters' | 'other', required: The framing type of the mounting plane. If "other", specify in `notes`.
        - `rafter_size` '2x4' | '2x6' | '2x8' | '2x10' | '2x12' | 'other', required: The rafter size for the mounting plane. If "other", specify in `notes`.
        - `rafter_spacing` number, required: The rafter spacing for the mounting plane. Provided in inches if units of measurement is Imperial or centimeters for Metric.
        - `notes` string: Any additional notes for the mounting plane.
        - `images` object[]: List of images to associate with the mounting plane data.
          - `url` string, uri, required: URL of the image. If the filename field is not provided, the URL must contain a filename with one of the following extensions: .jpg, .jpeg, .png, .gif, .webp
          - `filename` string: The filename of the image that uses one of the following extensions: .jpg, .jpeg, .png, .gif, .webp

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found

## Changes

- **2026-11-03** `97a7ad8a993a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/aurorasolar/apis/sync-api/changes/tenants/:tenant_id/site_surveys/:site_survey_id/get.md)

---

[API](https://skmtc.dev/aurorasolar/apis/sync-api.md) - [All operations](https://skmtc.dev/aurorasolar/apis/sync-api/llms.txt) - [OpenAPI document](https://skmtc.dev/aurorasolar/apis/sync-api/revisions/97a7ad8a993a?raw)
