GET
/
workspaces
/
{id}
Get Workspace
curl --request GET \
  --url https://{deploymentHost}/workspaces/{id}
{
  "status": 200,
  "message": "",
  "data": {
    "workspace": {
      "id": "workspace_123456789",
      "name": "Development Team",
      "description": "Workspace for the development team",
      "organization": {
        "id": "org_456789123",
        "name": "Acme Corporation",
        "slug": "acme-corp"
      },
      "members": [
        {
          "id": "member_123456789",
          "user": {
            "id": "user_456789123",
            "first_name": "John",
            "last_name": "Doe",
            "email": "john.doe@acme.com",
            "profile_image_url": "https://cdn.acme.com/avatars/john.jpg"
          },
          "role": "admin",
          "joined_at": "2024-01-15T19:30:00Z"
        },
        {
          "id": "member_987654321",
          "user": {
            "id": "user_789123456",
            "first_name": "Jane",
            "last_name": "Smith",
            "email": "jane.smith@acme.com",
            "profile_image_url": "https://cdn.acme.com/avatars/jane.jpg"
          },
          "role": "member",
          "joined_at": "2024-01-16T10:15:00Z"
        }
      ],
      "members_count": 2,
      "created_at": "2024-01-15T19:30:00Z",
      "updated_at": "2024-01-15T19:30:00Z"
    }
  },
  "session": {
    "signin_attempts": [],
    "signins": [
      {
        "id": "signin_987654321",
        "user_id": "user_456789123",
        "created_at": "2024-01-01T12:00:00Z"
      }
    ],
    "signup_attempts": [],
    "active_signin": {
      "id": "signin_987654321",
      "user_id": "user_456789123",
      "created_at": "2024-01-01T12:00:00Z"
    }
  },
  "errors": []
}

Authorizations

__session
string
cookie
required

Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.

Path Parameters

id
string
required

Workspace ID

Response

200
application/json

Workspace retrieved successfully

The response is of type object.