Queries

acquisitionSearchJob

Type: AcquisitionSearchJobPayload

Return progress for an interactive acquisition-search job, or null when no such job exists.

Arguments

Name	Description
id ID!	Acquisition-search job ID to poll.

acquisitionSettings

Type: AcquisitionSettingsPayload!

Returns acquisition thresholds and polling settings for the authenticated actor.

activeImportStreams

Type: [ActiveImportStreamPayload!]!

Return queued and active filesystem import operations. Idle worker capacity is never included.

activeJobRuns

Type: [JobRunPayload!]!

List currently active job runs visible to the caller.

activeLibraryScans

Type: [LibraryScanProgressPayload!]!

List active library scan sessions visible to the caller.

activityEvents

Type: [ActivityEventPayload!]!

List recent activity events with zero-based offset pagination.

Arguments

Name	Description
limit Int	Maximum events to return; defaults to 100.
offset Int	Number of events to skip; defaults to 0.

applicationUpgradeStatus

Type: ApplicationUpgradeStatusPayload!

Return application update availability and installation eligibility; requires system-settings management permission.

auditLog

Type: [DomainEventEnvelopePayload!]!

List audit events visible to the caller, filtered by event type, title, facet, sequence, and limit.

Arguments

Name	Description
eventTypes [DomainEventTypeValue!]	Optional event types to include; omitted includes all visible types.
titleId ID	Include only events for this title ID.
facet MediaFacetValue	Include only events for this media facet.
afterSequence Long	Return events after this exclusive sequence number.
beforeSequence Long	Return events before this exclusive sequence number.
limit Int	Maximum events to return; defaults to 100 and values below 1 become 1.

authRuntimeState

Type: AuthRuntimeStatePayload!

Returns effective authentication and MFA requirements after runtime overrides are applied.

autoBackupSettings

Type: AutoBackupSettingsPayload!

Returns auto-backup scheduling metadata without exposing the backup key.

backups

Type: [BackupInfoPayload!]!

List available backups; requires system-settings management permission.

backupSettings

Type: BackupSettingsPayload!

Returns configured, default, and effective backup paths.

browsePath

Type: [DirectoryEntryPayload!]!

List non-hidden entries under an absolute directory path; requires library-settings read permission.

Arguments

Name	Description
path String!	Absolute directory path to list; defaults to "/".
includeFiles Boolean	Include regular files as well as directories; defaults to false; hidden names are excluded.

calendarEpisodes

Type: [CalendarEpisodePayload!]!

List calendar episodes between two dates, optionally restricted to libraries.

Arguments

Name	Description
startDate Date!	Start date of the calendar range.
endDate Date!	End date of the calendar range.
libraryIds [ID!]	Optional library IDs; omitted, null, or an empty list includes all accessible libraries.

canCreateMyApiKeys

Type: Boolean!

Whether the interactive actor may create API keys under the active security policy.

catalogDiscovery

Type: CatalogDiscoveryPayload!

Return catalog discovery results for the requested target and filters.

Arguments

Name	Description
input CatalogDiscoveryInput!	Catalog target, filters, sorting, and pagination.

changeTitleFolderPreview

Type: ChangeTitleFolderPreviewPayload!

Preview correcting which existing folder a title owns; no files are moved.

Arguments

Name	Description
input ChangeTitleFolderPreviewInput!	Title and candidate folder whose ownership change is described; nothing is changed.

collectionById

Type: CollectionPayload

Fetch a collection by globally unique ID, returning null when it is absent or inaccessible.

Arguments

Name	Description
id ID!	Collection ID to fetch.

cutoffUnmetTitlesPage

Type: CutoffUnmetTitlesPagePayload!

Return one page of cutoff-unmet targets with the full match count and per-item convergence progress.

Arguments

Name	Description
facet MediaFacetValue	Media facet filter, when supplied.
libraryIds [ID!]	Library IDs to include; omitted or empty includes all permitted libraries.
limit Int!	Number of targets to return; negative values become 0.
offset Int!	Number of matching targets to skip; negative values become 0.

dashboardActivityStats

Type: DashboardActivityStatsPayload!

Return grab, upgrade, import, and failure counts for a trailing window and the window before it.

Arguments

Name	Description
windowHours Int!	Length of each window in hours; defaults to 24 and is clamped to 1 through 168.

defaultSeedingProfile

Type: DefaultSeedingProfilePayload!

Returns the seeding profile applied when nothing more specific matches.

delayProfiles

Type: [DelayProfilePayload!]!

Lists delay profiles with minute-based delays and their media-facet assignments.

deleteEpisodeFilesPreview

Type: DeleteEpisodeFilesPreviewPayload!

Preview deleting the media files of the supplied episodes without changing files.

Arguments

Name	Description
input DeleteEpisodeFilesPreviewInput!	Title and episode IDs whose linked media files would be deleted; no files are changed.

deleteExternalSubtitlePreview

Type: DeletePreviewPayload!

Preview deleting one external subtitle file without changing files.

Arguments

Name	Description
externalSubtitleId ID!	External-subtitle ID whose deletion would be previewed.

deleteMediaFilePreview

Type: DeletePreviewPayload!

