monday.com workspaces are used by teams to manage their accounts by departments, teams, or projects. They contain boards, dashboards, and folders to help you stay organized.

Queries

Get workspaces

• Required scope: workspaces:read
• Returns an array containing metadata about one or a collection of workspaces
• Can be queried directly at the root or nested within a boards query (returns the workspace ID, only requires the boards:read scope)

query {
  workspaces(ids: 1234567) {
    id
    name
    kind
    description
  }
}

Querying the main workspace

Every account has a main workspace, but you typically can't query its details via the API.

However, users will eventually be able to query main workspace details as we complete a multi-product migration over the next few months. This capability will be released gradually, so you may not have access yet. All users will have this capability by the end of the migration.

Here's the expected behavior for both pre-and post-migration:

Pre-migration

If you query the workspaces on your account, the main workspace will not appear in the results because it has a null or -1 ID. You can, however, filter for boards in the main workspace by passing null as the workspace_id.

query {
  boards (workspace_ids: [null], limit:50) {
    name
  }
}

Post-migration

If you query the workspaces on your account, the main workspace will appear in the results with a real id. You can then use that ID to query the main workspace.

Arguments

Fields

Mutations

• Required scope: workspaces:write

Create workspace

Creates a new workspace. Returns Workspace.

mutation {
  create_workspace(
    name:"New Cool Workspace"
    kind: open
    description: "This is a cool description"
    account_product_id: 505616
	) {
    id
    description
  }
}

Arguments

Update workspace

Updates a workspace. Returns Workspace.

mutation {
  update_workspace(
    id: 1234567
    attributes: {
      account_product_id: 98765
      name:"Marketing team"
      description: "This workspace is for the marketing team." 
    }
	) {
    id
  }
}

Arguments

Add teams to workspace

Adds teams to a workspace. Returns [Team].

mutation {
  add_teams_to_workspace(
    workspace_id: 1234567
    team_ids: [
      12345678
      87654321
      56789012
    ]
	) {
    id
  }
}

Arguments

Add users to workspace

Adds users to a workspace. Returns [User].

mutation {
  add_users_to_workspace(
    workspace_id: 1234567
    user_ids: [
      12345678
      87654321
      56789012
    ]
    kind: subscriber
	) {
    id
  }
}

Arguments

Delete workspace

Deletes a workspace. Returns Workspace.

mutation {
  delete_workspace(workspace_id: 1234567) {
    id
  }
}

Arguments

Delete teams from workspace

Deletes teams from a workspace. Returns [Team].

mutation {
  delete_teams_from_workspace(
    workspace_id: 1234567
    team_ids: [
      12345678
      87654321
      56789012
    ]
	) {
    id
  }
}

Arguments

Delete users from workspace

Deletes users from a workspace. Returns [User].

mutation {
  delete_users_from_workspace(
    workspace_id: 1234567
    user_ids: [
      12345678
      87654321
      56789012
    ]
	) {
    id
  }
}

Arguments