Projects

Get project summary

Returns summary information for the specified project

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

Request

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

Path parameters

organizationstring required

Organization name (slug)

Example:zephyr-cloud

projectstring required

Project name (slug)

Example:main-app

Response

Project summary

Example response

{
  "value": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "main-app",
    "displayName": "Main Application",
    "description": "The main application project",
    "metadata": [
      "frontend",
      "react"
    ],
    "visibility": "private",
    "authorId": "550e8400-e29b-41d4-a716-446655440001",
    "organizationId": "550e8400-e29b-41d4-a716-446655440002"
  }
}

Changes

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