Skip to main content

Workspace

The Workspace API exposes read access to your workspace's metadata, its members, and its teams. It's the directory you reach for when you need to resolve a member's id (for example, to address a direct message) or to enumerate teams.

Quick Start​

# Read workspace metadata
curl -X GET https://api.copera.ai/public/v1/workspace/info \
  -H "Authorization: Bearer cp_pat_YOUR_TOKEN"

# List members (search by name or email with q)
curl -X GET "https://api.copera.ai/public/v1/workspace/members?q=alice" \
  -H "Authorization: Bearer cp_pat_YOUR_TOKEN"

# List teams
curl -X GET https://api.copera.ai/public/v1/workspace/teams \
  -H "Authorization: Bearer cp_pat_YOUR_TOKEN"

Available in​

Public APICLIMCPCopera AI
✅ Full✅ Full✅ Full—

The CLI and the hosted MCP server expose workspace info, members, and teams. The workspace directory is not exposed to the in-app Copera AI assistant.

Workspace info​

GET the info endpoint for the workspace's core metadata: _id, name, slug, optional picture and description, the number of seats, and timestamps.

Members​

GET the members endpoint to list the people in the workspace. Each member includes:

  • _id, name, email, optional picture and title.
  • type — user, guest, integration, ai, or external.
  • status — presence: online, offline, idle, or invisible.
  • active — whether the account is active.

Supported query parameters:

  • q — case-insensitive search over name and email.
  • limit — 1–500 (default 100).
  • offset — page offset (default 0).
tip

This is how you resolve a member's userId before sending a direct message — search by name or email with q, then use the returned _id.

Teams​

GET the teams endpoint to list the workspace's teams. Each team includes its _id, name, optional picture, a main flag (the workspace's default team), the participants (member ids), createdBy, and timestamps. It supports the same q, limit (1–200, default 100), and offset parameters.

Authentication & scope​

Workspace endpoints require a Personal Access Token (cp_pat_). External users cannot access this endpoint. See Authentication.

Reference​