Stripe: List all scheduled query runs

← Sigma operations · Get started

Operation stripe.getsigmascheduledqueryruns

Provider route: GET /v1/sigma/scheduled_query_runs. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["sigma"]["getSigmaScheduledQueryRuns"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.sigma.getSigmaScheduledQueryRuns(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.sigma.get_sigma_scheduled_query_runs(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
query	object	Optional	Additional keys: not allowed
query.ending_before	string	Optional	Maximum length: 5000
query.expand	array	Optional
query.expand[]	string	Each item	Maximum length: 5000
query.limit	integer	Optional
query.starting_after	string	Optional	Maximum length: 5000

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	object	Root
data	array	Required within parent
data[]	Model	Each item	Expand Retrieve a scheduled query run — response body
has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
object	string	Required within parent	String representing the object’s type. Objects of the same type share the same value. Always has the value `list`. Known values: list
url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/sigma/scheduled_query_runs

Referenced models: Retrieve a scheduled query run — response body

Schemas

Retrieve a scheduled query run — response body

Field	Type	Presence	Description and constraints
$	object	Root	If you have [scheduled a Sigma query](https://docs.stripe.com/sigma/scheduled-queries), you'll receive a `sigma.scheduled_query_run.created` webhook each time the query runs. The webhook contains a `ScheduledQueryRun` object, which you can use to retrieve the query results.
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
data_load_time	JSON	Required within parent
data_load_time (anyOf 1)	integer	Alternative	When the query was run, Sigma contained a snapshot of your Stripe data at this time. Format: unix-time
data_load_time (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
error	Model	Optional	Expand Retrieve a scheduled query run — response body — error
file	JSON	Optional
file (anyOf 1)	JSON	Alternative	The file object representing the results of the query.
file (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a file — response body
file (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: scheduled_query_run
result_available_until	JSON	Required within parent
result_available_until (anyOf 1)	integer	Alternative	Time at which the result expires and is no longer available for download. Format: unix-time
result_available_until (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
sql	string	Required within parent	SQL for the query. Maximum length: 100000
status	string	Required within parent	The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise. Maximum length: 5000
title	string	Required within parent	Title of the query. Maximum length: 5000

Referenced models: Create a file — response body, Retrieve a scheduled query run — response body — error

Create a file — response body

Field	Type	Presence	Description and constraints
$	object	Root	This object represents files hosted on Stripe's servers. You can upload files with the [create file](https://docs.stripe.com/api#create_file) request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a [Sigma scheduled query](#scheduled_queries)). Related guide: [File upload guide](https://docs.stripe.com/file-upload)
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at	JSON	Optional
expires_at (anyOf 1)	JSON	Alternative
expires_at (anyOf 1) (anyOf 1)	integer	Alternative	The file expires and isn't available at this time in epoch seconds. Format: unix-time
expires_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at (anyOf 2)	null	Alternative
filename	JSON	Optional
filename (anyOf 1)	string	Alternative	The suitable name for saving the file to a filesystem. Maximum length: 5000
filename (anyOf 2)	null	Alternative
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
links	JSON	Optional
links (anyOf 1)	object	Alternative	A list of [file links](https://docs.stripe.com/api#file_links) that point at this file.
links (anyOf 1).data	array	Required within parent	Details about each object.
links (anyOf 1).data[]	Model	Each item	Expand Create a file link — response body
links (anyOf 1).has_more	boolean	Required within parent	True if this list has another page of items after this one that can be fetched.
links (anyOf 1).object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list
links (anyOf 1).url	string	Required within parent	The URL where this list can be accessed. Maximum length: 5000 Pattern: ^/v1/file_links
links (anyOf 2)	null	Alternative
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: file
purpose	string	Required within parent	The [purpose](https://docs.stripe.com/file-upload#uploading-a-file) of the uploaded file. Known values: account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, document_provider_identity_document, finance_report_run, financial_account_statement, identity_document, identity_document_downloadable, issuing_regulatory_reporting, pci_document, platform_terms_of_service, selfie, sigma_scheduled_query, tax_document_user_upload, terminal_android_apk, terminal_reader_splashscreen, terminal_wifi_certificate, terminal_wifi_private_key
size	JSON	Required within parent
size (anyOf 1)	integer	Alternative	The size of the file object in bytes.
size (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
title	JSON	Optional
title (anyOf 1)	string	Alternative	A suitable title for the document. Maximum length: 5000
title (anyOf 2)	null	Alternative
type	JSON	Optional
type (anyOf 1)	string	Alternative	The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`). Maximum length: 5000
type (anyOf 2)	null	Alternative
url	JSON	Optional
url (anyOf 1)	string	Alternative	Use your live secret API key to download the file from this URL. Maximum length: 5000
url (anyOf 2)	null	Alternative

Referenced models: Create a file link — response body

Retrieve a scheduled query run — response body — error

Field	Type	Presence	Description and constraints
$	object	Root
message	string	Required within parent	Information about the run failure. Maximum length: 5000

Create a file link — response body

Field	Type	Presence	Description and constraints
$	object	Root	To share the contents of a `File` object with non-Stripe users, you can create a `FileLink`. `FileLink`s contain a URL that you can use to retrieve the contents of the file without authentication.
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expired	boolean	Required within parent	Returns if the link is already expired.
expires_at	JSON	Optional
expires_at (anyOf 1)	JSON	Alternative
expires_at (anyOf 1) (anyOf 1)	integer	Alternative	Time that the link expires. Format: unix-time
expires_at (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
expires_at (anyOf 2)	null	Alternative
file	JSON	Required within parent	The file object this link points to.
file (anyOf 1)	string	Alternative	Maximum length: 5000
file (anyOf 2)	Model	Alternative	Expand Create a file — response body
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
metadata	object	Required within parent	Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: file_link
url	JSON	Optional
url (anyOf 1)	string	Alternative	The publicly accessible URL to download the file. Maximum length: 5000
url (anyOf 2)	null	Alternative

Referenced models: Create a file — response body

Policy, approvals and errors

SDK function policy ID: stripe.getsigmascheduledqueryruns. Catalog operation: GetSigmaScheduledQueryRuns. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source