Skip to main content
GET
Get Project Overview

Authentication

This endpoint requires JWT authentication via the verifyJWT middleware. Include your access token in the Authorization header.

Path Parameters

string
required
The unique identifier of the project (MongoDB ObjectId)

Response

boolean
required
Indicates whether the request was successful
object
required
The project overview data
object | null
required
Information about the most recent build, or null if no builds exist

Example Request

Example Response

Example Response (Node.js Project)

Error Responses

Returned when:
  • Project with the specified ID doesn’t exist
  • Project doesn’t belong to the authenticated user
  • Project has been deleted
Returned when a server error occurs

Implementation Notes

  • Only returns projects owned by the authenticated user
  • Excludes projects with status deleted
  • Automatically calculates build duration from startedAt and finishedAt timestamps
  • Duration format: seconds shown as {s}s, minutes shown as {m}m {s}s
  • Returns custom domain if hascustomDomain is true, otherwise returns subdomain
  • Build information is fetched separately and joined with project data

Source Reference

backend/src/controllers/slices/Project/getProjectOverview.js:4