Documentation

Get Project

GET /project/{project_id}

Retrieves a specific project by its ID. Site administrators or project members are allowed to access this endpoint.

Path Parameters

Parameter Type Required Description
project_id string Yes The ID of the project to retrieve

Query Parameters

Parameter Type Default Description
include_tags boolean false Whether to include tags in the response

Response

Success Response (200 OK)

data contains a project object, with site and caller role information. include_tags=true requests tag information.

Error Responses

  • 400 Bad Request: Invalid request
  • 422 Unprocessable Entity: Request fields fail schema validation
  • 401 Unauthorized: Authentication failed
  • 403 Forbidden: Caller cannot access the project under the site’s visibility and permission settings
  • 404 Not Found: Project with the specified ID does not exist

Note: Project access depends on the caller’s project membership, site-wide project edit access, and the site’s project visibility setting.

See the Projects API overview for related endpoints.