Projects

Get project details

Returns details of a project and metadata

get/v2/project/{organization}/{project}

Request

  • Base URL: https://api.zephyr-cloud.io
  • URL: https://api.zephyr-cloud.io/v2/project/{organization}/{project}
  • Auth: HTTP bearer

Path parameters

organizationstring required

Organization name (slug)

Example:zephyr-cloud
projectstring required

Project name (slug)

Example:main-app

Query parameters

includestring[]

Include related data (applications, contributors)

[
  "applications"
]

Response

Project details

Example response

{
  "value": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "authorId": "550e8400-e29b-41d4-a716-446655440001",
    "organizationId": "550e8400-e29b-41d4-a716-446655440002",
    "name": "main-app",
    "displayName": "Main Application",
    "deletedAt": null,
    "updatedAt": "2025-12-17T00:00:00.000Z",
    "description": "The main application project",
    "metadata": [
      "frontend",
      "react"
    ],
    "visibility": "private"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.