Homepage

RootQuery

Last edit: Oct 10, 2023

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)

admin_api_call_notifications (ApiCallNotificationCollection)

admin_assets (AssetCollection)

admin_assets_listing (AssetsListing)

Returns an asset listing for the instance.

admin_authorization_policies (AuthorizationPolicyCollection)

admin_background_jobs (BackgroundJobCollection)

Maximum 10

  • per_page (Int)

Maximum 100

Deprecated

admin_email_notifications (EmailNotificationCollection)

admin_form_configurations (FormConfigurationCollection)

admin_forms (FormCollection)

admin_graphql (GraphQueryCollection)

admin_liquid_layouts (LiquidLayoutCollection)

admin_liquid_partials (LiquidPartialCollection)

admin_model_schemas (ModelSchemaCollection)

admin_pages (PageCollection)

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

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

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

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

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

admin_search_index_rc (HashObject)

Get mapping for specified index

Index name

admin_sent_notifications (SentNotificationCollection)

admin_sms_notifications (SmsNotificationCollection)

admin_tables (TableCollection)

admin_third_party_integrations (ThirdPartyIntegrationCollection)

admin_transactable_schemas (TransactableSchemaCollection)

admin_user_profile_schemas (UserProfileSchemaCollection)

admin_versions (VersionCollection)

cms_discovery (CMSItemDefinitionCollection)

cms_items (CMSItemPayloadCollection)

constant (EncryptedConstant)

constants (EncryptedConstantCollection)

current_user (User)

custom_attribute_definition (CustomAttributeDefinition)

customization (Customization)

customizations (ListingsCustomizationCollection)

deprecated: use model_schema

Name of the Model Schema

Array of names of the Model Schema

Fulltext search

Array of ids to exclude from results

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

data_exports (DataExportCollection)

Exported data packages

documents_rc (IndexSearchCollection)

Search documents with fulltext search query or filter by arguments.

Fulltext search

Index name

embeddings_rc (EmbeddingCollection)

Returns collection of all Embeddings in the system.

feeds (ActivityStreamsFeed)

handlers (ActivityStreamsHandlerCollection)

images (CustomImageCollection)

instance (Instance)

listings (ListingCollection)

Geo search Deprecetad

Fulltext search

login_providers (String)

model (Customization)

models (ModelCollection)

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

pages (PageCollection)

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

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

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

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

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

people (UserListingCollection)

Geo search

Fulltext search

records (RecordCollection)

Returns collection of all Records in the system.

remote_records (RecordCollection)

Returns collection of remote Records.

Endpoint that will return resources for given ids in json format

remote_users (UserCollection)

Endpoint that will return resources for given ids in json format

request (HTTPRequestContext)

streams (ActivityStreamsActivityStreamCollection)

Deprecated use feed_id

transactable (Transactable)

Slug of the transactable

transactable_type (TransactableType)

Name of Transactable Type

transactable_types (TransactableType)

  • ids (ID)

List of ids

List of names

transactables (TransactableCollection)

user (User)

Finds non deleted users based on arguments provided

users (UserCollection)

Questions?

We are always happy to help with any questions you may have.

contact us