Get Workspace

GET 
/api/v1/workspaces/:workspace

Get a Workspace by its ID or Name.

Request

Path Parameters

workspace stringrequired

Responses

200

Success

application/json

Schema

Schema

id integerrequired
ID of the Workspace
Possible values: > 0
Example: 1000
name stringrequired
Name of the Workspace
Example: Workspace 1
createdAt date-timerequired
Creation Date of the Workspace
Example: 2025-03-12T18:12:44.464Z
updatedAt date-timerequired
Update Date of the Workspace
Example: 2025-03-12T18:12:44.464Z
description stringnullablerequired
Description of the Workspace
Example: Description

Example (from schema)

{
  "id": 1000,
  "name": "Workspace 1",
  "createdAt": "2025-03-12T18:12:44.464Z",
  "updatedAt": "2025-03-12T18:12:44.464Z",
  "description": "Description"
}

400

Validation Error

application/json

Schema

Schema

status stringrequired

Possible values: [Validation Error]

errors

object[]

required

Array [

error stringrequired

location stringrequired

Possible values: [body, query, path, headers]

]

Example (from schema)

{
  "status": "Validation Error",
  "errors": [
    {
      "error": "string",
      "location": "body"
    }
  ]
}

401

Unauthorized

application/json

Schema

Schema

status stringrequired

Possible values: [Unauthorized]

Example (from schema)

{
  "status": "Unauthorized"
}

404

Workspace not found

application/json

Schema

Schema

status stringrequired

Possible values: [Workspace not found]

Example (from schema)

{
  "status": "Workspace not found"
}

Loading...