Get Space Information

Retrieve detailed information about a specific space, including workspace details, hosts, co-hosts, guests, and conversation groups.

Endpoint

GET /v1/workspaces/{workspaceId}/spaces/{spaceId}

Authentication

Requires API key authentication via x-api-key header.

Path Parameters

ParameterTypeRequiredDescription
workspaceIdstring (UUID)YesThe ID of your workspace
spaceIdstring (UUID)YesThe ID of the space

Headers

HeaderTypeRequiredDescription
x-api-keystringYesYour workspace API key

Response

Success Response

Status Code: 200 OK

Body:

{
  "id": "space-uuid-123",
  "name": "Sales Team Space",
  "description": "Space for the sales team",
  "status": "ACTIVE",
  "createdAt": "2025-01-15T10:30:00Z",
  "workspace": {
    "id": "workspace-uuid-456",
    "name": "My Company",
    "organizationName": "My Organization",
    "organizationId": "org-uuid-789"
  },
  "hosts": [
    {
      "host": {
        "id": "user-uuid-1",
        "name": "John Doe",
        "email": "john@example.com"
      }
    }
  ],
  "coHosts": [],
  "guests": [
    {
      "guest": {
        "id": "user-uuid-2",
        "name": "Jane Smith",
        "email": "jane@example.com"
      }
    }
  ],
  "spaceGroupConversation": [
    {
      "id": "group-uuid-1",
      "name": "General",
      "type": "PUBLIC",
      "lastMessageAt": "2025-01-16T14:20:00Z",
      "createdAt": "2025-01-15T10:30:00Z",
      "updatedAt": "2025-01-16T14:20:00Z",
      "conversations": [
        { "id": "conv-uuid-1" }
      ]
    }
  ]
}

Response Fields

FieldTypeDescription
idstring (UUID)Unique identifier for the space
namestringSpace name
descriptionstringSpace description
statusstringSpace status (e.g., ACTIVE)
createdAtstring (ISO 8601)Space creation timestamp
workspaceobjectWorkspace information
hostsarrayArray of host users
coHostsarrayArray of co-host users
guestsarrayArray of guest users
spaceGroupConversationarrayConversation groups in the space

Example

curl -X GET \
  'https://api.sharely.ai/v1/workspaces/{workspaceId}/spaces/{spaceId}' \
  -H 'x-api-key: sk-sharely-your-api-key'

Error Responses

404 Not Found

Space not found:

{
  "error": "Error",
  "message": "Space not found"
}