OBJECT
Query

GraphQL Schema definition

type Query {
#   Check user status
# 
# Arguments
#   email: Email address
#   brand: Brand if not default
checkStatus(email: String!, brand: String): UserStatus! 
#   Check session status
checkSession: Result! 
#   Check session status
checkSessionRequired: Result! 
#   Load public layout
# 
# Arguments
#   id: The id of the specific entity
loadPublicLayout(id: Uuid!): Layout 
#   Get a list of users
# 
# Arguments
#   org: The id of the org to query
#   query: Query used to search for dispatches
#   ## Basic form ##
#   (entity list) (state options) filter? (optional filter list)
#   Entity list: (current|all|listed) (users|groups)
#   State options can be:
#   status=(all|active|retired), kind=(person|place|thing)
#   Filter list: (name|email|phone|uid) (contains|starts|ends|is) 
#   ## Examples ##
#   all users
#   listed groups filter name contains 'harry', email ends '.com'
#   all users status=retired filter name is 'test'
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
#   status: One of: active, retired, deleted, all, archived, draft; 
#   default is active.
#   users: List of user ids to scope the results with.
#   groups: List of group ids; specify 'listed groups' in query
users(
org: Uuid!,
query: String!,
first: Int,
after: String,
status: String,
users: [Uuid!],
groups: [Uuid!]
): UserList! 
#   Get a list of users
# 
# Arguments
#   org: The id of the org to query
#   query: Query used to search for dispatches
#   ## Basic form ##
#   (entity list) (state options) filter? (optional filter list)
#   Entity list: (current|all|listed) (users|groups)
#   State options can be:
#   status=(all|active|retired), kind=(person|place|thing)
#   Filter list: (name|email|phone|uid) (contains|starts|ends|is) 
#   ## Examples ##
#   all users
#   listed groups filter name contains 'harry', email ends '.com'
#   all users status=retired filter name is 'test'
usersCount(org: Uuid!, query: String!): CountResult 
#   Orgs linked for the logged in user
# 
# Arguments
#   id: The id of the specific entity
orgs(id: Uuid): [Org!]! 
#   Groups of an org for the logged in user
# 
# Arguments
#   org: The id of the org to query
groups(org: Uuid!): [Group!]! 
#   Chat channels of an org for the logged in user
# 
# Arguments
#   org: The id of the org to query
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
channels(org: Uuid!, first: Int, after: String): ChannelList! 
#   Chat channel query
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
channelQuery(org: Uuid!, query: String!): ChannelInfoList! 
#   Get single chat channel
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
getChannel(org: Uuid!, id: Uuid!): Channel 
#   Direct channel settings
# 
# Arguments
#   org: The id of the org to query
channelSettings(org: Uuid!): [ChannelSetting!]! 
#   Channel status query for own channels
# 
# Arguments
#   org: The id of the org to query
#   channel: The id of the channel to query
channelStatus(org: Uuid!, channel: Uuid!): ChannelUser 
#   Unread counts for a specific org
# 
# Arguments
#   org: The id of the org to query
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
channelsUnreadOrg(org: Uuid!, first: Int, after: String): ChannelUnreadList! 
#   Unread counts everywhere
# 
# Arguments
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
channelsUnreadAll(first: Int, after: String): ChannelStatsList! 
#   Unread counts everywhere
# 
# Arguments
#   org: The id of the org to query
#   channel: The id of the channel to query
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
channelUsers(org: Uuid!, channel: Uuid!, first: Int, after: String): ChannelUserList! 
#   Packet messages from channel id
# 
# Arguments
#   channel: The id of the channel to query
#   parentId: Parent id of the packet stream
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
#   status: One of: active, retired, deleted, all, archived, draft; 
#   default is active.
packets(
channel: Uuid!,
parentId: String,
first: Int,
after: String,
status: String
): PacketList! 
#   Load packet with ids
# 
# Arguments
#   ids: Id list
packetFromIds(ids: [String!]!): [Packet!]! 
#   Packet messages from query
# 
# Arguments
#   query: [Not documented]
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
#   status: One of: active, retired, deleted, all, archived, draft; 
#   default is active.
packetQuery(query: String!, first: Int, after: String, status: String): PacketList! 
#   Packet actions from packet id
# 
# Arguments
#   id: The id of the specific entity
#   event: Event to query
#   forUser: For user
packetActions(id: String!, event: String, forUser: Uuid): [PacketAction!]! 
#   Packet action summary from packet id
# 
# Arguments
#   id: The id of the specific entity
#   event: Event to query
packetActionSummary(id: String!, event: String!): [PacketActionSummary!]! 
#   Packet info
# 
# Arguments
#   channel: The id of the channel to query
#   parentId: Parent id of the packet stream
packetInfoQuery(channel: Uuid!, parentId: String): PacketInfo 
#   Tokens for logged in user
tokens: [Token!]! 
#   Devices for logged in user
devices: [UserDeviceInfo!]! 
#   Layouts of an org for logged in user
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
layouts(org: Uuid!, query: String!): [Layout!]! 
#   Access control list for objects
# 
# Arguments
#   org: The id of the org to query
#   entity: Entity
links(org: Uuid!, entity: String): [Link!]! 
#   Swimlanes of an org for the logged in user
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
swimlanes(org: Uuid!, query: String): [Swimlane!]! 
#   Swimlanes of an org for the logged in user
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
swimlanesForPost(org: Uuid!, query: String): [Swimlane!]! 
# Arguments
#   org: The id of the org to query
groupsStatus(org: Uuid!): Latest 
#   Group users by group
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
groupUsers(org: Uuid!, id: String!): [GroupUser!]! 
#   Dispatch query
# 
# Arguments
#   org: The id of the org to query
#   query: Query used to search for dispatches
#   ## Basic form ##
#   (entity list) from (date range) :OR: select (entity list)
#   Entity list: (all|listed|no) (users|trackers|swimlanes)
#   Also supported "current user" and "all"
#   ## Valid date ranges ##
#   (date) to (date)
#   (date) to +|- (number) (day, week, month, year)
#   (date) as (number)? (date spans)
#   (date) +|- (number) as (date spans)
#   Dates can provided as 2017-01-01, 01 Jan 2017, 2017-Jan-01, 2017-Jan, today.
#   When using the 'as (date span)' syntax the date range will be aligned to the 
#   span.
#   ## Examples ##
#   all users, all swimlanes, all trackers from today as month
#   listed users, no trackers from today +2 as week
#   current user from today to -4 weeks
#   all
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
#   users: DEPRECATED
dispatches(
org: Uuid!,
query: String!,
first: Int,
after: String,
users: [Uuid!]
): DispatchList! 
#   Dispatch edit history
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
dispatchHistory(org: Uuid!, id: String!): [DispatchHistory!]! 
#   Dispatch key information
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
dispatchKeys(org: Uuid!, id: String!): [DispatchKeyResult!]! 
#   Dispatch query
# 
# Arguments
#   org: The id of the org to query
#   query: Query used to search for dispatches
#   ## Basic form ##
#   (entity list) from (date range) :OR: select (entity list)
#   Entity list: (all|listed|no) (users|trackers|swimlanes)
#   Also supported "current user" and "all"
#   ## Valid date ranges ##
#   (date) to (date)
#   (date) to +|- (number) (day, week, month, year)
#   (date) as (number)? (date spans)
#   (date) +|- (number) as (date spans)
#   Dates can provided as 2017-01-01, 01 Jan 2017, 2017-Jan-01, 2017-Jan, today.
#   When using the 'as (date span)' syntax the date range will be aligned to the 
#   span.
#   ## Examples ##
#   all users, all swimlanes, all trackers from today as month
#   listed users, no trackers from today +2 as week
#   current user from today to -4 weeks
#   all
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
#   users: DEPRECATED
dispatchesCount(
org: Uuid!,
query: String!,
first: Int,
after: String,
users: [Uuid!]
): CountResult 
#   Dispatch action status
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
#   events: Event list to query
#   groupBy: Group results
dispatchActionStatus(
org: Uuid!,
id: String!,
events: [String!]!,
groupBy: String
): [DispatchActionStatus!]! 
#   Dispatch action list
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
#   query: [Not documented]
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
dispatchActionQuery(
org: Uuid!,
id: String!,
query: String!,
after: String
): DispatchActionList! 
#   Tracker query
# 
# Arguments
#   org: The id of the org to query
#   filter: Either 'all' for all trackers or 'create' for trackers 
#   user can create with.
#   query: [Not documented]
trackers(org: Uuid!, filter: String, query: String): [Tracker!]! 
#   Page query
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
#   parentId: Parent id
#   handle: The handle of the specific entity
#   parentHandle: The handle of the specific entity
pages(org: Uuid!, id: Uuid, parentId: Uuid, handle: String, parentHandle: String): [Page!]! 
#   Load public wiki page
# 
# Arguments
#   id: The id of the specific entity
loadPublicPage(id: Uuid!): Page 
#   Page search
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
searchPages(org: Uuid!, query: String!, first: Int, after: String): PageList! 
#   Labels for user
# 
# Arguments
#   org: The id of the org to query
#   userId: User id
labels(org: Uuid!, userId: Uuid!): [Label!]! 
#   Data store query
# 
# Arguments
#   org: The id of the org to query
#   query: Data store query
#   ## Basic form ##
#   (entity list) (JsonPath)
#   Entity list: (current|all|listed) (users|groups)
#   Json path is optional; follows http://goessner.net/articles/JsonPath/
#   Examples: $.store.book or $.store['book','bicycle']
#   ## Examples ##
#   current user
#   all users $.store.book
#   users: List of user ids to scope the results with.
#   groups: List of group ids; specify 'listed groups' in query
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
dataStore(
org: Uuid!,
query: String!,
users: [Uuid!],
groups: [Uuid!],
first: Int,
after: String
): DataStoreList! 
#   Current user profile
# 
# Arguments
#   org: The id of the org to query (optional)
profile(org: Uuid): UserU 
#   Attachment details
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
attachment(org: Uuid!, id: String!): Attachment 
#   Schema query
# 
# Arguments
#   org: The id of the org to query
#   schema: The schema
dataSchema(org: Uuid!, schema: String): [Schema!]! 
#   Load user settings
# 
# Arguments
#   org: The id of the org to query
#   setting: [Not documented]
#   kind: user | org | user-org | org-system
querySettings(org: Uuid!, setting: String, kind: String!): [Setting!]! 
#   Obtain exchange rate
# 
# Arguments
#   org: The id of the org to query
#   ccyFrom: [Not documented]
#   ccyTo: [Not documented]
#   amount: [Not documented]
retrieveExchangeRate(
org: Uuid!,
ccyFrom: String!,
ccyTo: String!,
amount: BigDecimal!
): ExchangeResponse! 
#   Obtain destination price
# 
# Arguments
#   org: The id of the org to query
#   destinationAddress: [Not documented]
#   originAddress: [Not documented]
retrieveVoipPrice(
org: Uuid!,
destinationAddress: String!,
originAddress: String
): VoipPrice! 
#   Check join code
# 
# Arguments
#   code: [Not documented]
checkJoinCode(code: String!): Invite 
#   Check join code (no session)
# 
# Arguments
#   code: [Not documented]
validateJoinCode(code: String!): Invite 
#   Obtain billing details
# 
# Arguments
#   org: The id of the org to query
paymentsRetrieveCustomer(org: Uuid!): StripeCustomer 
#   Find user by id
# 
# Arguments
#   idList: Id list
findUserById(idList: [Uuid!]!): [UserSearch!]! 
#   Find account by id
# 
# Arguments
#   org: The id of the org to query
#   idList: Id list
findAccountById(org: Uuid!, idList: [Uuid!]!): [AccountSearch!]! 
#   Find account by user id
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
findAccountByUser(org: Uuid!, id: String): [AccountSearch!]! 
#   Program history for the current user
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
programs(org: Uuid!, query: String!): [Program!]! 
#   Program history for another user
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
programsForUser(org: Uuid!, id: Uuid!): [ProgramInfo!]! 
#   Get program kind
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
programKind(org: Uuid!, query: String!): [ProgramKind!]! 
#   User programs
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
getAvailablePrograms(org: Uuid!, id: Uuid!): [ProgramInfo!]! 
#   Attachments by entity id
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
findAttachmentByEntity(org: Uuid!, id: Uuid!): [AttachmentRelation!]! 
#   Groups by user id
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
groupsByUserId(org: Uuid!, id: Uuid!): [Group!]! 
#   Dispatch clusters
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
dispatchClusters(org: Uuid!, query: String): [DispatchCluster!]! 
#   Statistics information
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
queryStatistics(org: Uuid!, query: String!): StatisticsResults! 
#   Last update times for the org
# 
# Arguments
#   org: The id of the org to query
#   scope: dispatch
orgStatus(org: Uuid!, scope: String!): OrgStatusResult! 
#   Relations for a given user
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
userRelations(org: Uuid!, id: Uuid!): [UserRelation!]! 
#   Groups for a valid related user
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
relatedUserGroups(org: Uuid!, id: Uuid!): [Group!]! 
#   Orgs for a valid related user
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
relatedUserOrgs(org: Uuid!, id: Uuid!): [OrgInfo!]! 
#   User details for a related user
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
relatedUserDetails(org: Uuid!, id: Uuid!): UserU 
#   Dispatch labels allowed for current user
# 
# Arguments
#   org: The id of the org to query
userDispatchLabels(org: Uuid!): [Label!]! 
#   User labels allowed for current user
# 
# Arguments
#   org: The id of the org to query
userLabels(org: Uuid!): [Label!]! 
#   Managed channels for current user
# 
# Arguments
#   org: The id of the org to query
managedChannels(org: Uuid!): [ManagedChannelInstance!]! 
#   Managed channels for current user
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
searchManagedChannels(org: Uuid!, query: String!): [Channel!]! 
#   Programs eligible for current user
# 
# Arguments
#   org: The id of the org to query
eligiblePrograms(org: Uuid!): [ProgramKind!]! 
#   Ad hoc program participant query (deprecated)
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
programQuery(
org: Uuid!,
query: String!,
first: Int,
after: String
): ProgramParticipationList! @deprecated( reason: "Use participantQuery instead"  )
#   Ad hoc program participant query
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
#   scope: User scope for the query
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
participantQuery(
org: Uuid!,
query: String!,
scope: Uuid,
first: Int,
after: String
): ProgramParticipationList! 
#   Ad hoc program participant with stats query
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
participantStatQuery(org: Uuid!, query: String!): [ProgramParticipationStats!]! 
#   Ad hoc program query
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
programsQuery(org: Uuid!, query: String!): [ProgramInfo!]! 
#   Ad hoc program count query
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
programCountQuery(org: Uuid!, query: String!): CountResult 
#   User in progress programs strictly defined
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
userInProgress(org: Uuid!, id: Uuid!): [ProgramProgress!]! 
#   Program tickets for current user
# 
# Arguments
#   org: The id of the org to query
programTickets(org: Uuid!): [ProgramTicket!]! 
#   Inbox for current user
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
queryInbox(org: Uuid!, query: String!, first: Int, after: String): InboxEntryList! 
#   Inbox for current user
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
readInbox(org: Uuid!, query: String!): [InboxEntry!]! 
#   Count for inbox
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
readInboxCount(org: Uuid!, query: String!): CountResult 
#   Resource availability
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
resourceAvailability(org: Uuid!, query: String!): [ResourceAvailability!]! 
#   Open and connect to meeting room
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
enterMeetingRoom(org: Uuid!, id: Uuid!): RoomToken! 
#   Load meeting room status
# 
# Arguments
#   org: The id of the org to query
#   entityId: Entity id
#   entityKind: Entity kind
loadEntityMeetingRoom(
org: Uuid!,
entityId: String!,
entityKind: String!
): MeetingRoom 
#   Load meeting room status
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
loadMeetingRoom(org: Uuid!, id: Uuid!): MeetingRoom 
#   Data droplet list
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
dataDroplet(org: Uuid!, query: String!, first: Int, after: String): DropletEntryList! 
#   Request image from image service
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
#   variant: [Not documented]
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
imageService(
org: Uuid!,
query: String!,
variant: String!,
first: Int,
after: String
): PhotoResultList! 
#   Retrieve triggers for a user
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
queryUserTriggers(org: Uuid!, id: Uuid): [BehaviorTrigger!]! 
#   List user's payment identities for the org
# 
# Arguments
#   org: The id of the org to query
#   kind: Optional kind
#   status: One of: active, retired, deleted, all, archived, draft; 
#   default is active.
listPaymentIdentities(org: Uuid!, kind: String, status: String): [UserPaymentIdentity!]! 
#   List user's payment methods for the org
# 
# Arguments
#   org: The id of the org to query
#   paymentProvider: Payment provider: Stripe | Paypal
listPaymentMethods(org: Uuid!, paymentProvider: String): [UserPaymentMethod!]! 
#   List user's subscriptions
# 
# Arguments
#   org: The id of the org to query
#   paymentProvider: Payment provider: Stripe | Paypal
listPaymentSubscriptions(
org: Uuid!,
paymentProvider: String
): [UserPaymentSubscription!]! 
#   Query interface for QueryClips
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
#   first: Query limit; default is 100
#   after: Cursor value for paging; start with empty and it will be 
#   returned by the server
queryClips(org: Uuid!, query: String!, first: Int, after: String): QueryClipList! 
#   Query interface for user exports
# 
# Arguments
#   org: The id of the org to query
#   query: [Not documented]
exports(org: Uuid!, query: String): [Export!]! 
#   Payment address information
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
#   handle: The handle of the specific entity
listPaymentAddress(org: Uuid!, id: Uuid, handle: String): [PaymentAddress!]! 
#   Read status for direct channel
# 
# Arguments
#   userId: User id
readDirectChannelStatus(userId: Uuid!): ChannelUserStatus 
#   Read short URL
# 
# Arguments
#   shortUrl: Short URL
readShortUrl(shortUrl: String!): ShortUrl 
#   Load channel setting
# 
# Arguments
#   channel: The id of the channel to query
loadChannelSetting(channel: Uuid!): ChannelUserSetting 
#   Check integration status
# 
# Arguments
#   org: The id of the org to query
#   service: Service name
checkIntegrationStatus(org: Uuid!, service: String!): IntegrationStatus 
#   List dispatch buckets
# 
# Arguments
#   org: The id of the org to query
#   entityId: Entity id
#   entityKind: Entity kind
listDispatchBuckets(
org: Uuid!,
entityId: String!,
entityKind: String!
): [Bucket!]! 
#   List parent buckets
# 
# Arguments
#   org: The id of the org to query
#   id: The id of the specific entity
listDispatchBucketMemberships(
org: Uuid!,
id: String!
): [Bucket!]! 
#   List parent buckets
# 
# Arguments
#   org: The id of the org to query
#   m: Bucket entity
listBucketEntities(org: Uuid!, m: BucketEntitySearch!): [BucketEntity!]! 
}
Require by

This element is not required by anyone
Query

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
