Accounts

Account records and account-level SaaS activity.

Last updated

Queries

account query

Retrieve account data from the Viio GraphQL API.

account(id: ID!): Account

Returns: Account

Arguments for account

NameDescription
id (ID!)

accounts query

Retrieve accounts data from the Viio GraphQL API.

accounts(first: Int, after: String, last: Int, before: String, where: AccountFilterInput, order: [AccountSortInput!]): AccountsConnection

Returns: AccountsConnection

Arguments for accounts

NameDescription
where (AccountFilterInput)
order ([AccountSortInput!])
first (Int)Returns the first n elements from the list.
after (String)Returns elements after the specified cursor.
last (Int)Returns the last n elements from the list.
before (String)Returns elements before the specified cursor.

Objects

Account object

Fields returned by the Account object type.

NameDescription
id (ID!)
integrationKey (String!)
tenant (String)
sourceId (String!)
name (String)
primaryEmail (String)
emailAliases ([String!]!)
type (AccountType!)
status (AccountStatus!)

AccountsConnection object

A connection to a list of items.

NameDescription
pageInfo (PageInfo!)Information to aid in pagination.
edges ([AccountsEdge!])A list of edges.
nodes ([Account!])A flattened list of the nodes.
totalCount (Int!)Identifies the total count of items in the connection.

AccountsEdge object

An edge in a connection.

NameDescription
cursor (String!)A cursor for use in pagination.
node (Account!)The item at the end of the edge.

Input Types

AccountFilterInput input

Input fields accepted by AccountFilterInput.

AccountSortInput input

Input fields accepted by AccountSortInput.

NameDescription
name (SortEnumType)
primaryEmail (SortEnumType)

AccountStatusOperationFilterInput input

Input fields accepted by AccountStatusOperationFilterInput.

AccountTypeOperationFilterInput input

Input fields accepted by AccountTypeOperationFilterInput.

NameDescription
eq (AccountType)
neq (AccountType)
in ([AccountType!])
nin ([AccountType!])

StringOperationFilterInput input

Input fields accepted by StringOperationFilterInput.

NameDescription
and ([StringOperationFilterInput!])
or ([StringOperationFilterInput!])
eq (String)
neq (String)
contains (String)
ncontains (String)
in ([String])
nin ([String])
startsWith (String)
nstartsWith (String)
endsWith (String)
nendsWith (String)

Enums

AccountStatus enum

Accepted values for the AccountStatus enum.

ValueDescription
ACTIVE
SUSPENDED
DELETED

AccountType enum

Accepted values for the AccountType enum.

ValueDescription
MEMBER
GUEST
BOT