OBJECT

Query

link GraphQL Schema definition

  • type Query {
  • # Statistics query interface
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • queryStatistics(org: Uuid!, query: String!): StatisticsResults!
  • # Arguments
  • # org: Org id for the query
  • # query: User query
  • # first: How many records
  • # after: after cursor
  • # status: status
  • users(org: Uuid!, query: String!, first: Int, after: String, status: String): UserList!
  • # Arguments
  • # org: Org id for the query
  • # query: Dispatch query
  • # first: How many records
  • # after: after cursor
  • # contextUser: Context user
  • dispatches(
  • org: Uuid!,
  • query: String!,
  • first: Int,
  • after: String,
  • contextUser: String
  • ): DispatchList!
  • # Arguments
  • # org: Org id for the query
  • # email: Email to search with (exact)
  • # externalId: External id associated (exact)
  • # mobile: Mobile number (partial match)
  • # name: Name (partial match, last name only)
  • findUserBy(
  • org: Uuid,
  • email: String,
  • externalId: String,
  • mobile: String,
  • name: String
  • ): [UserSearch!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • groups(org: Uuid!, query: String): [Group!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • swimlanes(org: Uuid!, query: String): [Swimlane!]!
  • # Arguments
  • # org: Org id for the query
  • # query: handle:handle | id:uuid | given [id, handles] |
  • # : | classification: | folder:
  • layouts(org: Uuid!, query: String): [Layout!]!
  • # Arguments
  • # org: Org id for the query
  • # query: handle:handle | id:uuid | given [id, handles] |
  • # : | classification: | folder:
  • layoutClassifications(org: Uuid!, query: String): [LayoutClassification!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • # first: How many records
  • # after: after cursor
  • auditLog(org: Uuid!, query: String, first: Int, after: String): AuditRecordList!
  • # Arguments
  • # org: Org id for the query
  • links(org: Uuid!): [LinkA!]!
  • # Arguments
  • # org: Org id for the query
  • # entityList: Security relations to return by kind (swimlane,
  • # channel, invite, layout, wiki, tracker, group, script)
  • linksByType(org: Uuid!, entityList: [String!]!): [LinkA!]!
  • # Arguments
  • # org: Org id for the query
  • # entity: Entity
  • # entityId: Entity id
  • linksByEntity(org: Uuid!, entity: String!, entityId: Uuid!): [LinkA!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • integrations(org: Uuid!, query: String): [Integration!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • trackers(org: Uuid!, query: String): [Tracker!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • channels(org: Uuid!, query: String): [ChannelA!]!
  • # Arguments
  • # org: Org id for the query
  • # channelId: Channel to query
  • # first: Number of records to return
  • # after: Return records after this index
  • channelUsers(org: Uuid!, channelId: Uuid!, first: Int, after: String): ChannelUserList!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • schema(org: Uuid!, query: String): [Schema!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • scripts(org: Uuid!, query: String): [Script!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • pages(org: Uuid!, query: String): [Page!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • notifications(org: Uuid!, query: String): [NotificationA!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • invites(org: Uuid!, query: String): [Invite!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • labels(org: Uuid!, query: String): [Label!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • paymentMethods(org: Uuid!, query: String): [PaymentMethod!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • jobs(org: Uuid!, query: String): [Job!]!
  • # Arguments
  • # org: Org id for the query
  • org(org: Uuid!): OrgA
  • # Arguments
  • # org: Org id for the query
  • orgStats(org: Uuid!): OrgStats
  • # Arguments
  • # org: Org id for the query
  • # entity: [Not documented]
  • # from: [Not documented]
  • # until: [Not documented]
  • # userId: [Not documented]
  • orgDashboard(
  • org: Uuid!,
  • entity: String!,
  • from: LocalDate!,
  • until: LocalDate!,
  • userId: Uuid
  • ): [DataPoint!]!
  • # Arguments
  • # org: Org id for the query
  • orgChildren(org: Uuid!): [OrgA!]!
  • # Arguments
  • # org: Org id for the query
  • # scriptId: Script to query
  • # first: Number of records to return
  • # after: Return records after this index
  • scriptResults(org: Uuid!, scriptId: Uuid, first: Int!, after: String): ScriptResultLogList!
  • # Arguments
  • # org: Org id for the query
  • # groupId: [Not documented]
  • # userId: [Not documented]
  • groupUsers(org: Uuid!, groupId: Uuid, userId: Uuid): [GroupUser!]!
  • # Arguments
  • # org: Org id for the query
  • # labelId: [Not documented]
  • # userId: [Not documented]
  • labelUsers(org: Uuid!, labelId: Uuid, userId: Uuid): [LabelUser!]!
  • # Arguments
  • # org: Org id for the query
  • # id: Option api id to query
  • apiKeys(org: Uuid!, id: Uuid): [ApiKey!]!
  • # Arguments
  • # org: Org id for the query
  • notificationConditions(org: Uuid!): [ConditionA!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • dispatchClusters(org: Uuid!, query: String): [DispatchCluster!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • exports(org: Uuid!, query: String): [Export!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • programKinds(org: Uuid!, query: String): [ProgramKind!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • programs(org: Uuid!, query: String): [Program!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • programQuery(org: Uuid!, query: String): [ProgramInfo!]!
  • # Arguments
  • # org: Org id for the query
  • # query: empty for all or id:, @ for specific
  • programCohortQuery(org: Uuid!, query: String): [ProgramInfo!]!
  • # Arguments
  • # org: Org id for the query
  • # userId: [Not documented]
  • # programId: [Not documented]
  • programParticipants(org: Uuid!, userId: Uuid, programId: Uuid): [ProgramUser!]!
  • # Id from a handle
  • #
  • # Arguments
  • # org: Org id for the query
  • # entity: group|tracker|script|swimlane
  • # handle: [Not documented]
  • idFromHandle(org: Uuid!, entity: String!, handle: String!): EntityQuery
  • # Handle from id
  • #
  • # Arguments
  • # org: Org id for the query
  • # entity: group|tracker|script|swimlane
  • # id: [Not documented]
  • handleFromId(org: Uuid!, entity: String!, id: Uuid!): EntityQuery
  • # Find attachments by id or by entity type
  • #
  • # Arguments
  • # org: Org id for the query
  • # entityId: [Not documented]
  • # entityType: [Not documented]
  • findAttachmentsBy(org: Uuid!, entityId: Uuid, entityType: String): [AttachmentRelation!]!
  • # List program cohorts
  • #
  • # Arguments
  • # org: Org id for the query
  • # programId: [Not documented]
  • programCohorts(org: Uuid!, programId: Uuid!): [ProgramCohort!]!
  • # Query data store
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • dataStoreGet(org: Uuid!, query: String!): DataStoreList!
  • # Query managed channels
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • managedChannels(org: Uuid!, query: String): [ManagedChannel!]!
  • # User devices
  • #
  • # Arguments
  • # org: Org id for the query
  • # userId: [Not documented]
  • userDevices(org: Uuid!, userId: Uuid!): [UserDeviceA!]!
  • # Layout History
  • #
  • # Arguments
  • # org: Org id for the query
  • # layoutId: [Not documented]
  • # first: [Not documented]
  • # after: [Not documented]
  • layoutHistory(org: Uuid!, layoutId: Uuid!, first: Int!, after: String): LayoutHistoryList!
  • # Member events
  • #
  • # Arguments
  • # org: Org id for the query
  • # userId: [Not documented]
  • memberEvents(org: Uuid!, userId: Uuid!): [MemberEvent!]!
  • # List program tickets
  • #
  • # Arguments
  • # org: Org id for the query
  • # userId: [Not documented]
  • # programKindId: [Not documented]
  • # externalId: [Not documented]
  • programTickets(
  • org: Uuid!,
  • userId: Uuid,
  • programKindId: Uuid,
  • externalId: String
  • ): [ProgramTicket!]!
  • # Search program tickets
  • #
  • # Arguments
  • # org: Org id for the query
  • # state: [Not documented]
  • programTicketSearch(org: Uuid!, state: String): [ProgramTicket!]!
  • # Workflow rules
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • rules(org: Uuid!, query: String): [Rule!]!
  • # Resource
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • resources(org: Uuid!, query: String): [Resource!]!
  • # Resource availability
  • #
  • # Arguments
  • # org: Org id for the query
  • # id: [Not documented]
  • resourceAvailability(org: Uuid!, id: Uuid!): [ResourceAvailability!]!
  • # Behavior triggers
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • triggers(org: Uuid!, query: String): [BehaviorTrigger!]!
  • # Active video rooms
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • meetingRooms(org: Uuid!, query: String): [MeetingRoom!]!
  • # Packet query
  • #
  • # Arguments
  • # org: Org id for the query
  • # channel: [Not documented]
  • # first: [Not documented]
  • # after: [Not documented]
  • # status: [Not documented]
  • packets(org: Uuid!, channel: Uuid!, first: Int, after: String, status: String): PacketList!
  • # Query specific packet
  • #
  • # Arguments
  • # org: Org id for the query
  • # packetId: [Not documented]
  • # status: [Not documented]
  • singlePacket(org: Uuid!, packetId: String!, status: String): Packet
  • # Droplet query
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • droplets(org: Uuid!, query: String): [DataDroplet!]!
  • # Droplet entry query
  • #
  • # Arguments
  • # org: Org id for the query
  • # droplet: [Not documented]
  • # query: [Not documented]
  • dropletEntries(org: Uuid!, droplet: Uuid!, query: String): [DataDropletEntry!]!
  • # Schema history
  • #
  • # Arguments
  • # org: Org id for the query
  • # entity: [Not documented]
  • # id: [Not documented]
  • # first: [Not documented]
  • # after: [Not documented]
  • schemaHistory(
  • org: Uuid!,
  • entity: String!,
  • id: Uuid!,
  • first: Int!,
  • after: String
  • ): DataSchemaHistoryList!
  • # Channel query
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • channelQuery(org: Uuid!, query: String!): ChannelInfoList!
  • # Channel query
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • # first: [Not documented]
  • # after: [Not documented]
  • queryClip(org: Uuid!, query: String!, first: Int!, after: String): QueryClipList!
  • # Environment variable query
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • queryEnvironmentVariables(org: Uuid!, query: String): [EnvironmentVariable!]!
  • # Query activity metrics for the org
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • queryActivityMetrics(org: Uuid!, query: String!): ActivityResult!
  • # Query flagged content
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • # first: [Not documented]
  • # after: [Not documented]
  • flaggedContent(org: Uuid!, query: String, first: Int!, after: String): FlaggedContentList!
  • # Query swimlane cohort relationships
  • #
  • # Arguments
  • # org: Org id for the query
  • # cohortId: [Not documented]
  • # swimlaneId: [Not documented]
  • cohortSwimlanes(org: Uuid!, cohortId: Uuid, swimlaneId: Uuid): [SwimlaneCohort!]!
  • # User participation status history query for a specific program
  • #
  • # Arguments
  • # org: Org id for the query
  • # userId: [Not documented]
  • # programId: [Not documented]
  • userParticipationStatusHistory(
  • org: Uuid!,
  • userId: Uuid!,
  • programId: Uuid!
  • ): [ParticipationHistory!]!
  • # Inbox list for a specific user
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • # first: [Not documented]
  • # after: [Not documented]
  • userInboxList(org: Uuid!, query: String!, first: Int!, after: String): InboxEntryList!
  • # List user's payment identities for the org
  • #
  • # Arguments
  • # org: Org id for the query
  • # userId: [Not documented]
  • userPaymentIdentities(org: Uuid!, userId: Uuid!): [UserPaymentIdentity!]!
  • # List user's subscriptions
  • #
  • # Arguments
  • # org: Org id for the query
  • # userId: [Not documented]
  • userPaymentSubscriptions(org: Uuid!, userId: Uuid!): [UserPaymentSubscription!]!
  • # Account list
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • # first: [Not documented]
  • # after: [Not documented]
  • accounts(org: Uuid!, query: String, first: Int!, after: String): AccountList!
  • # Account user list
  • #
  • # Arguments
  • # org: Org id for the query
  • # accountId: [Not documented]
  • # query: [Not documented]
  • # first: [Not documented]
  • # after: [Not documented]
  • accountUsers(
  • org: Uuid!,
  • accountId: Uuid!,
  • query: String,
  • first: Int!,
  • after: String
  • ): AccountUserList!
  • # Program history
  • #
  • # Arguments
  • # org: Org id for the query
  • # id: [Not documented]
  • # first: [Not documented]
  • # after: [Not documented]
  • programEditHistory(org: Uuid!, id: Uuid!, first: Int!, after: String): ProgramKindHistoryList!
  • # Org validations
  • #
  • # Arguments
  • # org: Org id for the query
  • validations(org: Uuid!): [Validation!]!
  • # Query buckets
  • #
  • # Arguments
  • # org: Org id for the query
  • # query: [Not documented]
  • # first: [Not documented]
  • # after: [Not documented]
  • queryBuckets(org: Uuid!, query: String!, first: Int!, after: String): BucketList!
  • # Query document edit history for various entity types
  • #
  • # Arguments
  • # org: Org id for the query
  • # kind: Document kind: script|workflow|org|wiki
  • # query: [Not documented]
  • # first: [Not documented]
  • # after: [Not documented]
  • queryDocumentHistory(
  • org: Uuid!,
  • kind: String!,
  • query: String,
  • first: Int!,
  • after: String
  • ): DocumentHistoryList!
  • # Entity folder query
  • #
  • # Arguments
  • # org: Org id for the query
  • # kind: Entity kind
  • entityFolders(org: Uuid!, kind: String): [EntityFolder!]!
  • }

link Require by

This element is not required by anyone