RootQuery

Root query for schema

type RootQuery {
  activities(
    ids: [ID]
    page: Int = 1
    per_page: Int = 20
    sort: [ActivitiesSortInput!]
    uuids: [String]
  ): ActivityStreamsActivityCollection
  admin_api_call_notifications(
    filter: ApiCallNotificationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [ApiCallNotificationsSortInput!]
  ): ApiCallNotificationCollection!
  admin_assets(
    filter: QueryAssetsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [AssetsSortInput!]
  ): AssetCollection!
  admin_assets_listing(id: ID!): AssetsListing!
  admin_authorization_policies(
    filter: AuthorizationPoliciesFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [AuthorizationPoliciesSortInput!]
  ): AuthorizationPolicyCollection!
  admin_background_jobs(
    filter: BackgroundJobsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [BackgroundJobsSortInput!]
  ): BackgroundJobCollection!
  admin_email_notifications(
    filter: EmailNotificationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [EmailNotificationsSortInput!]
  ): EmailNotificationCollection!
  admin_form_configurations(
    filter: FormConfigurationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [FormConfigurationsSortInput!]
  ): FormConfigurationCollection!
  admin_forms(
    filter: FormsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [FormsSortInput!]
  ): FormCollection!
  admin_graphql(
    filter: GraphqlFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [GraphqlSortInput!]
  ): GraphQueryCollection!
  admin_liquid_layouts(
    filter: LiquidLayoutsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [LiquidLayoutsSortInput!]
  ): LiquidLayoutCollection!
  admin_liquid_partials(
    filter: LiquidPartialsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [LiquidPartialsSortInput!]
  ): LiquidPartialCollection!
  admin_model_schemas(
    filter: ModelSchemasFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [ModelSchemasSortInput!]
  ): ModelSchemaCollection!
  admin_pages(
    exclude: Boolean
    filter: PageFilterInput
    has_key: String
    metadata: String
    name: String
    page: Int = 1
    per_page: Int = 20
    sort: [PagesSortInput!]
    value: String
  ): PageCollection!
  admin_search_index_rc(search_index: String!): HashObject
  admin_sent_notifications(
    filter: SentNotificationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [SentNotificationsSortInput!]
  ): SentNotificationCollection!
  admin_sms_notifications(
    filter: SmsNotificationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [SmsNotificationsSortInput!]
  ): SmsNotificationCollection!
  admin_tables(
    filter: TablesFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [TablesSortInput!]
  ): TableCollection!
  admin_third_party_integrations(
    filter: ThirdPartyIntegrationsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [ThirdPartyIntegrationsSortInput!]
  ): ThirdPartyIntegrationCollection!
  admin_transactable_schemas(
    filter: TransactableSchemasFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [TransactableSchemasSortInput!]
  ): TransactableSchemaCollection!
  admin_user_profile_schemas(
    filter: UserProfileSchemasFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [UserProfileSchemasSortInput!]
  ): UserProfileSchemaCollection!
  admin_versions(
    filter: VersionFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [VersionSortInput!]
  ): VersionCollection!
  cms_discovery(types: [CMSItemType]): CMSItemDefinitionCollection
  cms_items(
    page: Int = 1
    per_page: Int
    type: CMSItemType!
  ): CMSItemPayloadCollection
  constant(filter: EncryptedConstantFilterInput): EncryptedConstant
  constants(
    filter: EncryptedConstantsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [EncryptedConstantsSortInput!]
  ): EncryptedConstantCollection!
  current_user: User
  custom_attribute_definition(name: String!): CustomAttributeDefinition
  customization(id: ID, name: String): Customization
  customizations(
    aggregations: [ListingAggregation]
    created_at: DateRange
    custom_model_type: QueryCustomModelType
    customizable_id: ID
    customizable_ids: [ID]
    customizable_type: String
    external_id: ID
    external_ids: [ID]
    id: ID
    ids: [ID]
    is_deleted: Boolean
    model_schema: QueryModelSchema
    name: String
    names: [String]
    page: Int = 1
    per_page: Int = 20
    properties: [QueryCustomAttribute]
    query: Query
    sort: [SortOrder]
    updated_at: DateRange
    user_id: ID
    user_ids: [ID]
    without_ids: [ID]
    without_names: [String]
  ): ListingsCustomizationCollection!
  data_exports(
    filter: DataExportsFilterInput
    page: Int = 1
    per_page: Int = 20
    sort: [DataExportsSortInput!]
  ): DataExportCollection!
  documents_rc(
    aggregations: [ListingAggregation]
    filter: [IndexSearchFilterInput!]
    page: Int = 1
    per_page: Int!
    query: IndexSearchQuery
    search_index: String!
    sort: [IndexSearchSortInput!]
  ): IndexSearchCollection!
  embeddings_rc(
    filter: EmbeddingsFilterInput
    page: Int = 1
    per_page: Int!
    sort: [EmbeddingsSortInput!]
  ): EmbeddingCollection!
  feeds: [ActivityStreamsFeed]
  handlers(page: Int = 1, per_page: Int = 20): ActivityStreamsHandlerCollection
  images(
    filter: ImagesFilterInput
    page: Int = 1
    per_page: Int!
    sort: [ImagesSortInput!]
  ): CustomImageCollection!
  instance: Instance
  listings(
    aggregations: [ListingAggregation]
    geo_query: GeoQuery
    listing: QueryListing
    page: Int = 1
    per_page: Int = 20
    query: Query
    sort: [SortOrder]
  ): ListingCollection!
  login_providers: [String]
  model(id: ID, name: String): Customization
  models(
    filter: ModelsFilterInput
    page: Int = 1
    per_page: Int!
    sort: [ModelsSortInput!]
  ): ModelCollection!
  pages(
    exclude: Boolean
    filter: PageFilterInput
    has_key: String
    metadata: String
    name: String
    page: Int = 1
    per_page: Int = 20
    sort: [PagesSortInput!]
    value: String
  ): PageCollection!
  people(
    aggregations: [ListingAggregation]
    geo_query: GeoQuery
    page: Int = 1
    per_page: Int = 20
    query: Query
    sort: [SortOrder]
    user: QueryUser
  ): UserListingCollection!
  records(
    filter: RecordsFilterInput
    page: Int = 1
    per_page: Int!
    sort: [RecordsSortInput!]
  ): RecordCollection!
  remote_records(
    endpoint: Endpoint!
    filter: RecordsFilterInput
    page: Int = 1
    per_page: Int!
    sort: [RecordsSortInput!]
  ): RecordCollection!
  remote_users(
    endpoint: Endpoint!
    filter: UsersFilterInput
    page: Int = 1
    per_page: Int!
    sort: [UsersSortInput!]
  ): UserCollection!
  request: HTTPRequestContext
  streams(
    feed_id: ID
    feed_name: String
    feed_type: String!
    page: Int = 1
    per_page: Int = 20
    reset_last_read: Boolean = true
  ): ActivityStreamsActivityStreamCollection
  transactable(creator_id: ID, id: ID, slug: String): Transactable!
  transactable_type(id: ID, name: String): TransactableType
  transactable_types(ids: [ID], names: [String]): [TransactableType]
  transactables(page: Int = 1, per_page: Int = 20): TransactableCollection!
  user(
    email: String
    external_id: String
    id: ID
    is_deleted: Boolean
    slug: String
  ): User
  users(
    filter: UsersFilterInput
    page: Int = 1
    per_page: Int!
    sort: [UsersSortInput!]
  ): UserCollection!
}