Preview deleting one media file without changing files.

Arguments

Name	Description
fileId ID!	Media-file ID whose deletion would be previewed.

deleteTitlePreview

Type: DeletePreviewPayload!

Preview deleting all media files for one title without changing files.

Arguments

Name	Description
titleId ID!	Title ID whose associated media files would be deleted.

deleteTitlesPreview

Type: DeleteTitlesPreviewPayload!

Preview deleting media files for the supplied title IDs without changing files.

Arguments

Name	Description
input DeleteTitlesPreviewInput!	Title IDs whose associated media files would be deleted; no files are changed.

discoveryHome

Type: DiscoveryHomePayload!

Return discovery home results using optional facet, filter, and pagination input.

Arguments

Name	Description
input DiscoveryHomeInput	Facet, filters, and pagination; omitted uses service defaults.

discoveryHomeCards

Type: DiscoveryHomeCardsPayload!

Return discovery home cards using optional facet, filter, and pagination input.

Arguments

Name	Description
input DiscoveryHomeInput	Facet, filters, and pagination; omitted uses service defaults.

discoveryHomeFilterOptions

Type: DiscoveryHomeFilterOptionsPayload!

Return discovery home filter options for an optional facet and library scope.

Arguments

Name	Description
input DiscoveryHomeFilterOptionsInput	Facet and library scope for filter options; omitted uses service defaults.

discoveryItemDetail

Type: DiscoveryItemPayload

Fetch one discovery item by identity and scope, returning null when unavailable.

Arguments

Name	Description
input DiscoveryItemDetailInput!	Discovery item identity and scope used for the lookup.

discoveryItems

Type: DiscoveryItemsPayload!

List discovery items using optional filters, sorting, and pagination.

Arguments

Name	Description
input DiscoveryItemsInput	Discovery filters, sorting, and pagination; omitted uses service defaults.

downloadClientConfigs

Type: [DownloadClientConfigPayload!]!

Lists download-client configurations with provider field metadata and redacted secrets.

downloadClientProviderTypes

Type: [ProviderTypePayload!]!

Return available download-client provider types and their configuration fields; requires system-settings permission.

downloadClientRouting

Type: [DownloadClientRoutingEntryPayload!]!

Returns download-client routing entries for a content scope.

Arguments

Name	Description
scope ContentScopeValue!	Content scope whose download-client routing should be returned.

downloadHistory

Type: DownloadHistoryPagePayload!

List a bounded page of download history with optional client, activity, and sort filters.

Arguments

Name	Description
limit Int	Number of history records to return; defaults to 50 and is clamped to 1 through 50.
offset Int	Number of matching history records to skip; defaults to 0 and negative values become 0.
filters [DownloadHistoryFilterValue!]	History activity filters; omitted includes all states and an empty list returns no rows.
clientIds [ID!]	Download-client IDs to include; omitted includes all clients and an empty list returns no rows.
scryerSubmittedOnly Boolean	When true, include only downloads submitted by Scryer; defaults to false.
sortKey DownloadHistorySortKeyValue	History sort key; omitted uses the service default.
sortDirection SortDirectionValue	Sort direction when a sort key is supplied; defaults to Asc.

downloadImport

Type: DownloadImportPagePayload!

List a bounded page of download-import activity; the limit defaults to 50 and is clamped to 1 through 100.

Arguments

Name	Description
limit Int	Number of import records to return; defaults to 50 and is clamped to 1 through 100.
offset Int	Number of matching import records to skip; defaults to 0 and negative values become 0.
filter DownloadImportFilterValue	Import activity filter; defaults to All.

downloadQueue

Type: [DownloadQueueItemPayload!]!

Deprecated: use downloadQueuePage

Deprecated download activity listing without pagination or queue readiness metadata.

Arguments

Name	Description
includeAllActivity Boolean	Include all activity types instead of the default active subset; defaults to false.
includeHistoryOnly Boolean	Include history-only activity; defaults to false.
includeImportActivity Boolean	Include import activity; defaults to false.
titleId ID	Include only activity for this title ID.
activityFilter DownloadActivityFilterValue	Activity state filter; defaults to All.

downloadQueuePage

Type: DownloadQueuePagePayload!

Return a bounded download queue page with readiness, revision, staleness, filters, and stable sorting metadata.

Arguments

Name	Description
limit Int!	Number of queue items to return; defaults to 50 and is clamped to 1 through 200.
offset Int!	Number of matching queue items to skip; defaults to 0 and negative values become 0.
filters [DownloadActivityFilterValue!]	Activity states to include; omitted includes all states and an empty list returns no rows.
clientIds [ID!]	Download-client IDs to include; omitted includes all clients and an empty list returns no rows.
scryerSubmittedOnly Boolean!	When true, include only downloads submitted by Scryer; defaults to true.
titleId ID	Include only queue items for this title ID.
sortKey DownloadQueueSortKeyValue!	Queue sort key; defaults to Status.
sortDirection SortDirectionValue!	Queue sort direction; defaults to Asc.

episode

Type: EpisodePayload

Fetch an episode by ID while verifying that it belongs to the supplied parent title.

Arguments

