Headers
Bearer token for authentication
Path Parameters
UUID of the workspace to retrieve
Query Parameters
Comma-separated list of related resources to include. Available options: memberships
Response
Workspace retrieved successfully
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"
}
}
]
}
Retrieve a specific workspace by ID
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"
}
}
]
}
Bearer token for authentication
UUID of the workspace to retrieve
Comma-separated list of related resources to include. Available options: memberships
Workspace retrieved successfully
Show child attributes