---
title: "GET /v2/background-scripts/"
method: GET
path: "/v2/background-scripts/"
tags: ["blueprints_Background Scripts API"]
---

# GET /v2/background-scripts/

`GET /v2/background-scripts/`

Retrieve all background scripts for the tenant

## Query parameters

- `ordering` string
- `name` string
- `always_run` boolean
- `limit` integer
- `offset` integer

## Response `200`

Success

- object
  - `content` object
    - `count` integer — The total number of background scripts
    - `next` string, nullable — The link to retrieve the next set of objects in the result set
    - `previous` string, nullable — The link to retrieve the previous set of objects in the result set
    - `results` BlueprintsBackgroundScriptRead[]
      - `id` string, uuid, required — Unique identifier for the background script
      - `name` string, required — Name of the background script
      - `interpreter` string, required — Interpreter used to run the script
      - `always_run` boolean, required — Whether the script runs continuously
      - `frequency_in_mins` integer, nullable — Interval in minutes between script executions
      - `timeout_in_mins` integer, required — Maximum runtime in minutes before the script is terminated.
      - `description` string — Description of the background script. Empty string if not set.
      - `created_at` string, date-time, required — When the background script was created
      - `updated_at` string, date-time, required — When the background script was last updated
      - `created_by` integer, required — User ID who created the background script
      - `updated_by` integer, required — User ID who last updated the background script
  - `message` string
  - `code` integer

---

[API](https://skmtc.net/esper/apis/esper-api-reference.md) · [All operations](https://skmtc.net/esper/apis/esper-api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/esper/esper-api-reference/versions/e1f64cbb488e/schema)