Skip to main content
GET
/
gh
/
{ownerKeyOrId}
/
projects
/
{projectKeyOrId}
/
components
List components
curl --request GET \
  --url https://api.qlty.sh/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/components \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Backend API",
      "description": "Core backend API services",
      "pathGlobs": "src/api/**",
      "fileCount": 42
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Generate an API token at https://qlty.sh/user/settings/tokens

Path Parameters

​
ownerKeyOrId
string
required

Repository owner name (login) or workspace ID

Minimum string length: 3
Example:

"acme-corp"

​
projectKeyOrId
string
required

Repository name or project ID

Minimum string length: 3
Example:

"my-repo"

Response

List components for the project

​
data
object[]
required