Name	Description
titleId ID!	Parent title ID used to verify the episode belongs to that title.
episodeId ID!	Episode ID to fetch and verify against title_id.

episodeById

Type: EpisodePayload

Fetch an episode by globally unique ID without requiring a parent title ID.

Arguments

Name	Description
id ID!	Episode ID to fetch.

externalAccountInvites

Type: [LinkedAccountPayload!]!

List external account invitations visible to the caller.

externalAuthRuntimeSettings

Type: ExternalAuthRuntimeSettingsPayload!

Returns effective external-auth providers and connections, hiding login capability when form login is disabled.

externalImportAggregateWarmupProgress

Type: ExternalImportAggregateWarmupProgressPayload!

Aggregate Arr-source warmup progress; an empty list returns completed status with zero totals.

Arguments

Name	Description
input ExternalImportAggregateWarmupProgressInput!	External movie or series source warmup session IDs to aggregate; an empty list returns COMPLETED with zero totals.

externalImportArrSourceWarmupStatus

Type: ExternalImportMonitorWarmupProgressPayload!

Deprecated: use externalImportWarmupStatus

Poll deprecated external movie or series source warmup status for one session.

Arguments

Name	Description
sessionId ID!	External movie or series source warmup session ID to poll.

externalImportSetupSecretDraft

Type: ExternalImportSetupSecretDraftPayload

Read the caller-visible external import setup secret draft; requires system-settings management permission.

externalImportSetupSecretDraftStatus

Type: ExternalImportSetupSecretDraftStatusPayload!

Report whether an external import setup secret draft exists and whether the caller owns it.

externalImportWarmupStatus

Type: ExternalImportMonitorWarmupProgressPayload!

Poll warmup status for one external movie, series, or indexer discovery session.

Arguments

Name	Description
sessionId ID!	Warmup session ID to poll.

externalSubtitleBlocklistEntries

Type: [ExternalSubtitleBlocklistEntryPayload!]!

List external subtitle blocklist entries for one media file ID.

Arguments

Name	Description
mediaFileId ID!	Media-file ID whose subtitle blocklist entries are returned.

externalSubtitles

Type: [ExternalSubtitlePayload!]!

List external subtitles associated with a title ID.

Arguments

Name	Description
titleId ID!	Title ID whose external subtitles are returned.

generalSettings

Type: GeneralSettingsPayload!

Returns system settings, effective image-cache limits, and trusted plugin certificates.

importHistory

Type: [ImportRecordPayload!]!

List recent import records; the limit defaults to 50 and is capped at 500.

Arguments

Name	Description
limit Int	Number of import records to return; defaults to 50 and is clamped to 1 through 500.

indexerDownloadClientMappingCatalog

Type: IndexerDownloadClientMappingCatalogPayload!

Returns compatible download clients and indexers for routing configuration.

indexerError

Type: IndexerErrorDetailPayload

Return one complete persisted indexer HTTP response; requires system-settings management permission.

Arguments

Name	Description
id ID!	Stable persisted error-event identifier.

indexerErrors

Type: IndexerErrorConnectionPayload!

List persisted indexer HTTP errors; requires system-settings management permission.

Arguments

Name	Description
indexerId ID	Restrict results to one configured indexer.
first Int	Requested page size from 1 through 100; defaults to 50.
after String	Opaque cursor returned by a prior indexerErrors page.

indexerProviderTypes

Type: [ProviderTypePayload!]!

Return available indexer provider types and their configuration fields; requires system-settings permission.

indexerRouting

Type: [IndexerRoutingEntryPayload!]!

Returns indexer routing entries for a content scope.

Arguments

Name	Description
scope ContentScopeValue!	Content scope whose indexer routing should be returned.

indexers

Type: [IndexerConfigPayload!]!

Lists indexer configurations and current query statistics, optionally filtered by provider type.

Arguments

Name	Description
providerType String	Optional provider-type filter; omit or pass null to list every indexer.

instanceFeatures

Type: InstanceFeaturesPayload!

Instance-wide feature switches readable by any signed-in user.

interactiveReleaseSearch

Type: InteractiveReleaseSearchPayload

Poll an interactive release-search job; null means no visible snapshot exists.

Arguments

Name	Description
id ID!	Interactive release-search job ID to poll.

jellyfinServerUsers

Type: [JellyfinServerUserPayload!]!

Lists users from the media-server connection identified by connection_id.

Arguments

Name	Description
connectionId ID!	ID of the Jellyfin media-server connection to query.
search String	Optional user-name search; omit or pass null for no text filter.

jobRuns

Type: [JobRunPayload!]!

List recent runs for one job key; the limit defaults to 10 and values below 1 become 1.

Arguments

Name	Description
jobKey JobKeyValue!	Job key whose runs should be listed.
limit Int	Maximum runs to return; defaults to 10 and values below 1 become 1.

jobs

Type: [JobDefinitionPayload!]!

List job definitions visible to the caller.

libraries

Type: [LibraryPayload!]!

List libraries visible to the caller that grant at least the requested permission.

Arguments

Name	Description
facet MediaFacetValue	Restrict results to one media facet; omitted includes all facets.
permission LibraryPermissionValue	Minimum library permission required; defaults to View.

