---
title: "Retrieve Project"
method: GET
path: "/tenants/{tenant_id}/projects/{id}"
tags: ["Projects"]
---

# Retrieve Project

`GET /tenants/{tenant_id}/projects/{id}`

Retrieve a project by ID.

## Path parameters

- `tenant_id` string, uuid, required
- `id` string, uuid, required

## Response `200`

Project successfully retrieved.

- object
  - `project` object
    - `external_provider_id` string — Unique ID of customer provided by external provider.
    - `name` string — Name of the project.
    - `customer_salutation` string — Salutation of the homeowner.
    - `customer_first_name` string — First name of the homeowner.
    - `customer_last_name` string — Last name of the homeowner.
    - `mailing_address` string — Mailing address of the homeowner. It's not used to calculate latitude/longitude coordinates or property_address.
    - `customer_email` string — Email of the homeowner.
    - `customer_phone` string — Phone number of the homeowner.
    - `owner_id` string, uuid — ID of the user who owns the project.
    - `team_id` string, uuid — ID of team associated with project. The owner of the project must be a member of this team. If the owner belongs to only one team, the project will be associated with that team on project creation if `team_id` is not provided.
    - `status` string — The status of the project.
    - `preferred_solar_modules` string[] — List of solar modules unique IDs. If specified, this list will be used in AutoDesigner in Sales Mode and Design Mode.
    - `tags` string[] — Tags associated with the project.
    - `location` object
      - `property_address` string — Full address of the project in the following format ('123 Main Street, Unit 12, City, CA 93120, USA'). Either address or a lat/long pair must be provided. If only address is provided, Aurora will set lat/long. If only lat/long are provided, Aurora will reverse GEO code the address. If neither are provided the request is rejected. If both are provided both are set.
      - `latitude` number, double — Latitude of the site. If not both latitude and longitude are set (or both are null), the address will be used to geocode. Reject if only one is set.
      - `longitude` number, double — Latitude of the site. If not both latitude and longitude are set (or both are null), the address will be used to geocode. Reject if only one is set.
      - `property_address_components` object
        - `street_address` string — Number and street of the project.
        - `city` string — City of the project.
        - `region` string — Region, state, or province of the project.
        - `postal_code` string — Postal code of the project.
        - `country` string — Country of the project.
    - `project_type` 'residential' | 'commercial' — Type of the project. Defaults to `"residential"`.
    - `partner_id` string, uuid — Unique ID identifying the partner associated with the project. The owner of the project must be part of the partner. If the owner belongs to only one partner, the project will be associated with that partner on project creation if `partner_id` is not provided.
    - `id` string, uuid — Unique ID identifying the project.
    - `created_from_lead_id` string, uuid — ID of the lead from which the project was generated (if applicable).
    - `ahj_id` string, uuid — ID of the Authority Having Jurisdiction (AHJ) that contains the project’s property address according to the US Census TIGER/Line Legal Boundary Shapefiles. Note that AHJ assignment happens asynchronously so the ID may still be `null` immediately after project creation. You can subscribe to the `ahj_lookup_completed` webhook event to be notified when the asynchronous AHJ assignment is complete.
    - `order_id` string, nullable — ID of the order from which the project was generated (if applicable), formatted as an ObjectID
    - `created_at` string — The timestamp of when the project was created, formatted as "YYYY-MM-DD HH:MM:SS UTC"

## Other responses

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

---

[API](https://skmtc.net/aurorasolar/apis/sync-api.md) · [All operations](https://skmtc.net/aurorasolar/apis/sync-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aurorasolar/sync-api/versions/5b41808d104d/schema)