Workspaces

Manage workspace members, roles, and settings through the API.

Endpoints

List workspaces available to the API key

Scope

profile:read

Response

{
  "workspaces": [
    {
      "id": "org_abc123",
      "slug": "acme",
      "name": "Acme",
      "role": "admin",
      "joinedAt": 1712534400000
    }
  ]
}

List members of a workspace

Scope

members:read

Parameters

slugstringrequiredWorkspace slug (URL path)

qstringSearch by name or email (alias: search)

limitnumberNumber of members (max 50, default 10)

Response

{
  "members": [
    {
      "id": "usr_abc123",
      "name": "Jane Smith",
      "email": "jane@example.com",
      "username": "janesmith",
      "image": "/api/media/uploads/avatar.jpg",
      "role": "admin"
    }
  ]
}

List members of a project within a workspace

Scope

members:read

Parameters

slugstringrequiredWorkspace slug (URL path)

projectIdstringrequiredProject ID (URL path)

qstringSearch by name or email (alias: search)

limitnumberNumber of members (max 50, default 10)

Response

{
  "members": [
    {
      "id": "usr_abc123",
      "name": "Jane Smith",
      "email": "jane@example.com",
      "username": "janesmith",
      "image": "/api/media/uploads/avatar.jpg",
      "role": "member"
    }
  ]
}

About Workspaces

Workspaces are the top-level container in Project Feed. Each API key is scoped to a single workspace. Workspace-scoped keys only see their bound workspace from GET /api/v1/workspaces; account keys with profile:read can list workspaces available to the authenticated user. The workspace slug is used in the URL path to identify the workspace for member-related endpoints.

Members can have one of four roles: viewer, member, admin, or owner. The role determines which API operations the member can perform.