Skip to main content
GET
Get a project

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"

keyOrId
string
required

Repository name or project ID

Minimum string length: 3
Example:

"my-repo"

Response

Retrieve the project

id
string
required
Example:

"550e8400-e29b-41d4-a716-446655440000"

workspaceId
string
required
Example:

"ws_abc123"

providerUrl
string
required

URL to the repository on the provider

Example:

"https://github.com/acme-corp/my-repo"

key
string
required

Repository name

Example:

"my-repo"

workspaceKey
string
required

Key of the workspace this project belongs to

Example:

"acme-corp"