@makehq/sdk
    Preparing search index...

    Type Alias ListScenariosOptions<C>

    Options for listing scenarios.

    type ListScenariosOptions<C extends keyof Scenario = never> = {
        cols?: C[] | ["*"];
        folderId?: number;
        includeSubfolders?: boolean;
        labelIds?: number[];
        pg?: Partial<Pagination<Scenario>>;
    }

    Type Parameters

    • C extends keyof Scenario = never

      Keys of the Scenario type to include in the response

    Index

    Properties

    cols? folderId? includeSubfolders? labelIds? pg?

    Properties

    cols?: C[] | ["*"]

    Specific columns/fields to include in the response

    folderId?: number

    Only return scenarios placed in this folder

    includeSubfolders?: boolean

    When filtering by folderId, also include scenarios placed in its subfolders

    labelIds?: number[]

    Only return scenarios carrying at least one of the given scenario label IDs

    pg?: Partial<Pagination<Scenario>>

    Pagination options

    Settings

    Member Visibility

    On This Page

    Properties