Skip to main content
GET
/
v1
/
workspaces
/
{id}
Get workspace
curl --request GET \
  --url https://api.wellapp.ai/v1/workspaces/{id} \
  --header 'Authorization: <authorization>'
{
  "data": {
    "type": "workspace",
    "id": "550e8400-e29b-41d4-a716-446655440003",
    "attributes": {
      "name": "Marketing Team Workspace",
      "description": "Collaborative workspace for the marketing team to manage campaigns and content",
      "created_at": "2024-01-05T08:00:00Z",
      "updated_at": "2024-01-18T12:15:00Z",
      "avatar_color": "#FF5733",
      "external_workspace_id": "mkt-workspace-001",
      "auto_extract_enabled": false
    },
    "relationships": {
      "memberships": {
        "data": [
          {
            "type": "membership",
            "id": "550e8400-e29b-41d4-a716-446655440005"
          },
          {
            "type": "membership",
            "id": "550e8400-e29b-41d4-a716-446655440006"
          }
        ]
      }
    }
  },
  "included": [
    {
      "type": "membership",
      "id": "550e8400-e29b-41d4-a716-446655440005",
      "attributes": {
        "role": "owner",
        "status": "active"
      }
    },
    {
      "type": "memberships",
      "id": "550e8400-e29b-41d4-a716-446655440006",
      "attributes": {
        "role": "member",
        "status": "active"
      }
    }
  ]
}

Headers

Authorization
string
required

Bearer token for authentication

Path Parameters

id
string<uuid>
required

UUID of the workspace to retrieve

Query Parameters

include
string

Comma-separated list of related resources to include. Available options: memberships

Response

Workspace retrieved successfully

data
object
I