Skip to content

Developers · GraphQL

GraphQL Admin Queries

Last updated 11 November 2026

Admin GraphQL queries read how your instance is set up: its assets, pages, notifications, tables and other admin resources. They do not change anything. Send them to your instance's /api/graph endpoint with an admin key. Each entry below shows the query, its arguments and the type it returns.

For example, this query lists the first five assets on your instance, with each file's path and size:

query {
  admin_assets(per_page: 5) {
    results {
      physical_file_path
      file_size
    }
  }
}

admin_api_call_notifications

Code example:

admin_api_call_notifications(
  filter: ApiCallNotificationsFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [ApiCallNotificationsSortInput!]
): ApiCallNotificationCollection!

Arguments

Type

admin_assets

Code example:

admin_assets(
  filter: QueryAssetsFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [AssetsSortInput!]
): AssetCollection!

Arguments

Type

admin_assets_listing

Returns an asset listing for the instance.

admin_assets_listing(
  id: ID!
): AssetsListing!

Arguments

Type

admin_authorization_policies

Code example:

admin_authorization_policies(
  filter: AuthorizationPoliciesFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [AuthorizationPoliciesSortInput!]
): AuthorizationPolicyCollection!

Arguments

Type

admin_background_jobs

Code example:

admin_background_jobs(
  filter: BackgroundJobsFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [BackgroundJobsSortInput!]
): BackgroundJobCollection!

Arguments

Maximum 50.

Maximum 100.

Type

admin_current_instance

Code example:

admin_current_instance: Instance!

Type

admin_email_notifications

Code example:

admin_email_notifications(
  filter: EmailNotificationsFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [EmailNotificationsSortInput!]
): EmailNotificationCollection!

Arguments

Type

admin_graphql

Code example:

admin_graphql(
  filter: GraphqlFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [GraphqlSortInput!]
): GraphQueryCollection!

Arguments

Type

admin_instance_metrics

Code example:

admin_instance_metrics: InstanceMetrics!

Type

admin_liquid_layouts

Code example;

admin_liquid_layouts(
  filter: LiquidLayoutsFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [LiquidLayoutsSortInput!]
): LiquidLayoutCollection!

Arguments

Type

admin_liquid_partials

Code example:

admin_liquid_partials(
  filter: LiquidPartialsFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [LiquidPartialsSortInput!]
): LiquidPartialCollection!

Arguments

Type

admin_pages

Code example:

admin_pages(
  filter: PageFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [PagesSortInput!]
): PageCollection!

Arguments

Type

admin_sent_notifications

Code example:

admin_sent_notifications(
  filter: SentNotificationsFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [SentNotificationsSortInput!]
): SentNotificationCollection!

Arguments

Type

admin_sms_notifications

Code example:

admin_sms_notifications(
  filter: SmsNotificationsFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [SmsNotificationsSortInput!]
): SmsNotificationCollection!

Arguments

Type

admin_tables

Code example:

admin_tables(
  filter: TablesFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [TablesSortInput!]
): TableCollection!

Arguments

Type

admin_third_party_integrations

Code example:

admin_third_party_integrations(
  filter: ThirdPartyIntegrationsFilterInput
  page: Int = 1
  per_page: Int = 20
  sort: [ThirdPartyIntegrationsSortInput!]
): ThirdPartyIntegrationCollection!

Arguments

Type

admin_user_schema

Code example:

admin_user_schema: UserSchema!

Type

admin_versions

Code example:

admin_versions(
  filter: VersionFilterInput
  options: QueryOptionsInput
  page: Int = 1
  per_page: Int = 20
  sort: [VersionSortInput!]
): VersionCollection!

Arguments

Optional. Set to run the query on a read replica when one exists. sets the database timeout in seconds. The default is 19.

Type

Reference

You may visit the following resources for more information: