v3

latestOpenAPI 3.1.02026-07-311725107.3 KB

Components

List components

Retrieve all Components defined for a Project. Supports JSON, newline-delimited JSON (application/x-ndjson), and CSV (text/csv) response formats via the Accept header.

get/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/components

Path parameters

ownerKeyOrIdstring required

Repository owner name (login) or workspace ID

Example:acme-corp

Repository owner name (login) or workspace ID

projectKeyOrIdstring required

Repository name or project ID

Example:my-repo

Repository name or project ID

Response

List components for the project

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Backend API",
      "description": "Core backend API services",
      "pathGlobs": [
        "src/api/*"
      ],
      "fileCount": 42
    }
  ]
}