v3

latestOpenAPI 3.1.02026-07-311725107.3 KB

Projects

Get a project

Retrieves details about a specific Project

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

Path parameters

ownerKeyOrIdstring required

Repository owner name (login) or workspace ID

Example:acme-corp

Repository owner name (login) or workspace ID

keyOrIdstring required

Repository name or project ID

Example:my-repo

Repository name or project ID

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

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