Skip to main content
GET
Get a workspace

Authorizations

Authorization
string
header
required

Generate an API token at https://qlty.sh/user/settings/tokens

Path Parameters

keyOrId
string
required

Workspace key or ID

Minimum string length: 3
Example:

"my-workspace"

Response

Retrieve the workspace

id
string
required
Example:

"ws_abc123"

key
string
required
Example:

"my-workspace"

avatarUrl
string
required
Example:

"https://example.com/avatar.png"

providerUrl
string
required
Example:

"https://github.com/my-workspace"

createdAt
string<date-time>
required
Example:

"2024-01-01T00:00:00.000Z"

updatedAt
string<date-time>
required
Example:

"2024-01-01T00:00:00.000Z"