libraryPaths

Type: LibraryPathsPayload!

Returns the configured movie, series, and anime library paths.

libraryScanSession

Type: LibraryScanProgressPayload

Recover an active or completed scan snapshot visible to the caller.

Arguments

Name	Description
sessionId ID!	ID of the active or completed library scan to recover.

librarySettings

Type: LibrarySettingsPayload!

Read settings for a library by ID, subject to the caller’s library-settings permission.

Arguments

Name	Description
libraryId ID!	Library ID whose settings are returned.

linkedAccounts

Type: [LinkedAccountPayload!]!

List linked external accounts visible to the caller, optionally restricted to a user ID.

Arguments

Name	Description
userId ID	User ID filter; omitted lists accounts visible to the caller.

locationOperation

Type: LocationOperationPayload

Read one location operation with its per-title checkpoints.

Arguments

Name	Description
id ID!	Location-operation identity.

locationOperationAssets

Type: LocationOperationAssetListingPayload

Which files one location operation renames and deduplicates, per title.

Activity’s counters say how many; this says which ones, and whether each has happened yet or is still only what the confirmed plan intends (FR-091). It is a separate read from locationOperation because the per-file identities live in the operation’s stored plan, which a progress poll has no reason to load.

Arguments

Name	Description
id ID!	Location-operation identity.

locationOperationPreview

Type: LocationOperationPreviewPayload!

Preview moving selected titles to another library or root; nothing is moved.

The returned fingerprint is what startLocationOperation confirms. A changed filesystem, catalog, selection, destination, or mode produces a different fingerprint and voids the confirmation.

The mode picks which preview runs: the managed move plans the copy, and USER_MOVED_FILES re-points the catalog at a move the user already made themselves. The reported mode can still come back as CATALOG_ONLY when the selection has no files on disk (FR-076).

Arguments

Name	Description
input LocationOperationPreviewInput!	Titles to move, the destination library or root they would move to, and how the files get there.

locationOperationRetrySelection

Type: LocationRetrySelectionPayload

What planning a location operation’s unfinished work again would select: the same destination and mode, and the titles it did not finish.

Read on demand for a stopped operation, since it joins the stored plan with the checkpoints. Null for an unknown operation, one stored without a readable plan, and for the root-scoped operation types, which are planned again from the root rather than from titles.

Arguments

Name	Description
id ID!	Location-operation identity.

locationRootScopePreview

Type: LocationRootScopePreviewPayload!

Preview a Change root (US4 + US5): moving one root’s content to a new path, or folding it into another root of the same library.

FR-020 is one settings action with two destinations, so it is one query with two destinations. Name destinationPath for a new location, or destinationRootId for a root that already exists; a destinationPath that resolves to a configured root of this library is the same request as naming that root, and is planned as a fold either way. Naming both, or neither, is refused.

Root scoped, so there is no selection: every title assigned to the root goes, and the ledger says so rather than offering a way to exclude one (FR-023). The returned fingerprint is what startLocationOperation confirms with its rootScope target.

Arguments

Name	Description
input LocationRootScopePreviewInput!	The root being moved, the destination it moves to, and how the files get there.

locationTransferFiles

Type: LocationTransferSnapshotPayload

One page of up to 50 file rows for one title of a transfer.

Arguments

Name	Description
id ID!	Location-operation identity.
titleId ID!	Identity of the title whose files to page.
offset Int!	Zero-based index of the first file row to return.

locationTransferPage

Type: LocationTransferSnapshotPayload

One page of up to 50 title rows of a transfer, exceptions first.

Arguments

Name	Description
id ID!	Location-operation identity.
offset Int!	Zero-based index of the first title row to return.

locationTransferSummary

Type: LocationTransferSnapshotPayload

Aggregate progress of one transfer with no title rows; poll this for the operation header.

Arguments

Name	Description
id ID!	Location-operation identity.

locationTransferTitleDetail

Type: String

The operator-facing detail behind a title’s exception, or null when it has none.

Arguments

Name	Description
id ID!	Location-operation identity.
titleId ID!	Identity of the title whose detail to read.

maintenanceActionDescriptors

Type: [MaintenanceActionDescriptor!]!

List the static maintenance action catalog the rule builder chooses from.

maintenanceActionRuns

Type: [MaintenanceActionRun!]!

List recorded maintenance action-handler attempts, newest first.

Arguments

Name	Description
ruleSetId ID	Return only attempts for this rule set.
candidateId ID	Return only attempts for this candidate.
limit Int	Maximum rows to return; defaults to fifty.

maintenanceActionStepDescriptors

Type: [MaintenanceActionStepDescriptor!]!

List the backend-owned schema-2 action-sequence catalog. Authoring clients use its parameter and dependency descriptors directly rather than maintaining a parallel effect matrix.

maintenanceCandidates

Type: [MaintenanceCandidate!]!

List lifecycle candidates the maintenance evaluator has recorded; requires catalog-settings management permission.

Two independent things hide rows, and they are not the same thing. A rule in shadow mode is dark by definition, so its candidates are returned only when includeShadow is true. Separately, the instance result-display gate hides everything while it is off.