Fields

activities (ActivityStreamsActivityCollection)

• ids (ID)

• page (Int)

• per_page (Int)

• sort (ActivitiesSortInput)

• uuids (String)

admin_api_call_notifications (ApiCallNotificationCollection)

• filter (ApiCallNotificationsFilterInput)

• page (Int)

• per_page (Int)

• sort (ApiCallNotificationsSortInput)

admin_assets (AssetCollection)

• filter (QueryAssetsFilterInput)

• page (Int)

• per_page (Int)

• sort (AssetsSortInput)

admin_assets_listing (AssetsListing)

Returns an asset listing for the instance.

• id (ID)

admin_authorization_policies (AuthorizationPolicyCollection)

• filter (AuthorizationPoliciesFilterInput)

• page (Int)

• per_page (Int)

• sort (AuthorizationPoliciesSortInput)

admin_background_jobs (BackgroundJobCollection)

• filter (BackgroundJobsFilterInput)

• page (Int)

Maximum 50

• per_page (Int)

Maximum 100

• sort (BackgroundJobsSortInput)

admin_email_notifications (EmailNotificationCollection)

• filter (EmailNotificationsFilterInput)

• page (Int)

• per_page (Int)

• sort (EmailNotificationsSortInput)

admin_form_configurations (FormConfigurationCollection)

