---
title: "List scenarios"
method: GET
path: "/scenarios"
tags: ["Scenarios"]
---

# List scenarios

`GET /scenarios`

Retrieves a collection of all scenarios for a team or an organization with a given ID. Returned scenarios are sorted by proprietary setting in descending order.

## Query parameters

- `teamId` integer, required
- `organizationId` integer
- `id[]` integer[]
- `folderId` integer
- `includeSubfolders` boolean
- `labelIds[]` integer[]
- `isActive` boolean
- `islinked` boolean
- `concept` boolean
- `type` 'scenario' | 'tool'
- `deleted` boolean
- `name` string
- `isinvalid` boolean
- `islocked` boolean
- `createdByUserName` string
- `updatedByUserName` string
- `dlqCount` integer
- `cols[]` string[]
- `pg[offset]` integer
- `pg[limit]` integer
- `pg[sortBy]` 'proprietal' | 'id' | 'name' | 'teamId' | 'folderId' | 'isActive' | 'islinked' | 'isinvalid' | 'islocked' | 'lastEdit' | 'createdByUserName' | 'updatedByUserName' | 'created' | 'dlqCount' | 'operations' | 'executions' | 'centicredits' | 'transfer' | 'errors'
- `pg[sortDir]` 'asc' | 'desc'

## Response `200`

Retrieved scenarios

- object
  - `scenarios` object[]
    - `id` integer
    - `name` string
    - `teamId` integer
    - `hookId` integer
    - `devices` object[]
      - `id` integer
      - `scope` string
    - `deviceId` integer
    - `deviceScope` string
    - `description` string
    - `folderId` integer, nullable
    - `concept` boolean — Whether the scenario is a concept (a work-in-progress scenario that has never been activated).
    - `folderPath` string, nullable — Slash-separated folder path for the scenario, for example `CRM/cleanup`.
    - `isinvalid` boolean
    - `islinked` boolean
    - `isActive` boolean
    - `islocked` boolean
    - `isPaused` boolean
    - `usedPackages` string[]
    - `usedModules` object[] — The apps and modules used in the scenario.
      - `packageName` string
      - `moduleName` string
    - `lastEdit` string, date-time
    - `scheduling` object
      - `type` string
      - `interval` integer
    - `iswaiting` boolean
    - `dlqCount` integer — The number of unresolved incomplete executions of the scenario.
    - `allDlqCount` integer — The total number of incomplete executions of the scenario, including resolved ones.
    - `createdByUser` object
      - `id` integer
      - `name` string
      - `email` string
    - `updatedByUser` object
      - `id` integer
      - `name` string
      - `email` string
    - `nextExec` string, date-time
    - `created` string, date-time
    - `scenarioVersion` integer
    - `moduleSequenceId` integer
    - `type` 'scenario' | 'tool'
    - `chainingRole` string, nullable — The scenario's role in a scenario chain (for example when it is triggered by another scenario), or `null` when the scenario is not part of a chain.
    - `isShared` boolean — Whether the scenario is shared.
    - `operations` integer — The number of operations consumed by the scenario in the reported period.
    - `centicredits` integer — The number of centicredits consumed by the scenario in the reported period.
    - `transfer` integer — The amount of data transferred by the scenario in the reported period, in bytes.
    - `executions` integer — The number of times the scenario was executed in the reported period. Returned only when requested via `cols[]`.
    - `errors` integer — The number of failed executions of the scenario in the reported period. Returned only when requested via `cols[]`.
    - `customProperties` object, nullable — The scenario's custom-property values keyed by property name, or `null` when custom properties are not included in the organization's license. Returned only when requested via `cols[]`.
    - `templateMetadata` object, nullable — Metadata linking the scenario to the template it was created from, or `null` when the scenario was not created from a template. Returned only when requested via `cols[]`.
      - `isOem` boolean
      - `versionId` integer
      - `metadataId` integer
      - `instantiableId` integer
    - `deleted` boolean — Whether the scenario is currently soft-deleted (in the trash). Returned only when requested via `cols[]`.
    - `deletedAt` string, date-time, nullable — When the scenario was moved to the trash, or `null` if it is not deleted. Returned only when requested via `cols[]`.
    - `labels` object[] — Team labels assigned to the scenario, sorted by label name case-insensitively.
      - `id` integer
      - `name` string
      - `colour` 'white' | 'neutral' | 'brand' | 'info' | 'success' | 'warning' | 'danger' | 'pink' — Fixed palette semantic token name; the UI maps each token to its hex value.
      - `scope` 'team' — Label visibility tier exposed by the web API. Only team labels are supported in this version.
      - `teamId` integer — The team (company) that owns the label.
      - `description` string, nullable
      - `createdBy` integer, nullable
      - `created` string, date-time
      - `updated` string, date-time, nullable
  - `pg` object
    - `last` string — Shown only when using the `last` based pagination.
    - `showLast` boolean — Shown only when using the `last` based pagination.
    - `sortBy` string
    - `sortDir` string
    - `limit` integer
    - `offset` integer — Shown only when using the `offset` based pagination.

---

[API](https://skmtc.dev/make/apis/web-api-v2-public.md) · [All operations](https://skmtc.dev/make/apis/web-api-v2-public/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/make/web-api-v2-public/revisions/531769e6f813/schema)