includeShadow overrides the gate as well as the mode filter, on purpose: an operator deciding whether to arm result display has to be able to see what shadow evaluation actually found first, and reaching this query already requires catalog-settings management.

Arguments

Name	Description
ruleSetId ID	Return candidates of this rule set only.
states [MaintenanceCandidateState!]	Return candidates in these lifecycle states only.
libraryId ID	Return candidates whose subject belongs to this library only.
includeShadow Boolean	Include candidates produced by rules running in shadow mode.
limit Int	Maximum number of candidates to return.

maintenanceEvaluationRuns

Type: [MaintenanceEvaluationRun!]!

List recorded maintenance evaluation runs, newest first.

Runs carry counts and timing rather than subjects, so the result-display gate does not hide them: they are how an operator sees that dark evaluation is working at all.

Arguments

Name	Description
ruleSetId ID	Return runs of this rule set only.
limit Int	Maximum number of runs to return.

maintenanceExclusions

Type: [MaintenanceExclusion!]!

List maintenance exclusions, newest first.

Narrowing by rule returns that rule’s own exclusions together with every global one, because both are what actually stop it acting.

Arguments

Name	Description
ruleSetId ID	Return the exclusions that apply to this rule set.

maintenanceInstanceGates

Type: MaintenanceInstanceGates!

Read the five instance-wide maintenance gates; requires system-settings management permission.

maintenanceRuleRevisions

Type: [MaintenanceRuleRevision!]!

List every stored revision of one maintenance rule set, newest first.

Arguments

Name	Description
ruleSetId ID!	Maintenance rule-set ID whose revisions are returned.

maintenanceRuleSet

Type: MaintenanceRuleSetDetail

Return one maintenance rule set with the revision currently in force, or null when no such rule set exists.

Arguments

Name	Description
id ID!	Maintenance rule-set ID to load.

maintenanceRuleSets

Type: [MaintenanceRuleSet!]!

List maintenance rule sets; requires catalog-settings management permission.

me

Type: UserPayload

Return the authenticated user payload, or null for an anonymous session; restricted enrollment and password-replacement sessions are rejected.

mediaRenamePreview

Type: MediaRenamePlanPayload!

Preview the rename plan for a title or an entire facet without changing files.

Arguments

Name	Description
input MediaRenamePreviewInput!	Title or facet whose rename plan is returned; no files are changed.

mediaRenamePreviewBulk

Type: [MediaRenamePlanPayload!]!

Preview rename plans for several titles of one facet without changing files.

Arguments

Name	Description
input MediaRenamePreviewBulkInput!	Titles whose rename plans are returned, in the order supplied; no files are changed.

mediaRequests

Type: [MediaRequestPayload!]!

List media requests visible to the caller, optionally filtered by facet, libraries, and status.

Arguments

Name	Description
facet MediaFacetValue	Restrict requests to one media facet; omitted includes all facets.
libraryIds [ID!]	Restrict requests to these library IDs; omitted uses all permitted libraries and an empty list returns no rows.
status MediaRequestStatusValue	Restrict requests to one status; omitted includes all statuses.

mediaServerConnections

Type: [MediaServerConnectionPayload!]!

Lists media-server connections, optionally restricted to one provider.

Arguments

Name	Description
provider MediaServerProviderValue	Optional provider filter; omit or pass null to list every connection.

mediaServerUsers

Type: [MediaServerUserGroupPayload!]!

Lists grouped media-server users, optionally filtered by search text.

Arguments

Name	Description
search String	Optional user search; omit or pass null to return all groups.

mediaSettings

Type: MediaSettingsPayload!

Returns media settings for the requested content scope.

Arguments

Name	Description
scope ContentScopeValue!	Content scope whose media settings should be returned.

metadataMovie

Type: MetadataMoviePayload!

Fetch one movie metadata record by a supplied identity and language.

Arguments

Name	Description
input MetadataMovieInput!	Movie identity and optional metadata language, which defaults to eng.

metadataSeries

Type: MetadataSeriesPayload!

Fetch one series metadata record, optionally including its episode list.

Arguments

Name	Description
input MetadataSeriesInput!	TVDB identity, language, and whether episode metadata should be included, defaulting to true.

movieEntity

Type: MovieEntityPayload

Fetch locally cached movie metadata through a visible title relationship.

Arguments

Name	Description
titleId ID!	Title used to authorize access to the movie.
id ID!	Movie entity ID to fetch.

myApiKeys

Type: [ApiKeyPayload!]!

Lists the interactive actor’s API keys without returning their secrets.

myMediaRequests

Type: [MediaRequestPayload!]!

List only the caller’s media requests, optionally filtered by facet, libraries, and status.

Arguments

Name	Description
facet MediaFacetValue	Restrict requests to one media facet; omitted includes all facets.
libraryIds [ID!]	Restrict requests to these library IDs; omitted uses all permitted libraries and an empty list returns no rows.
status MediaRequestStatusValue	Restrict requests to one status; omitted includes all statuses.

myOauthApps

Type: [OauthConnectedAppPayload!]!

Lists OAuth grants authorized by the authenticated actor without client secrets.

