Skip to main content
GET
/
workspaces
/
{workspace_id}
Get workspace details
curl --request GET \
  --url https://api.wacht.dev/workspaces/{workspace_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "4444444444",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-20T15:45:00Z",
  "name": "Engineering",
  "description": "Engineering team workspace",
  "image_url": "https://cdn.wacht.dev/workspaces/engineering.png",
  "member_count": 10,
  "public_metadata": {},
  "private_metadata": {},
  "organization_id": "1234567890",
  "organization_name": "Acme Corp",
  "roles": [
    {
      "id": "5555555555",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T15:45:00Z",
      "name": "Developer",
      "permissions": [
        "read:projects",
        "write:projects",
        "deploy:production"
      ],
      "is_deployment_level": false
    }
  ],
  "segments": []
}

Authorizations

​
Authorization
string
header
required

API key authentication (Bearer token)

Path Parameters

​
workspace_id
string
required

Workspace ID (integer as string)

Response

Workspace details retrieved successfully

​
id
string
required

Workspace ID (integer serialized as string)

Example:

"4444444444"

​
created_at
string<date-time>
required
Example:

"2024-01-15T10:30:00Z"

​
updated_at
string<date-time>
required
Example:

"2024-01-20T15:45:00Z"

​
name
string
required

Workspace name

Example:

"Engineering"

​
description
string
required

Workspace description

Example:

"Engineering team workspace"

​
image_url
string
required

Workspace image URL

Example:

"https://cdn.wacht.dev/workspaces/engineering.png"

​
member_count
integer
required

Number of members in the workspace

Example:

10

​
public_metadata
object
required

Public metadata (custom fields)

Example:
{}
​
private_metadata
object
required

Private metadata (custom fields, only accessible via backend API)

Example:
{}
​
organization_id
string
required

Organization ID (integer serialized as string)

Example:

"1234567890"

​
organization_name
string
required

Parent organization name

Example:

"Acme Corp"

​
roles
object[]
required

Roles defined in this workspace

​
segments
object[]
required

Segments associated with this workspace

Example:
[]