Skip to main content
GET
List Workspaces

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys.

Query Parameters

page
integer
default:1
Required range: x >= 1
limit
integer
default:10
Required range: x >= 1
name
string

Filter workspaces by name.

viewModes
string

Comma-separated workspace views, such as owned,shared.

archived
enum<string>

Controls whether archived workspaces are included.

Available options:
include,
exclude,
only

Response

Successful response

workspaces
object[]
required
total
integer
required
page
integer
required
limit
integer
required
totalPages
integer
required
workspace_repositories
object[]
workspace_pull_requests
object[]
creator_names
object
creator_avatar_urls
object
shared_with
object
viewer_share_ids
string<uuid>[]