myPasskeys

Type: [PasskeySummaryPayload!]!

Lists the authenticated actor’s passkey summaries without credential material.

myTotp

Type: TotpStatusPayload!

Returns TOTP status and recovery-code count without exposing the shared secret or codes.

myUiSettings

Type: UiSettingsPayload!

Returns the current UI settings for the authenticated actor.

navigationBadgeCounts

Type: NavigationBadgeCountsPayload!

Return navigation counts while omitting categories the caller is not authorized to view.

notificationChannels

Type: [NotificationChannelPayload!]!

List notification channels visible to the caller, including provider configuration metadata.

notificationEventTypes

Type: [String!]!

Return notification event types that can be subscribed to; requires system-settings permission.

notificationProviderTypes

Type: [ProviderTypePayload!]!

Return available notification provider types and their configuration fields; requires system-settings permission.

notificationSubscriptions

Type: [NotificationSubscriptionPayload!]!

List notification subscriptions visible to the caller.

notificationTargets

Type: [NotificationTargetPayload!]!

List notification targets visible to the caller.

oauthAuthorizationClient

Type: OauthAuthorizationClientPayload!

Resolves the display name for an OAuth authorization request after validating its callback URL.

Arguments

Name	Description
clientId String!	OAuth client identifier from the authorization request.
redirectUri String!	Redirect URI from the authorization request.
scope String	Requested OAuth scopes, validated and canonicalized before display.

oauthClientRegistrations

Type: [OauthClientRegistrationPayload!]!

Lists managed and administrator-created OAuth applications.

pendingImportBindingPreview

Type: PendingImportBindingPreviewPayload!

Preview the title binding for one pending import without applying it.

Arguments

Name	Description
pendingImportId ID!	Pending-import ID whose title binding is previewed.

pendingImportCounts

Type: PendingImportCountsPayload!

Return pending-import counts visible to the caller.

pendingImports

Type: PendingImportConnectionPayload!

List pending imports by facet, library scope, status, and offset pagination.

Arguments

Name	Description
facet MediaFacetValue!	Media facet whose pending imports are returned.
libraryIds [ID!]	Library IDs to restrict the result; omitted or empty includes all permitted libraries.
status PendingImportStatusValue!	Pending-import status to include.
limit Int!	Maximum items to return; defaults to 50 and is clamped to 0 through 500.
offset Int!	Number of matching items to skip; defaults to 0.

pendingImportTitleSearch

Type: [MetadataSearchItemPayload!]!

Search metadata candidates for one pending import.

Arguments

Name	Description
pendingImportId ID!	Pending-import ID whose title candidates are searched.
query String!	Text used to search metadata candidates.
limit Int!	Maximum candidates to return; defaults to 8.
language String!	Metadata language code; defaults to "eng".
year Int	Release year filter, when supplied.

pendingReleases

Type: PendingReleasesPayload!

List a bounded page of pending releases with optional title, wanted-item, and status filters.

Arguments

Name	Description
filter PendingReleaseFilterInput	Optional title, wanted-item, and release-status filters; omitted applies no filters.
limit Int!	Number of pending releases to return; defaults to 50 and is clamped to 1 through 500.
offset Int!	Number of matching pending releases to skip; defaults to 0 and negative values become 0.

pluginAutoUpdateSettings

Type: PluginAutoUpdateSettingsPayload!

Returns whether the scheduled plugin catalog refresh installs official patch updates automatically.

pluginCatalogStatus

Type: PluginCatalogStatusPayload!

Return plugin catalog readiness and update status visible to the caller.

plugins

Type: [RegistryPluginPayload!]!

List available registry plugins visible to the caller.

postProcessingScriptRuns

Type: [PostProcessingScriptRunPayload!]!

List runs for one post-processing script; the limit defaults to 50 and is clamped to 1 through 500.

Arguments

Name	Description
scriptId ID!	Post-processing script ID whose runs are returned.
limit Int	Maximum runs to return; defaults to 50 and is clamped to 1 through 500.

postProcessingScripts

Type: [PostProcessingScriptPayload!]!

List post-processing scripts visible to the caller.

previewMyRequestDecision

Type: RequestPreflightPayload!

Evaluate a draft request without submitting it; requires request permission on the target library.

Takes the submit mutation’s own input type, deliberately: the pre-flight and the submit share one input, one metadata read, and one evaluation function, which is what makes “identical drafts yield identical decisions” a property of the code rather than a promise.

Arguments

Name	Description
input SubmitMediaRequestInput!	The draft request to evaluate, exactly as it would be submitted.

previewRestoreRecycledItems

Type: RecycleRestorePreviewPayload!

Preview restoring recycled items by ID without changing their files.

Arguments

Name	Description
ids [ID!]!	Recycled-item IDs whose restore destinations are previewed; an empty list returns an empty preview.

proxyConfigs

Type: [ProxyConfigPayload!]!

Lists configured proxy settings.

qualityProfileSettings

Type: QualityProfileSettingsPayload!

Returns quality profiles and the current global and facet selections.

recentJobRuns

Type: [JobRunPayload!]!