• filter (FormConfigurationsFilterInput)

• page (Int)

• per_page (Int)

• sort (FormConfigurationsSortInput)

admin_forms (FormCollection)

• filter (FormsFilterInput)

• page (Int)

• per_page (Int)

• sort (FormsSortInput)

admin_graphql (GraphQueryCollection)

• filter (GraphqlFilterInput)

• page (Int)

• per_page (Int)

• sort (GraphqlSortInput)

admin_liquid_layouts (LiquidLayoutCollection)

• filter (LiquidLayoutsFilterInput)

• page (Int)

• per_page (Int)

• sort (LiquidLayoutsSortInput)

admin_liquid_partials (LiquidPartialCollection)

• filter (LiquidPartialsFilterInput)

• page (Int)

• per_page (Int)

• sort (LiquidPartialsSortInput)

admin_model_schemas (ModelSchemaCollection)

• filter (ModelSchemasFilterInput)

• page (Int)

• per_page (Int)

• sort (ModelSchemasSortInput)

admin_pages (PageCollection)

• exclude (Boolean)

deprecated use filter: { metadata: { exclude: $exclude }}

• filter (PageFilterInput)

• has_key (String)

deprecated use filter: { metadata: { has_key: $key }}

• metadata (String)

deprecated use filter: { metadata: { contains: $text }}

• name (String)

deprecated use filter: { metadata: { attribute: { key: $name, value: $value }}}

• page (Int)

• per_page (Int)

• sort (PagesSortInput)

• value (String)

deprecated use filter: { metadata: { attribute: { key: $key, value: $value }}}

admin_search_index_rc (HashObject)

Get mapping for specified index

• search_index (String)

Index name

admin_sent_notifications (SentNotificationCollection)

• filter (SentNotificationsFilterInput)

• page (Int)

• per_page (Int)

• sort (SentNotificationsSortInput)

admin_sms_notifications (SmsNotificationCollection)

• filter (SmsNotificationsFilterInput)

• page (Int)

• per_page (Int)

• sort (SmsNotificationsSortInput)

admin_tables (TableCollection)

• filter (TablesFilterInput)

• page (Int)

• per_page (Int)

• sort (TablesSortInput)

admin_third_party_integrations (ThirdPartyIntegrationCollection)

• filter (ThirdPartyIntegrationsFilterInput)

• page (Int)

• per_page (Int)

• sort (ThirdPartyIntegrationsSortInput)

admin_transactable_schemas (TransactableSchemaCollection)

• filter (TransactableSchemasFilterInput)

• page (Int)

• per_page (Int)

• sort (TransactableSchemasSortInput)

admin_user_profile_schemas (UserProfileSchemaCollection)

• filter (UserProfileSchemasFilterInput)

• page (Int)

• per_page (Int)

• sort (UserProfileSchemasSortInput)

admin_versions (VersionCollection)

• filter (VersionFilterInput)

• page (Int)

• per_page (Int)

• sort (VersionSortInput)

cms_discovery (CMSItemDefinitionCollection)

• types (CMSItemType)

cms_items (CMSItemPayloadCollection)

• page (Int)

• per_page (Int)

• type (CMSItemType)

constant (EncryptedConstant)

• filter (EncryptedConstantFilterInput)

constants (EncryptedConstantCollection)

• filter (EncryptedConstantsFilterInput)

• page (Int)

• per_page (Int)

• sort (EncryptedConstantsSortInput)

current_user (User)

custom_attribute_definition (CustomAttributeDefinition)

• name (String)

customization (Customization)

• id (ID)

• name (String)

customizations (ListingsCustomizationCollection)

• aggregations (ListingAggregation)

• created_at (DateRange)

• custom_model_type (QueryCustomModelType)

deprecated: use model_schema

• customizable_id (ID)

• customizable_ids (ID)

• customizable_type (String)

• external_id (ID)

• external_ids (ID)

• id (ID)

• ids (ID)

• is_deleted (Boolean)

• model_schema (QueryModelSchema)

• name (String)

Name of the Model Schema

