---
title: "List Scaffolder templates"
method: GET
path: "/api/v1/scaffolders"
tags: ["Scaffolder"]
---

# List Scaffolder templates

`GET /api/v1/scaffolders`

## Request

- Base URL: `https://api.getcortexapp.com`
- URL: `https://api.getcortexapp.com/api/v1/scaffolders`
- Auth: HTTP bearer

List Scaffolder templates.

## Query parameters

- `pageSize` integer, required
- `page` integer, required

## Response `200`

Successfully found Scaffolder templates

- ScaffolderListResponse
  - `page` integer, required: Current page number, 0-indexed
  - `scaffolders` ScaffolderResponse[], required: List of Scaffolder templates
    - `createYamlFile` boolean, required: Whether a cortex.yaml is generated for the created entity
    - `createdAt` string, required: ISO-8601 timestamp at which the template was registered
    - `description` string: Description of the Scaffolder template
    - `id` string, required: Unique, auto-generated Cortex ID of the Scaffolder template
    - `labels` string[], required: Descriptive labels used to group templates in the UI
    - `name` string, required: Display name of the Scaffolder template
    - `publisherOptions` union
      - AzureDevops: Options applied to the repository the Scaffolder publishes to
        - `provider` 'GITHUB' | 'GITLAB' | 'BITBUCKET' | 'AZUREDEVOPS', required: The git provider the options apply to
      - Bitbucket: Options applied to the repository the Scaffolder publishes to
        - `provider` 'GITHUB' | 'GITLAB' | 'BITBUCKET' | 'AZUREDEVOPS', required: The git provider the options apply to
        - `visibility` 'PUBLIC' | 'PRIVATE': Visibility of the created repository
      - Github: Options applied to the repository the Scaffolder publishes to
        - `provider` 'GITHUB' | 'GITLAB' | 'BITBUCKET' | 'AZUREDEVOPS', required: The git provider the options apply to
        - `sparseCheckout` boolean, required: Whether the destination is cloned with sparse checkout
        - `visibility` 'PUBLIC' | 'PRIVATE' | 'INTERNAL': Visibility of the created repository
      - Gitlab: Options applied to the repository the Scaffolder publishes to
        - `provider` 'GITHUB' | 'GITLAB' | 'BITBUCKET' | 'AZUREDEVOPS', required: The git provider the options apply to
        - `visibility` 'PUBLIC' | 'PRIVATE': Visibility of the created repository
    - `repoLocator` union, required
      - AzureDevops: Options applied to the repository the Scaffolder publishes to
        - `provider` 'GITHUB' | 'GITLAB' | 'BITBUCKET' | 'AZUREDEVOPS', required: The git provider the options apply to
      - Bitbucket: Options applied to the repository the Scaffolder publishes to
        - `provider` 'GITHUB' | 'GITLAB' | 'BITBUCKET' | 'AZUREDEVOPS', required: The git provider the options apply to
        - `visibility` 'PUBLIC' | 'PRIVATE': Visibility of the created repository
      - Github: Options applied to the repository the Scaffolder publishes to
        - `provider` 'GITHUB' | 'GITLAB' | 'BITBUCKET' | 'AZUREDEVOPS', required: The git provider the options apply to
        - `sparseCheckout` boolean, required: Whether the destination is cloned with sparse checkout
        - `visibility` 'PUBLIC' | 'PRIVATE' | 'INTERNAL': Visibility of the created repository
      - Gitlab: Options applied to the repository the Scaffolder publishes to
        - `provider` 'GITHUB' | 'GITLAB' | 'BITBUCKET' | 'AZUREDEVOPS', required: The git provider the options apply to
        - `visibility` 'PUBLIC' | 'PRIVATE': Visibility of the created repository
    - `requireNewService` boolean, required: Whether running the template must create a new entity
    - `requirePullRequest` boolean, required: Whether the template publishes via a pull request to an existing repository
    - `showReadme` boolean, required: Whether the template repository's README is shown before a run
    - `strictAliasUsage` boolean, required: Whether runs are restricted to the git configuration alias the template names
    - `tag` string, required: Stable, human-readable identifier, unique within the workspace
    - `type` 'COOKIECUTTER', required: The templating engine of the template
    - `updatedAt` string, required: ISO-8601 timestamp at which the template was last updated
  - `total` integer, required: Total number of results
  - `totalPages` integer, required: Total number of pages

## Other responses

- `403`: Access denied
- `429`: The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay.

## Changes

- **2026-11-03** `a7b058663c95`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/cortex/apis/cortex-api/changes/api/v1/scaffolders/get.md)

---

[API](https://skmtc.dev/cortex/apis/cortex-api.md) - [All operations](https://skmtc.dev/cortex/apis/cortex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/cortex/apis/cortex-api/revisions/a7b058663c95?raw)