List recent job runs; the limit defaults to 50 and values below 1 become 1.

Arguments

Name	Description
limit Int	Maximum runs to return; defaults to 50 and values below 1 become 1.

recycleBinSettings

Type: RecycleBinSettingsPayload!

Returns whether the recycle bin is enabled for the authenticated actor.

recycledItems

Type: RecycledItemsPayload!

List recycled media items in a bounded page, optionally restricted to library IDs.

Arguments

Name	Description
limit Int!	Number of recycled items to return; defaults to 500 and is clamped to 1 through 500.
offset Int!	Number of matching recycled items to skip; defaults to 0 and negative values become 0.
libraryIds [ID!]	Library IDs to include; omitted or empty includes all permitted libraries.

requestRuleDecision

Type: RequestRuleDecision

Read the decision recorded for one media request, or null when it was never evaluated.

Two audiences reach this. A manager of the request’s library sees the whole trace. The requester sees the outcome, the fallback reason, the reasons, and the tags, with votes emptied, which is the same redaction the pre-flight enforces by construction.

Arguments

Name	Description
requestId ID!	Media request whose decision is returned.

requestRuleDecisions

Type: [RequestRuleDecision!]!

List recorded request decisions, newest first; requires catalog-settings management permission.

Arguments

Name	Description
limit Int	Maximum decisions to return; defaults to 50 and is clamped to 1 through 500.
outcome RequestDecisionOutcomeValue	Return only decisions whose effective outcome was this.

requestRuleInputReference

Type: JSON!

The request family’s Rules Context Reference: every fact a request matcher may read.

requestRuleInstanceGates

Type: RequestRuleInstanceGates!

Read the instance-wide request-rule gate; requires system-settings management permission.

requestRuleRevisions

Type: [RequestRuleRevision!]!

List every stored revision of one request rule set, newest first.

Arguments

Name	Description
ruleSetId ID!	Request rule-set ID whose revisions are returned.

requestRuleSet

Type: RequestRuleSetDetail

Return one request rule set with the revision currently in force, or null when no such rule set exists.

Arguments

Name	Description
id ID!	Request rule-set ID to load.

requestRuleSets

Type: [RequestRuleSet!]!

List request rule sets; requires catalog-settings management permission.

rootFolders

Type: [RootFolderPayload!]!

Lists root folders for a media facet.

Arguments

Name	Description
facet MediaFacetValue!	Media facet whose root folders should be returned.

rulePackRegistry

Type: [RulePackRegistryEntryPayload!]!

List community rule packs from the plugin registry.

rulePackTemplates

Type: [RulePackTemplatePayload!]!

Fetch templates from a community rule pack by registry ID.

Arguments

Name	Description
packId String!	Registry ID of the community rule pack.

ruleSet

Type: RuleSetPayload

Return one rule set, including its source, when it is visible to the caller.

Arguments

Name	Description
id ID!	Rule-set identity to load.

ruleSets

Type: [RuleSetPayload!]!

List rule sets visible to the caller.

runtimeInfo

Type: RuntimeInfoPayload!

Return the path style supported by the running service.

scryerVersion

Type: String!

Return the running Scryer version.

searchMetadata

Type: [MetadataSearchItemPayload!]!

Search provider metadata for one facet, returning at most 100 results.

Arguments

Name	Description
query String!	Provider search text.
type MediaFacetValue!	Facet to search, exposed as the GraphQL type argument.
limit Int!	Result count, defaulting to 25 and clamped to the range 1 through 100.
language String!	Metadata language, defaulting to eng.
year Int	Optional release-year hint passed to the provider.

searchMetadataMulti

Type: MetadataSearchMultiPayload!

Search provider metadata across movie, series, and anime facets.

Arguments

Name	Description
query String!	Provider search text.
limit Int!	Result count, defaulting to 25 and clamped to the range 1 through 100.
language String!	Metadata language, defaulting to eng.

searchReleases

Type: [IndexerSearchResultPayload!]!

Search indexers for a title, series movie link, or episode and return at most 200 results.

Arguments

Name	Description
input SearchReleasesInput!	Search target and optional season, episode, and result limit; season and episode must be supplied together.

securitySettings

Type: SecuritySettingsPayload!

Returns saved security settings together with effective and environment-overridden login state.

seedingProfiles

Type: [SeedingProfilePayload!]!

Lists configured torrent seeding profiles.

serviceLogs

Type: ServiceLogsPayload!

Return the most recent buffered service log lines; requires system-settings permission.

Arguments

Name	Description
limit Int!	Maximum log lines; defaults to 250 and is clamped to 1 through 2000.

serviceSettings

Type: ServiceSettingsPayload!

Returns service TLS configuration and related settings.

setupStatus

Type: SetupStatusPayload!

Return whether setup is complete and whether download clients and indexers are configured.

smgScryerUpdateNotice

Type: SmgScryerUpdateNoticePayload

Return an available Scryer update notice from SMG, if one exists.

smgVersionCompatibilityNotice

Type: SmgVersionCompatibilityNoticePayload

Return an SMG compatibility notice when the connected SMG version requires attention.

storageRoots

Type: [StorageRootUsagePayload!]!

