workspace

QUERY

workspace(workspaceId: ID!): Workspace

Arguments

workspaceId

ID!

required

Returns

Workspace

ID!

name

String!

The internal name of the workspace, used within Plain and not shown to customers.

publicName

String!

The public-facing display name of the workspace shown to customers and in external communications.

isDemoWorkspace

Boolean!

Whether this workspace is a demo workspace created for evaluation purposes.

domainName

String

deprecated

Use domainNames instead

domainNames

[String!]!

The list of email domain names associated with this workspace, used to automatically associate customers with the workspace.

createdBy

createdAt

updatedBy

updatedAt

workspaceEmailSettings

WorkspaceEmailSettings!

workspaceChatSettings

WorkspaceChatSettings!

logo

WorkspaceFile

workOSOrganizationId

String

The WorkOS organization ID used for SSO and directory sync, if configured.

workOSHubOrganizationId

String

The WorkOS Hub organization ID, if this workspace is part of a hub organization.

Query

query Workspace($workspaceId: ID!) {
  workspace(workspaceId: $workspaceId) {
    id
    name
    publicName
    isDemoWorkspace
    domainName
    domainNames
  }
}

Variables

{
  "workspaceId": "id"
}

Response

{
  "data": {
    "workspace": {
      "id": "id",
      "name": "string",
      "publicName": "string",
      "isDemoWorkspace": true,
      "domainName": "string",
      "domainNames": [
        "string"
      ]
    }
  }
}

⌘I

Query

query Workspace($workspaceId: ID!) {
  workspace(workspaceId: $workspaceId) {
    id
    name
    publicName
    isDemoWorkspace
    domainName
    domainNames
  }
}

Variables

{
  "workspaceId": "id"
}

Response

{
  "data": {
    "workspace": {
      "id": "id",
      "name": "string",
      "publicName": "string",
      "isDemoWorkspace": true,
      "domainName": "string",
      "domainNames": [
        "string"
      ]
    }
  }
}

Queries

Mutations

Types

Arguments

Returns