Documentation

Get Project Overview

GET /project/{project_id}/overview

Returns a project overview, containing various statistics and information about the project. The level of detail in the response depends on the user's permissions.

Path Parameters

Parameter Type Required Description
project_id string Yes Project ID for which to retrieve the overview

Response

Success Response (200 OK)

data contains users.count, files.count, and reservations with count, start, and end. It includes reservations.total when the caller can view reservation prices. Callers with site-wide project edit access also receive invoices.count and invoices.total.

Error Responses

  • 400 Bad Request: Invalid request
  • 422 Unprocessable Entity: Request fields fail schema validation
  • 401 Unauthorized: Authentication failed
  • 403 Forbidden: User does not have permission to access project overview (administrator access required)
  • 404 Not Found: Project with the specified ID does not exist

See the Projects API overview for related endpoints.