---
title: "List Scripts"
method: GET
path: "/api/v1/scripts"
tags: ["Scripts"]
---

# List Scripts

`GET /api/v1/scripts`

Retrieves a paginated list of scripts. Can be filtered by `name` and `versions.id`.

## Query parameters

- `filter[name]` string
- `filter[versions.id]` string
- `include` string
- `sort` string
- `fields[versions]` string
- `page` integer
- `per_page` integer

## Response `200`

Successful response

- ScriptsListResponse
  - `data` Scripts[]
    - `id` integer — Unique identifier
    - `script_template_id` integer
    - `name` string
    - `description` string
    - `language` string
    - `created_at` string
    - `updated_at` string
    - `script_id` integer
    - `version` string
    - `deployed_at` string
    - `deployment_failed_at` string
    - `deploying` string
    - `deployment_failure_reason` string
    - `content` string
    - `ai_created` string
    - `value` string
    - `versions` object[]
    - `latest_version` object
  - `meta` PaginationMeta
    - `current_page` integer
    - `from` integer, nullable
    - `last_page` integer
    - `path` string
    - `per_page` integer
    - `to` integer, nullable
    - `total` integer
  - `links` PaginationLinks
    - `first` string, uri
    - `last` string, uri
    - `prev` string, uri, nullable
    - `next` string, uri, nullable

## Other responses

- `401` — Unauthenticated
- `403` — Unauthorized

---

[API](https://skmtc.net/wearepatchworks/apis/patchworks-core-api.md) · [All operations](https://skmtc.net/wearepatchworks/apis/patchworks-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wearepatchworks/patchworks-core-api/revisions/89261af4dd80/schema)