Tenant
Last updated
Queries
workspace query
Retrieve workspace data from the Viio GraphQL API.
workspace(): Workspace!
Returns: Workspace!
This operation has no arguments.
workspaceUsers query
Retrieve workspaceUsers data from the Viio GraphQL API.
workspaceUsers(skip: Int, take: Int, search: String): WorkspaceUsersCollectionSegment
Returns: WorkspaceUsersCollectionSegment
Arguments for workspaceUsers
| Name | Description |
|---|---|
skip (Int) | |
take (Int) | |
search (String) |
Mutations
updateWorkspaceName mutation
Run the updateWorkspaceName mutation through the Viio GraphQL API.
updateWorkspaceName(input: UpdateWorkspaceNameInput!): UpdateWorkspaceNamePayload!
Returns: UpdateWorkspaceNamePayload!
Arguments for updateWorkspaceName
| Name | Description |
|---|---|
input (UpdateWorkspaceNameInput!) |
changeCurrency mutation
Run the changeCurrency mutation through the Viio GraphQL API.
changeCurrency(input: ChangeCurrencyInput!): ChangeCurrencyPayload!
Returns: ChangeCurrencyPayload!
Arguments for changeCurrency
| Name | Description |
|---|---|
input (ChangeCurrencyInput!) |
updateWorkspaceDataRetentionSettings mutation
Run the updateWorkspaceDataRetentionSettings mutation through the Viio GraphQL API.
updateWorkspaceDataRetentionSettings(input: UpdateWorkspaceDataRetentionSettingsInput!): UpdateWorkspaceDataRetentionSettingsPayload!
Returns: UpdateWorkspaceDataRetentionSettingsPayload!
Arguments for updateWorkspaceDataRetentionSettings
| Name | Description |
|---|---|
input (UpdateWorkspaceDataRetentionSettingsInput!) |
removeWorkspaceUser mutation
Run the removeWorkspaceUser mutation through the Viio GraphQL API.
removeWorkspaceUser(input: RemoveWorkspaceUserInput!): RemoveWorkspaceUserPayload!
Returns: RemoveWorkspaceUserPayload!
Arguments for removeWorkspaceUser
| Name | Description |
|---|---|
input (RemoveWorkspaceUserInput!) |
Objects
BillingInfo object
Fields returned by the BillingInfo object type.
| Name | Description |
|---|---|
accessUrl (String!) |
ChangeCurrencyPayload object
Fields returned by the ChangeCurrencyPayload object type.
| Name | Description |
|---|---|
workspace (Workspace) | |
errors ([ChangeCurrencyError!]) |
DataRetentionSettings object
Fields returned by the DataRetentionSettings object type.
| Name | Description |
|---|---|
retentionPeriodMonths (Int!) |
FailedToChangeCurrencyError object
Fields returned by the FailedToChangeCurrencyError object type.
| Name | Description |
|---|---|
message (String!) |
FailedToUpdateDataRetentionSettingsError object
Fields returned by the FailedToUpdateDataRetentionSettingsError object type.
| Name | Description |
|---|---|
message (String!) |
FailedToUpdateWorkspaceNameError object
Fields returned by the FailedToUpdateWorkspaceNameError object type.
| Name | Description |
|---|---|
message (String!) |
FinanceDataAccess object
Fields returned by the FinanceDataAccess object type.
| Name | Description |
|---|---|
cost (FinanceDataAccessAttributes!) | |
payment (FinanceDataAccessAttributes!) |
FinanceDataAccessAttributes object
Fields returned by the FinanceDataAccessAttributes object type.
| Name | Description |
|---|---|
enabled (Boolean!) |
ForbiddenToRemoveOrganizationOwnerError object
Fields returned by the ForbiddenToRemoveOrganizationOwnerError object type.
| Name | Description |
|---|---|
message (String!) |
Logo object
Fields returned by the Logo object type.
| Name | Description |
|---|---|
url (URL!) |
NotSupportedCurrencyCodeError object
Fields returned by the NotSupportedCurrencyCodeError object type.
| Name | Description |
|---|---|
message (String!) |
RemoveWorkspaceUserPayload object
Fields returned by the RemoveWorkspaceUserPayload object type.
| Name | Description |
|---|---|
user (WorkspaceUser) | |
errors ([RemoveWorkspaceUserError!]) |
UpdateWorkspaceDataRetentionSettingsPayload object
Fields returned by the UpdateWorkspaceDataRetentionSettingsPayload object type.
| Name | Description |
|---|---|
workspace (Workspace) | |
errors ([UpdateWorkspaceDataRetentionSettingsError!]) |
UpdateWorkspaceNamePayload object
Fields returned by the UpdateWorkspaceNamePayload object type.
| Name | Description |
|---|---|
workspace (Workspace) | |
errors ([UpdateWorkspaceNameError!]) |
User object
Fields returned by the User object type.
| Name | Description |
|---|---|
id (ID!) | |
email (String!) | |
firstName (String!) | |
lastName (String) | |
role (String!) |
UserProfile object
Fields returned by the UserProfile object type.
| Name | Description |
|---|---|
id (ID!) | |
email (String!) | |
name (String!) | |
roles ([String!]!) | |
features ([String!]!) | |
intercomUserHash (String!) | |
status (String!) | |
customer (Workspace!) | |
workspace (Workspace!) |
Workspace object
Fields returned by the Workspace object type.
| Name | Description |
|---|---|
id (ID!) | |
name (String!) | |
primaryDomain (String!) | |
currency (String!) | |
companyLogo (Logo) | |
attributes ([WorkspaceAttribute!]!) | |
dataRetentionSettings (DataRetentionSettings!) | |
domain (String!) | |
billing (BillingInfo) | |
subscription (WorkspaceSubscription!) | |
dataAccess (WorkspaceDataAvailability!) | |
dataAvailability (WorkspaceDataAvailability!) | |
features ([String!]!) | |
isRestrictedAccess (Boolean!) |
WorkspaceAttribute object
Fields returned by the WorkspaceAttribute object type.
| Name | Description |
|---|---|
key (String!) | |
value (String!) |
WorkspaceDataAvailability object
Fields returned by the WorkspaceDataAvailability object type.
| Name | Description |
|---|---|
finance (FinanceDataAccess) | |
ad (AdIntegrationDataAccess) |
WorkspaceSubscription object
Subscription of the workspace.
| Name | Description |
|---|---|
kind (WorkspaceSubscriptionKind!) | Kind of the subscription. |
planId (String!) | Purchased plan, e.g. paid-12-eur or enterprise_bill_12. |
WorkspaceUser object
Fields returned by the WorkspaceUser object type.
| Name | Description |
|---|---|
id (String!) | |
email (String!) | |
fullName (String!) | |
legacyUserId (String) | |
role (String!) |
WorkspaceUserNotFoundError object
Fields returned by the WorkspaceUserNotFoundError object type.
| Name | Description |
|---|---|
message (String!) |
WorkspaceUsersCollectionSegment object
A segment of a collection.
| Name | Description |
|---|---|
pageInfo (CollectionSegmentInfo!) | Information to aid in pagination. |
items ([WorkspaceUser!]) | A flattened list of the items. |
totalCount (Int!) |
Input Types
ChangeCurrencyInput input
Input fields accepted by ChangeCurrencyInput.
| Name | Description |
|---|---|
currency (String!) |
RemoveWorkspaceUserInput input
Input fields accepted by RemoveWorkspaceUserInput.
| Name | Description |
|---|---|
userId (String!) |
UpdateWorkspaceDataRetentionSettingsInput input
Input fields accepted by UpdateWorkspaceDataRetentionSettingsInput.
| Name | Description |
|---|---|
retentionPeriodMonths (Int!) |
UpdateWorkspaceNameInput input
Input fields accepted by UpdateWorkspaceNameInput.
| Name | Description |
|---|---|
name (String!) |
Unions
ChangeCurrencyError union
Possible object types returned by the ChangeCurrencyError union.
Possible types: FailedToChangeCurrencyError, NotSupportedCurrencyCodeError
RemoveWorkspaceUserError union
Possible object types returned by the RemoveWorkspaceUserError union.
Possible types: WorkspaceUserNotFoundError, ForbiddenToRemoveOrganizationOwnerError
UpdateWorkspaceDataRetentionSettingsError union
Possible object types returned by the UpdateWorkspaceDataRetentionSettingsError union.
Possible types: FailedToUpdateDataRetentionSettingsError
UpdateWorkspaceNameError union
Possible object types returned by the UpdateWorkspaceNameError union.
Possible types: FailedToUpdateWorkspaceNameError
Enums
WorkspaceSubscriptionKind enum
Kind of a workspace subscription.
| Value | Description |
|---|---|
FREE | Free subscription. |
PAID | Paid subscription. |
TRIAL | Trial subscription. |
POC | Proof-of-concept subscription. |
SANDBOX | Sandbox subscription. |