Skip to main content
GET
Get project

Authorizations

X-API-Key
string
header
required

Per-manufacturer API key in the X-API-Key header, format emidat-{key_id}-{secret} where key_id is a random public handle. Issued by an owner in the Emidat dashboard; carries its own permission scopes, optional plant restrictions, and optional expiry. A revoked, expired, or unknown key returns 401. See the Authentication guide for details.

Path Parameters

id
string<uuid>
required

UUID of the project.

Response

Project.

id
string<uuid>
required

UUID of the project.

external_id
string | null
required

Your own code for this project. null when none is set.

name
string
required
Example:

"Tower A"

customer
object
required

The client a project is built for. Customers are managed in the Emidat app; a project names its customer by customer_name.

address
object
required

The site address of a project, exactly as it was sent. Fields left out are empty strings, except house_number, which is null.

products
object[]
required
gwp_total
number | null
required

A1–A3 GWP-total (EN 15804+A2) of the whole delivery in kg CO₂e: the sum over the lines of quantity times gwp_per_unit. null while any line's gwp_per_unit is null; the lines show which.

gwp_total_net
number | null
required

As gwp_total, from the lines' gwp_per_unit_net. null while any line's gwp_per_unit_net is null.

created_at
string<date-time>
required