QLqlty
Projects

Get a project

Changed on

Retrieves details about a specific Project

get/gh/{ownerKeyOrId}/projects/{keyOrId}

Request

  • Base URL
    https://api.qlty.sh
  • Auth
    HTTP bearer

Path parameters

ownerKeyOrIdstring required

Repository owner name (login) or workspace ID

Example:acme-corp
keyOrIdstring required

Repository name or project ID

Example:my-repo

Response

Retrieve the project

idstring required
workspaceIdstring required
providerUrlstring required

URL to the repository on the provider

keystring required

Repository name

workspaceKeystring required

Key of the workspace this project belongs to

applicationIdstring nullable required

ID of the Application this project is assigned to, or null when unassigned

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "workspaceId": "ws_abc123",
  "providerUrl": "https://github.com/acme-corp/my-repo",
  "key": "my-repo",
  "workspaceKey": "acme-corp",
  "applicationId": "550e8400-e29b-41d4-a716-446655440001"
}

Changes