• names (String)

Array of names of the Model Schema

• page (Int)

• per_page (Int)

• properties (QueryCustomAttribute)

• query (Query)

Fulltext search

• sort (SortOrder)

• updated_at (DateRange)

• user_id (ID)

• user_ids (ID)

• without_ids (ID)

Array of ids to exclude from results

• without_names (String)

Array of names of the Model Schema which will be excluded from results

data_exports (DataExportCollection)

Exported data packages

• filter (DataExportsFilterInput)

• page (Int)

• per_page (Int)

• sort (DataExportsSortInput)

documents_rc (IndexSearchCollection)

Search documents with fulltext search query or filter by arguments.

• aggregations (ListingAggregation)

• filter (IndexSearchFilterInput)

• page (Int)

• per_page (Int)

• query (IndexSearchQuery)

Fulltext search

• search_index (String)

Index name

• sort (IndexSearchSortInput)

embeddings_rc (EmbeddingCollection)

Returns collection of all Embeddings in the system.

• filter (EmbeddingsFilterInput)

• page (Int)

• per_page (Int)

• sort (EmbeddingsSortInput)

feeds (ActivityStreamsFeed)

handlers (ActivityStreamsHandlerCollection)

• page (Int)

• per_page (Int)

images (CustomImageCollection)

• filter (ImagesFilterInput)

• page (Int)

• per_page (Int)

• sort (ImagesSortInput)

instance (Instance)

listings (ListingCollection)

• aggregations (ListingAggregation)

• geo_query (GeoQuery)

Geo search Deprecetad

• listing (QueryListing)

• page (Int)

• per_page (Int)

• query (Query)

Fulltext search

• sort (SortOrder)

login_providers (String)

model (Customization)

• id (ID)

• name (String)

models (ModelCollection)

Returns collection of all Models in the system, including soft deleted items.

• filter (ModelsFilterInput)

• page (Int)

• per_page (Int)

• sort (ModelsSortInput)

pages (PageCollection)

• exclude (Boolean)

deprecated use filter: { metadata: { exclude: $exclude }}

• filter (PageFilterInput)

• has_key (String)

deprecated use filter: { metadata: { has_key: $key }}

• metadata (String)

deprecated use filter: { metadata: { contains: $text }}

• name (String)

deprecated use filter: { metadata: { attribute: { key: $name, value: $value }}}

• page (Int)

• per_page (Int)

• sort (PagesSortInput)

• value (String)

deprecated use filter: { metadata: { attribute: { key: $key, value: $value }}}

people (UserListingCollection)

• aggregations (ListingAggregation)

• geo_query (GeoQuery)

Geo search

• page (Int)

• per_page (Int)

• query (Query)

Fulltext search

• sort (SortOrder)

• user (QueryUser)

records (RecordCollection)

Returns collection of all Records in the system.

• filter (RecordsFilterInput)

• page (Int)

• per_page (Int)

• sort (RecordsSortInput)

remote_records (RecordCollection)

Returns collection of remote Records.

• endpoint (Endpoint)

Endpoint that will return resources for given ids in json format

• filter (RecordsFilterInput)

• page (Int)

• per_page (Int)

• sort (RecordsSortInput)

remote_users (UserCollection)

• endpoint (Endpoint)

Endpoint that will return resources for given ids in json format

• filter (UsersFilterInput)

• page (Int)

• per_page (Int)

• sort (UsersSortInput)

request (HTTPRequestContext)

streams (ActivityStreamsActivityStreamCollection)

• feed_id (ID)

• feed_name (String)

Deprecated use feed_id

• feed_type (String)

• page (Int)

• per_page (Int)

• reset_last_read (Boolean)

transactable (Transactable)

• creator_id (ID)

• id (ID)

• slug (String)

Slug of the transactable

transactable_type (TransactableType)

• id (ID)

• name (String)

Name of Transactable Type

transactable_types (TransactableType)

• ids (ID)

List of ids

• names (String)

List of names

transactables (TransactableCollection)

• page (Int)

• per_page (Int)

user (User)

Finds non deleted users based on arguments provided

• email (String)

• external_id (String)

• id (ID)

• is_deleted (Boolean)

• slug (String)

users (UserCollection)

• filter (UsersFilterInput)

• page (Int)

• per_page (Int)

• sort (UsersSortInput)