List root folders of libraries the caller can view, with the disk usage of each backing filesystem.

subtitleProviderConfigs

Type: [SubtitleProviderConfigPayload!]!

Lists subtitle-provider configurations, optionally filtered by provider type.

Arguments

Name	Description
providerType String	Optional provider-type filter; matching is case-insensitive and null returns all providers.

subtitleProviderTypes

Type: [ProviderTypePayload!]!

Return available subtitle-provider types, host bindings, and recommended facets; requires catalog-settings permission.

subtitleSettings

Type: SubtitleSettingsPayload!

Returns the current subtitle settings available to the authenticated actor.

systemHealth

Type: SystemHealthPayload!

Return system health details visible to the authenticated caller.

title

Type: TitlePayload

Fetch a visible title by ID, returning null when it does not exist or is not accessible.

Arguments

Name	Description
id ID!	Title ID to fetch.

titleAcquisitionDiagnostics

Type: TitleAcquisitionDiagnosticsPayload!

Return acquisition diagnostics for one title ID.

Arguments

Name	Description
titleId ID!	Title ID whose acquisition diagnostics are returned.

titleBySlug

Type: TitlePayload

Fetch a visible title by facet, optional library slug, and title slug.

Arguments

Name	Description
facet MediaFacetValue!	Media facet used to scope the slug lookup.
librarySlug String	Optional library slug used to disambiguate the title.
slug String!	Title slug to look up within the facet and optional library.

titleCatalogFilterOptions

Type: TitleCatalogFilterOptionsPayload!

Return available catalog filter values for the requested facet and library scope.

Arguments

Name	Description
facet MediaFacetValue	Restrict options to one media facet; omitted includes all facets visible to the caller.
libraryIds [ID!]	Restrict options to these library IDs; omitted or empty uses all libraries visible to the caller.
rootFolderIds [ID!]	Restrict options to these root-folder IDs; omitted or empty uses all roots, and blank or duplicate values are ignored.

titleClaims

Type: [TitleClaim!]!

List every lifecycle claim on one title, live and historical; requires title management on the title’s library.

Arguments

Name	Description
titleId ID!	Title whose claims are returned.

titleHistory

Type: TitleHistoryPagePayload!

List title history events with optional identity, event, grouping, and offset filters.

Arguments

Name	Description
filter TitleHistoryFilterInput!	Event, title, library, text, grouping, and pagination filters.

titleReleaseBlocklist

Type: [TitleReleaseBlocklistEntryPayload!]!

List blocklisted releases for one title; the limit defaults to 100 and values below 1 become 1.

Arguments

Name	Description
titleId ID!	Title ID whose blocked releases are returned.
limit Int	Maximum entries to return; defaults to 100 and values below 1 become 1.

titles

Type: TitleCatalogPayload!

List a permission-filtered title catalog page with optional facet, filter, search, sort, and pagination controls.

Arguments

Name	Description
facet MediaFacetValue	Restrict results to one media facet; omitted includes all facets visible to the caller.
libraryIds [ID!]	Restrict results to these library IDs; omitted or empty uses all libraries visible to the caller.
query String	Optional title search text; omitted applies no text filter.
filter TitleCatalogFilterInput	Optional catalog filters for monitoring, content status, roots, tags, year, and rating.
sort TitleCatalogSortInput	Optional sort key and direction; omitted uses the application default.
limit Int	Requested page size; defaults to 300 and is clamped to 1 through 300.
offset Int	Zero-based page offset; defaults to 0 and negative values are treated as 0.

titlesByExternalIds

Type: [TitlePayload!]!

Find visible titles by external IDs from a named metadata source.

Arguments

Name	Description
source String!	Metadata-provider namespace used to interpret the external IDs.
values [String!]!	External ID values to match; an empty list returns no titles.

titleTagDefinitions

Type: [TitleTagDefinitionPayload!]!

Lists every administrator-defined title tag with the number of titles carrying it.

Readable by any authenticated caller: the tag picker and the catalog filter both need the vocabulary, and the vocabulary says nothing about any particular title.

trackedRulePacks

Type: [TrackedRulePackPayload!]!

List tracked community rule packs and their local rule bindings.

users

Type: [UserPayload!]!

Lists users with authorization and authentication-factor status, excluding secret values.

verificationSettings

Type: VerificationSettingsPayload!

Returns the verification depth applied to download-client completed-download copies. Location operations always verify in full and ignore it.

wantedItem

Type: WantedItemPayload

Fetch one wanted item by ID, returning null when it is absent or inaccessible.

Arguments

Name	Description
id ID!	Wanted-item ID to fetch.

wantedItems

Type: WantedItemsListPayload!

Return Missing or Cutoff Upgrade targets with activity state and per-scope convergence progress.

Arguments

Name	Description
wantedKind WantedKindValue!	Wanted target set to list; defaults to Missing.
facet MediaFacetValue	Media facet filter, when supplied.
libraryIds [ID!]	Library IDs to include; omitted or empty includes all permitted libraries.
titleSearch String	Title search text, when supplied.
limit Int!	Number of targets to return; defaults to 50.
offset Int!	Number of matching targets to skip; defaults to 0.