Scenarios

Returns a paginated, filterable list of scenarios in the organization.

Supply teamId in the property query to restrict results to one team.

Recycle bin: pass property=deleted==true to list soft-deleted (binned) scenarios instead of active ones. When this filter is present, results are further gated by the resource_restore permission — users only see deleted scenarios they're allowed to restore. Without the deleted filter, only active scenarios are returned.

get/api/v3/scenarios

Request

  • Base URL: https://fusion.adobe.io
  • URL: https://fusion.adobe.io/api/v3/scenarios
  • Auth: HTTP bearer and API key in header x-organization-id and API key in header x-api-key and API key in header x-gw-region

Query parameters

fieldsstring
Example:id,name

Comma-separated list of fields to include in the response.

Allowed fields:

  • id
  • name
  • teamId
  • description
  • folderId
  • usedPackages
  • isInvalid
  • isActive
  • isLocked
  • isPaused
  • isWaiting
  • sequential
  • lastEdit
  • scheduling
  • hookId
  • deleted
  • deletedBy
propertystring[]
Property filters. Can be repeated and are AND-ed together.

Allowed fields:
- id
- name
- teamId
- description
- folderId
- isInvalid
- isActive
- isLocked
- isPaused
- lastEdit
- hookId
- deleted

Supported operators:
- ==  (equals)
- !=  (not equals)
- >   (greater than)
- >=  (greater than or equal)
- <   (less than)
- <=  (less than or equal)
- ~   (case-insensitive regex match)

Special cases:
- field           → field exists
- !field          → field does not exist
[
  "teamId==3849"
]
startstring

Paging cursor. Must correspond to "orderby" field and used only when it is set.

limitinteger

Maximum number of items to return. Must be a positive integer. Range 1–200.

orderbystring
Example:+id

Sort property and direction, e.g. +id (ascending) or -id (descending). Allowed fields: id, name, lastEdit.

Response

Successfully retrieved paged scenarios

Example response

{
  "_page": {
    "orderby": "+id",
    "start": "123",
    "next": "124",
    "count": 100
  },
  "_links": {
    "next": "/v3/{{resource}}?orderby=+id&start=123&property=teamId==304",
    "page": "/v3/{{resource}}{?orderby,start,limit,property,type}"
  },
  "items": [
    {
      "id": 123,
      "name": "Daily data sync",
      "teamId": 88,
      "description": "Generate an image.",
      "folderId": 10,
      "usedPackages": [
        "adobe-firefly"
      ],
      "sequential": true,
      "lastEdit": "2026-03-05T15:20:00.000Z",
      "scheduling": {
        "time": "07:53",
        "type": "daily"
      },
      "hookId": 555
    }
  ]
}

Changes

    • info

      added the new optional query request parameter fields

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status

    • info

      removed subschema #1 from the response property allOf list for the response status