Sign in
latestOpenAPI 3.0.32026-08-10152216352.3 KB

eea119b4113f

Projects

List workspaces of a project

Retrieves all workspaces of a specified project

get/runners/projects/{projectId}/workspaces

Path parameters

projectIdstring required

Unique identifier of the project

Query parameters

searchQuerystring

Search query

pageSizeinteger
offsetinteger

The offset of the items to return

poolIdstring

Filter workspaces by runner pool ID

variableSetIdstring

If provided, only workspaces that consume the variable set will be returned

explicitConsumptionboolean

If true, only workspaces that have an explicit consumption of the variable set will be returned. Must be used in conjunction with variableSetId

Response

Workspaces retrieved successfully

idstring

Unique identifier for the workspace

namestring required

Name of the workspace

descriptionstring

Description of the workspace

accountIdstring

ID of the account the workspace belongs to

repositorystring required

Repository URL for the workspace

workingDirectorystring

Working directory within the repository

vcsIntegrationIdstring required

ID of the VCS integration

vcsstring required

VCS type (e.g., github, gitlab)

defaultBranchstring required

Default branch for the workspace

cronExecutionPatternstring

Cron pattern for scheduled executions

labelsstring[]

Labels assigned to the workspace

poolIdstring

ID of the runner pool associated with the workspace

oidcAuthenticationboolean nullable

OIDC authentication setting. If null, inherits from parent project.

isRemoteboolean

Whether this workspace uses the internal remote backend for state management

Example response

[
  {
    "poolId": "123e4567-e89b-12d3-a456-426614174000"
  }
]