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
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.qlty.sh/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
ownerKeyOrId
string
required

The key or ID of the Workspace that owns the Project

​
projectKeyOrId
string
required

The key or ID of the Project to retrieve components for

Response

Successful response

​
data
object[]
required

List of Component items returned in the response