Account

Query identity and workspace access through the WebPixie GraphQL API.

myUser

The authenticated identity behind the current request. No arguments.

query {
  myUser {
    email
    name
    role
  }
}

Response: a MyUser:

FieldTypeDescription
emailString!The user's email address.
nameString!The user's display name.
languageLanguage!The user's preferred language — EN or TR.
role[UserRole!]!System-level roles held by the user.
permission[UserPermissions!]!System-level permissions held by the user.
payload[KeyValue!]Additional key/value metadata attached to the user.
createTime / updateTimeString! / StringISO 8601 timestamps for creation / last update.

mySites

A lightweight list of your sites — no pagination or filtering, unlike findSite. No arguments.

query {
  mySites {
    id
    domain
    isFavorite
  }
}

Response: [MySite!]!:

FieldTypeDescription
idID!Unique identifier for the site.
domainString!The monitored domain.
rootDomainString!The registrable root domain.
faviconStringURL of the site's captured favicon.
isFavoriteBoolean!Whether the site is marked as a favorite.

myWorkspaces

Workspaces the current identity has access to, with your role in each. No arguments.

query {
  myWorkspaces {
    id
    name
    role
  }
}

Response: [AuthorizedWorkspace!]!:

FieldTypeDescription
idID!Unique identifier for the workspace.
nameString!The workspace's display name.
role[WorkspaceUserRole!]!Your role(s) in this workspace.
subscriptionSubscription!The workspace's current subscription.
notificationWorkspaceNotificationConfig!Workspace-wide kill switch for incident notifications — { all: Boolean! }. Must be enabled, alongside the site's or monitor's own setting, for notifications to send.

On this page