query Workspace($workspaceId: ID!) {
workspace(workspaceId: $workspaceId) {
id
name
publicName
isDemoWorkspace
domainName
domainNames
}
}{
"workspaceId": "id"
}{
"data": {
"workspace": {
"id": "id",
"name": "string",
"publicName": "string",
"isDemoWorkspace": true,
"domainName": "string",
"domainNames": [
"string"
]
}
}
}workspace
Fetch a workspace by its ID. Returns null if the workspace does not exist or the caller does not have access to it.
workspace(workspaceId: ID!): WorkspaceArguments
Returns
The internal name of the workspace, used within Plain and not shown to customers.
The public-facing display name of the workspace shown to customers and in external communications.
Whether this workspace is a demo workspace created for evaluation purposes.
The list of email domain names associated with this workspace, used to automatically associate customers with the workspace.
The per-workspace WorkOS organization used for membership and org switching, if configured.
The shared WorkOS hub organization that holds SSO, directory sync, and domain policy, if this workspace is hub-linked.
True when this workspace or its hub has an active SSO connection.
True when this workspace or its hub has a directory (SCIM) configured. When true, members must be invited and have their roles changed in the identity provider.
query Workspace($workspaceId: ID!) {
workspace(workspaceId: $workspaceId) {
id
name
publicName
isDemoWorkspace
domainName
domainNames
}
}{
"workspaceId": "id"
}{
"data": {
"workspace": {
"id": "id",
"name": "string",
"publicName": "string",
"isDemoWorkspace": true,
"domainName": "string",
"domainNames": [
"string"
]
}
}
}Was this page helpful?