Interface FilterWebhookPayload

A filter changed. Undocumented; filter is named after the entity.

interface FilterWebhookPayload {
    filter?: {
        approximateLastUsed?: Date;
        description?: string;
        editPermissions?: {
            group?: {
                groupId?: string | null;
                name?: string;
                self?: string;
                [key: string]: unknown;
            };
            id?: number;
            project?: {
                archived?: boolean;
                archivedBy?: {
                    accountId?: string;
                    accountType?: | "unknown"
                    | (...) & (...)
                    | "atlassian"
                    | "app"
                    | "customer";
                    active?: boolean;
                    applicationRoles?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    appType?: string;
                    avatarUrls?: {
                        "16x16"?: ...;
                        "24x24"?: ...;
                        "32x32"?: ...;
                        "48x48"?: ...;
                        [key: ...]: ...;
                    };
                    displayName?: string;
                    emailAddress?: string;
                    expand?: string;
                    groups?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    guest?: boolean;
                    locale?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                };
                archivedDate?: Date;
                assigneeType?: string & {}
                | "PROJECT_LEAD"
                | "UNASSIGNED";
                avatarUrls?: {
                    "16x16"?: string;
                    "24x24"?: string;
                    "32x32"?: string;
                    "48x48"?: string;
                    [key: string]: unknown;
                };
                components?: {
                    ari?: (...)
                    | (...);
                    assignee?: (...) | (...);
                    assigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                    description?: (...) | (...);
                    id?: (...) | (...);
                    isAssigneeTypeValid?: (...) | (...) | (...);
                    lead?: (...) | (...);
                    leadAccountId?: (...) | (...);
                    metadata?: (...) | (...);
                    name?: (...) | (...);
                    project?: (...) | (...);
                    projectId?: (...) | (...);
                    realAssignee?: (...) | (...);
                    realAssigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                    self?: (...) | (...);
                    [key: string]: unknown;
                }[];
                deleted?: boolean;
                deletedBy?: {
                    accountId?: string;
                    accountType?: | "unknown"
                    | (...) & (...)
                    | "atlassian"
                    | "app"
                    | "customer";
                    active?: boolean;
                    applicationRoles?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    appType?: string;
                    avatarUrls?: {
                        "16x16"?: ...;
                        "24x24"?: ...;
                        "32x32"?: ...;
                        "48x48"?: ...;
                        [key: ...]: ...;
                    };
                    displayName?: string;
                    emailAddress?: string;
                    expand?: string;
                    groups?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    guest?: boolean;
                    locale?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                };
                deletedDate?: Date;
                description?: string;
                email?: string;
                entityId?: string;
                expand?: string;
                favourite?: boolean;
                id?: string;
                insight?: {
                    lastIssueUpdateTime?: Date;
                    totalIssueCount?: number;
                    [key: string]: unknown;
                };
                isPrivate?: boolean;
                issueTypeHierarchy?: { levels?: (...)[]; [key: string]: unknown };
                issueTypes?: {
                    avatarId?: (...) | (...);
                    description?: (...) | (...);
                    entityId?: (...) | (...);
                    hierarchyLevel?: (...) | (...);
                    iconUrl?: (...) | (...);
                    id?: (...) | (...);
                    name?: (...) | (...);
                    scope?: (...) | (...);
                    self?: (...) | (...);
                    subtask?: (...) | (...) | (...);
                    untranslatedName?: (...) | (...);
                    [key: string]: unknown;
                }[];
                key?: string;
                landingPageInfo?: {
                    attributes?: Record<(...), (...)>;
                    boardId?: number;
                    boardName?: string;
                    projectKey?: string;
                    projectType?: string;
                    queueCategory?: string;
                    queueId?: number;
                    queueName?: string;
                    simpleBoard?: boolean;
                    simplified?: boolean;
                    url?: string;
                    [key: string]: unknown;
                };
                lead?: {
                    accountId?: string;
                    accountType?: | "unknown"
                    | (...) & (...)
                    | "atlassian"
                    | "app"
                    | "customer";
                    active?: boolean;
                    applicationRoles?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    appType?: string;
                    avatarUrls?: {
                        "16x16"?: ...;
                        "24x24"?: ...;
                        "32x32"?: ...;
                        "48x48"?: ...;
                        [key: ...]: ...;
                    };
                    displayName?: string;
                    emailAddress?: string;
                    expand?: string;
                    groups?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    guest?: boolean;
                    locale?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                };
                name?: string;
                permissions?: { canEdit?: boolean; [key: string]: unknown };
                projectCategory?: {
                    description?: string;
                    id?: string;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                };
                projectTypeKey?: | string & {}
                | "software"
                | "service_desk"
                | "business"
                | "product_discovery"
                | "customer_service";
                properties?: Record<string, any>;
                retentionTillDate?: Date;
                roles?: Record<string, any>;
                self?: string;
                simplified?: boolean;
                style?: "classic" | string & {} | "next-gen";
                url?: string;
                uuid?: string;
                versions?: {
                    approvers?: (...) | (...);
                    archived?: (...) | (...) | (...);
                    description?: (...) | (...);
                    driver?: (...) | (...);
                    expand?: (...) | (...);
                    id?: (...) | (...);
                    issuesStatusForFixVersion?: (...) | (...);
                    moveUnfixedIssuesTo?: (...) | (...);
                    name?: (...) | (...);
                    operations?: (...) | (...);
                    overdue?: (...) | (...) | (...);
                    projectId?: (...) | (...);
                    released?: (...) | (...) | (...);
                    releaseDate?: (...) | (...);
                    self?: (...) | (...);
                    startDate?: (...) | (...);
                    userReleaseDate?: (...) | (...);
                    userStartDate?: (...) | (...);
                    [key: string]: unknown;
                }[];
                [key: string]: unknown;
            };
            role?: {
                actors?: {
                    actorGroup?: (...)
                    | (...);
                    actorUser?: (...) | (...);
                    avatarUrl?: (...) | (...);
                    displayName?: (...) | (...);
                    id?: (...) | (...);
                    type?: (...) | (...) | (...) | (...);
                    [key: string]: unknown;
                }[];
                admin?: boolean;
                currentUserRole?: boolean;
                default?: boolean;
                description?: string;
                id?: number;
                name?: string;
                roleConfigurable?: boolean;
                scope?: {
                    project?: {
                        avatarUrls?: ...;
                        id?: ...;
                        key?: ...;
                        name?: ...;
                        projectCategory?: ...;
                        projectTypeKey?: ...;
                        self?: ...;
                        simplified?: ...;
                        [key: ...]: ...;
                    };
                    type?: (...) & (...)
                    | "PROJECT"
                    | "TEMPLATE";
                    [key: string]: unknown;
                };
                self?: string;
                translatedName?: string;
                [key: string]: unknown;
            };
            type: | "global"
            | "user"
            | "group"
            | string & {}
            | "project"
            | "projectRole"
            | "loggedin"
            | "authenticated"
            | "project-unknown";
            user?: {
                accountId?: string;
                active?: boolean;
                avatarUrls?: {
                    "16x16"?: string;
                    "24x24"?: string;
                    "32x32"?: string;
                    "48x48"?: string;
                    [key: string]: unknown;
                };
                displayName?: string;
                self?: string;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        }[];
        favourite?: boolean;
        favouritedCount?: number;
        id?: string;
        isWritable?: boolean;
        jql?: string;
        name: string;
        owner?: {
            accountId?: string;
            accountType?: "unknown"
            | string & {}
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: { [key: string]: unknown };
                items?: {
                    defaultGroups?: (...)[];
                    defaultGroupsDetails?: (...)[];
                    defined?: boolean;
                    groupDetails?: (...)[];
                    groups?: (...)[];
                    hasUnlimitedSeats?: boolean;
                    key?: string;
                    name?: string;
                    numberOfSeats?: number;
                    platform?: boolean;
                    remainingSeats?: number;
                    selectedByDefault?: boolean;
                    userCount?: number;
                    userCountDescription?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: { [key: string]: unknown };
                items?: {
                    groupId?: string | null;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                }[];
                "max-results"?: number;
                pagingCallback?: { [key: string]: unknown };
                size?: number;
                [key: string]: unknown;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        searchUrl?: string;
        self?: string;
        sharedUsers?: {
            "end-index"?: number;
            items?: {
                accountId?: string;
                accountType?: "unknown"
                | string & {}
                | "atlassian"
                | "app"
                | "customer";
                active?: boolean;
                applicationRoles?: {
                    callback?: { [key: ...]: ... };
                    items?: (...)[];
                    "max-results"?: number;
                    pagingCallback?: { [key: ...]: ... };
                    size?: number;
                    [key: string]: unknown;
                };
                appType?: string;
                avatarUrls?: {
                    "16x16"?: string;
                    "24x24"?: string;
                    "32x32"?: string;
                    "48x48"?: string;
                    [key: string]: unknown;
                };
                displayName?: string;
                emailAddress?: string;
                expand?: string;
                groups?: {
                    callback?: { [key: ...]: ... };
                    items?: (...)[];
                    "max-results"?: number;
                    pagingCallback?: { [key: ...]: ... };
                    size?: number;
                    [key: string]: unknown;
                };
                guest?: boolean;
                locale?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            }[];
            "max-results"?: number;
            size?: number;
            "start-index"?: number;
            [key: string]: unknown;
        };
        sharePermissions?: {
            group?: {
                groupId?: string
                | null;
                name?: string;
                self?: string;
                [key: string]: unknown;
            };
            id?: number;
            project?: {
                archived?: boolean;
                archivedBy?: {
                    accountId?: string;
                    accountType?: | "unknown"
                    | (...) & (...)
                    | "atlassian"
                    | "app"
                    | "customer";
                    active?: boolean;
                    applicationRoles?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    appType?: string;
                    avatarUrls?: {
                        "16x16"?: ...;
                        "24x24"?: ...;
                        "32x32"?: ...;
                        "48x48"?: ...;
                        [key: ...]: ...;
                    };
                    displayName?: string;
                    emailAddress?: string;
                    expand?: string;
                    groups?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    guest?: boolean;
                    locale?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                };
                archivedDate?: Date;
                assigneeType?: string & {}
                | "PROJECT_LEAD"
                | "UNASSIGNED";
                avatarUrls?: {
                    "16x16"?: string;
                    "24x24"?: string;
                    "32x32"?: string;
                    "48x48"?: string;
                    [key: string]: unknown;
                };
                components?: {
                    ari?: (...)
                    | (...);
                    assignee?: (...) | (...);
                    assigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                    description?: (...) | (...);
                    id?: (...) | (...);
                    isAssigneeTypeValid?: (...) | (...) | (...);
                    lead?: (...) | (...);
                    leadAccountId?: (...) | (...);
                    metadata?: (...) | (...);
                    name?: (...) | (...);
                    project?: (...) | (...);
                    projectId?: (...) | (...);
                    realAssignee?: (...) | (...);
                    realAssigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                    self?: (...) | (...);
                    [key: string]: unknown;
                }[];
                deleted?: boolean;
                deletedBy?: {
                    accountId?: string;
                    accountType?: | "unknown"
                    | (...) & (...)
                    | "atlassian"
                    | "app"
                    | "customer";
                    active?: boolean;
                    applicationRoles?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    appType?: string;
                    avatarUrls?: {
                        "16x16"?: ...;
                        "24x24"?: ...;
                        "32x32"?: ...;
                        "48x48"?: ...;
                        [key: ...]: ...;
                    };
                    displayName?: string;
                    emailAddress?: string;
                    expand?: string;
                    groups?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    guest?: boolean;
                    locale?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                };
                deletedDate?: Date;
                description?: string;
                email?: string;
                entityId?: string;
                expand?: string;
                favourite?: boolean;
                id?: string;
                insight?: {
                    lastIssueUpdateTime?: Date;
                    totalIssueCount?: number;
                    [key: string]: unknown;
                };
                isPrivate?: boolean;
                issueTypeHierarchy?: { levels?: (...)[]; [key: string]: unknown };
                issueTypes?: {
                    avatarId?: (...) | (...);
                    description?: (...) | (...);
                    entityId?: (...) | (...);
                    hierarchyLevel?: (...) | (...);
                    iconUrl?: (...) | (...);
                    id?: (...) | (...);
                    name?: (...) | (...);
                    scope?: (...) | (...);
                    self?: (...) | (...);
                    subtask?: (...) | (...) | (...);
                    untranslatedName?: (...) | (...);
                    [key: string]: unknown;
                }[];
                key?: string;
                landingPageInfo?: {
                    attributes?: Record<(...), (...)>;
                    boardId?: number;
                    boardName?: string;
                    projectKey?: string;
                    projectType?: string;
                    queueCategory?: string;
                    queueId?: number;
                    queueName?: string;
                    simpleBoard?: boolean;
                    simplified?: boolean;
                    url?: string;
                    [key: string]: unknown;
                };
                lead?: {
                    accountId?: string;
                    accountType?: | "unknown"
                    | (...) & (...)
                    | "atlassian"
                    | "app"
                    | "customer";
                    active?: boolean;
                    applicationRoles?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    appType?: string;
                    avatarUrls?: {
                        "16x16"?: ...;
                        "24x24"?: ...;
                        "32x32"?: ...;
                        "48x48"?: ...;
                        [key: ...]: ...;
                    };
                    displayName?: string;
                    emailAddress?: string;
                    expand?: string;
                    groups?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    guest?: boolean;
                    locale?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                };
                name?: string;
                permissions?: { canEdit?: boolean; [key: string]: unknown };
                projectCategory?: {
                    description?: string;
                    id?: string;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                };
                projectTypeKey?: | string & {}
                | "software"
                | "service_desk"
                | "business"
                | "product_discovery"
                | "customer_service";
                properties?: Record<string, any>;
                retentionTillDate?: Date;
                roles?: Record<string, any>;
                self?: string;
                simplified?: boolean;
                style?: "classic" | string & {} | "next-gen";
                url?: string;
                uuid?: string;
                versions?: {
                    approvers?: (...) | (...);
                    archived?: (...) | (...) | (...);
                    description?: (...) | (...);
                    driver?: (...) | (...);
                    expand?: (...) | (...);
                    id?: (...) | (...);
                    issuesStatusForFixVersion?: (...) | (...);
                    moveUnfixedIssuesTo?: (...) | (...);
                    name?: (...) | (...);
                    operations?: (...) | (...);
                    overdue?: (...) | (...) | (...);
                    projectId?: (...) | (...);
                    released?: (...) | (...) | (...);
                    releaseDate?: (...) | (...);
                    self?: (...) | (...);
                    startDate?: (...) | (...);
                    userReleaseDate?: (...) | (...);
                    userStartDate?: (...) | (...);
                    [key: string]: unknown;
                }[];
                [key: string]: unknown;
            };
            role?: {
                actors?: {
                    actorGroup?: (...)
                    | (...);
                    actorUser?: (...) | (...);
                    avatarUrl?: (...) | (...);
                    displayName?: (...) | (...);
                    id?: (...) | (...);
                    type?: (...) | (...) | (...) | (...);
                    [key: string]: unknown;
                }[];
                admin?: boolean;
                currentUserRole?: boolean;
                default?: boolean;
                description?: string;
                id?: number;
                name?: string;
                roleConfigurable?: boolean;
                scope?: {
                    project?: {
                        avatarUrls?: ...;
                        id?: ...;
                        key?: ...;
                        name?: ...;
                        projectCategory?: ...;
                        projectTypeKey?: ...;
                        self?: ...;
                        simplified?: ...;
                        [key: ...]: ...;
                    };
                    type?: (...) & (...)
                    | "PROJECT"
                    | "TEMPLATE";
                    [key: string]: unknown;
                };
                self?: string;
                translatedName?: string;
                [key: string]: unknown;
            };
            type: | "global"
            | "user"
            | "group"
            | string & {}
            | "project"
            | "projectRole"
            | "loggedin"
            | "authenticated"
            | "project-unknown";
            user?: {
                accountId?: string;
                active?: boolean;
                avatarUrls?: {
                    "16x16"?: string;
                    "24x24"?: string;
                    "32x32"?: string;
                    "48x48"?: string;
                    [key: string]: unknown;
                };
                displayName?: string;
                self?: string;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        }[];
        subscriptions?: {
            "end-index"?: number;
            items?: {
                group?: {
                    groupId?: string
                    | null;
                    name?: string;
                    self?: string;
                    [key: string]: unknown;
                };
                id?: number;
                user?: {
                    accountId?: string;
                    accountType?: | "unknown"
                    | (...) & (...)
                    | "atlassian"
                    | "app"
                    | "customer";
                    active?: boolean;
                    applicationRoles?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    appType?: string;
                    avatarUrls?: {
                        "16x16"?: ...;
                        "24x24"?: ...;
                        "32x32"?: ...;
                        "48x48"?: ...;
                        [key: ...]: ...;
                    };
                    displayName?: string;
                    emailAddress?: string;
                    expand?: string;
                    groups?: {
                        callback?: ...;
                        items?: ...;
                        "max-results"?: ...;
                        pagingCallback?: ...;
                        size?: ...;
                        [key: ...]: ...;
                    };
                    guest?: boolean;
                    locale?: string;
                    self?: string;
                    timeZone?: string;
                    [key: string]: unknown;
                };
                [key: string]: unknown;
            }[];
            "max-results"?: number;
            size?: number;
            "start-index"?: number;
            [key: string]: unknown;
        };
        viewUrl?: string;
        [key: string]: unknown;
    };
    matchedWebhookIds?: number[];
    timestamp: number;
    webhookEvent: FilterWebhookEvent;
}

Hierarchy (View Summary)

WebhookPayloadBase
- FilterWebhookPayload

Index

Properties

filter? matchedWebhookIds? timestamp webhookEvent

Properties

`Optional`filter

filter?: {
    approximateLastUsed?: Date;
    description?: string;
    editPermissions?: {
        group?: {
            groupId?: string | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        };
        id?: number;
        project?: {
            archived?: boolean;
            archivedBy?: {
                accountId?: string;
                accountType?: | "unknown"
                | (...) & (...)
                | "atlassian"
                | "app"
                | "customer";
                active?: boolean;
                applicationRoles?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                appType?: string;
                avatarUrls?: {
                    "16x16"?: ...;
                    "24x24"?: ...;
                    "32x32"?: ...;
                    "48x48"?: ...;
                    [key: ...]: ...;
                };
                displayName?: string;
                emailAddress?: string;
                expand?: string;
                groups?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                guest?: boolean;
                locale?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            archivedDate?: Date;
            assigneeType?: string & {}
            | "PROJECT_LEAD"
            | "UNASSIGNED";
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            components?: {
                ari?: (...)
                | (...);
                assignee?: (...) | (...);
                assigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                description?: (...) | (...);
                id?: (...) | (...);
                isAssigneeTypeValid?: (...) | (...) | (...);
                lead?: (...) | (...);
                leadAccountId?: (...) | (...);
                metadata?: (...) | (...);
                name?: (...) | (...);
                project?: (...) | (...);
                projectId?: (...) | (...);
                realAssignee?: (...) | (...);
                realAssigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                self?: (...) | (...);
                [key: string]: unknown;
            }[];
            deleted?: boolean;
            deletedBy?: {
                accountId?: string;
                accountType?: | "unknown"
                | (...) & (...)
                | "atlassian"
                | "app"
                | "customer";
                active?: boolean;
                applicationRoles?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                appType?: string;
                avatarUrls?: {
                    "16x16"?: ...;
                    "24x24"?: ...;
                    "32x32"?: ...;
                    "48x48"?: ...;
                    [key: ...]: ...;
                };
                displayName?: string;
                emailAddress?: string;
                expand?: string;
                groups?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                guest?: boolean;
                locale?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            deletedDate?: Date;
            description?: string;
            email?: string;
            entityId?: string;
            expand?: string;
            favourite?: boolean;
            id?: string;
            insight?: {
                lastIssueUpdateTime?: Date;
                totalIssueCount?: number;
                [key: string]: unknown;
            };
            isPrivate?: boolean;
            issueTypeHierarchy?: { levels?: (...)[]; [key: string]: unknown };
            issueTypes?: {
                avatarId?: (...) | (...);
                description?: (...) | (...);
                entityId?: (...) | (...);
                hierarchyLevel?: (...) | (...);
                iconUrl?: (...) | (...);
                id?: (...) | (...);
                name?: (...) | (...);
                scope?: (...) | (...);
                self?: (...) | (...);
                subtask?: (...) | (...) | (...);
                untranslatedName?: (...) | (...);
                [key: string]: unknown;
            }[];
            key?: string;
            landingPageInfo?: {
                attributes?: Record<(...), (...)>;
                boardId?: number;
                boardName?: string;
                projectKey?: string;
                projectType?: string;
                queueCategory?: string;
                queueId?: number;
                queueName?: string;
                simpleBoard?: boolean;
                simplified?: boolean;
                url?: string;
                [key: string]: unknown;
            };
            lead?: {
                accountId?: string;
                accountType?: | "unknown"
                | (...) & (...)
                | "atlassian"
                | "app"
                | "customer";
                active?: boolean;
                applicationRoles?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                appType?: string;
                avatarUrls?: {
                    "16x16"?: ...;
                    "24x24"?: ...;
                    "32x32"?: ...;
                    "48x48"?: ...;
                    [key: ...]: ...;
                };
                displayName?: string;
                emailAddress?: string;
                expand?: string;
                groups?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                guest?: boolean;
                locale?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            name?: string;
            permissions?: { canEdit?: boolean; [key: string]: unknown };
            projectCategory?: {
                description?: string;
                id?: string;
                name?: string;
                self?: string;
                [key: string]: unknown;
            };
            projectTypeKey?: | string & {}
            | "software"
            | "service_desk"
            | "business"
            | "product_discovery"
            | "customer_service";
            properties?: Record<string, any>;
            retentionTillDate?: Date;
            roles?: Record<string, any>;
            self?: string;
            simplified?: boolean;
            style?: "classic" | string & {} | "next-gen";
            url?: string;
            uuid?: string;
            versions?: {
                approvers?: (...) | (...);
                archived?: (...) | (...) | (...);
                description?: (...) | (...);
                driver?: (...) | (...);
                expand?: (...) | (...);
                id?: (...) | (...);
                issuesStatusForFixVersion?: (...) | (...);
                moveUnfixedIssuesTo?: (...) | (...);
                name?: (...) | (...);
                operations?: (...) | (...);
                overdue?: (...) | (...) | (...);
                projectId?: (...) | (...);
                released?: (...) | (...) | (...);
                releaseDate?: (...) | (...);
                self?: (...) | (...);
                startDate?: (...) | (...);
                userReleaseDate?: (...) | (...);
                userStartDate?: (...) | (...);
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        };
        role?: {
            actors?: {
                actorGroup?: (...)
                | (...);
                actorUser?: (...) | (...);
                avatarUrl?: (...) | (...);
                displayName?: (...) | (...);
                id?: (...) | (...);
                type?: (...) | (...) | (...) | (...);
                [key: string]: unknown;
            }[];
            admin?: boolean;
            currentUserRole?: boolean;
            default?: boolean;
            description?: string;
            id?: number;
            name?: string;
            roleConfigurable?: boolean;
            scope?: {
                project?: {
                    avatarUrls?: ...;
                    id?: ...;
                    key?: ...;
                    name?: ...;
                    projectCategory?: ...;
                    projectTypeKey?: ...;
                    self?: ...;
                    simplified?: ...;
                    [key: ...]: ...;
                };
                type?: (...) & (...)
                | "PROJECT"
                | "TEMPLATE";
                [key: string]: unknown;
            };
            self?: string;
            translatedName?: string;
            [key: string]: unknown;
        };
        type: | "global"
        | "user"
        | "group"
        | string & {}
        | "project"
        | "projectRole"
        | "loggedin"
        | "authenticated"
        | "project-unknown";
        user?: {
            accountId?: string;
            active?: boolean;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            self?: string;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    }[];
    favourite?: boolean;
    favouritedCount?: number;
    id?: string;
    isWritable?: boolean;
    jql?: string;
    name: string;
    owner?: {
        accountId?: string;
        accountType?: "unknown"
        | string & {}
        | "atlassian"
        | "app"
        | "customer";
        active?: boolean;
        applicationRoles?: {
            callback?: { [key: string]: unknown };
            items?: {
                defaultGroups?: (...)[];
                defaultGroupsDetails?: (...)[];
                defined?: boolean;
                groupDetails?: (...)[];
                groups?: (...)[];
                hasUnlimitedSeats?: boolean;
                key?: string;
                name?: string;
                numberOfSeats?: number;
                platform?: boolean;
                remainingSeats?: number;
                selectedByDefault?: boolean;
                userCount?: number;
                userCountDescription?: string;
                [key: string]: unknown;
            }[];
            "max-results"?: number;
            pagingCallback?: { [key: string]: unknown };
            size?: number;
            [key: string]: unknown;
        };
        appType?: string;
        avatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        };
        displayName?: string;
        emailAddress?: string;
        expand?: string;
        groups?: {
            callback?: { [key: string]: unknown };
            items?: {
                groupId?: string | null;
                name?: string;
                self?: string;
                [key: string]: unknown;
            }[];
            "max-results"?: number;
            pagingCallback?: { [key: string]: unknown };
            size?: number;
            [key: string]: unknown;
        };
        guest?: boolean;
        locale?: string;
        self?: string;
        timeZone?: string;
        [key: string]: unknown;
    };
    searchUrl?: string;
    self?: string;
    sharedUsers?: {
        "end-index"?: number;
        items?: {
            accountId?: string;
            accountType?: "unknown"
            | string & {}
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: { [key: ...]: ... };
                items?: (...)[];
                "max-results"?: number;
                pagingCallback?: { [key: ...]: ... };
                size?: number;
                [key: string]: unknown;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: { [key: ...]: ... };
                items?: (...)[];
                "max-results"?: number;
                pagingCallback?: { [key: ...]: ... };
                size?: number;
                [key: string]: unknown;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        size?: number;
        "start-index"?: number;
        [key: string]: unknown;
    };
    sharePermissions?: {
        group?: {
            groupId?: string
            | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        };
        id?: number;
        project?: {
            archived?: boolean;
            archivedBy?: {
                accountId?: string;
                accountType?: | "unknown"
                | (...) & (...)
                | "atlassian"
                | "app"
                | "customer";
                active?: boolean;
                applicationRoles?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                appType?: string;
                avatarUrls?: {
                    "16x16"?: ...;
                    "24x24"?: ...;
                    "32x32"?: ...;
                    "48x48"?: ...;
                    [key: ...]: ...;
                };
                displayName?: string;
                emailAddress?: string;
                expand?: string;
                groups?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                guest?: boolean;
                locale?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            archivedDate?: Date;
            assigneeType?: string & {}
            | "PROJECT_LEAD"
            | "UNASSIGNED";
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            components?: {
                ari?: (...)
                | (...);
                assignee?: (...) | (...);
                assigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                description?: (...) | (...);
                id?: (...) | (...);
                isAssigneeTypeValid?: (...) | (...) | (...);
                lead?: (...) | (...);
                leadAccountId?: (...) | (...);
                metadata?: (...) | (...);
                name?: (...) | (...);
                project?: (...) | (...);
                projectId?: (...) | (...);
                realAssignee?: (...) | (...);
                realAssigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
                self?: (...) | (...);
                [key: string]: unknown;
            }[];
            deleted?: boolean;
            deletedBy?: {
                accountId?: string;
                accountType?: | "unknown"
                | (...) & (...)
                | "atlassian"
                | "app"
                | "customer";
                active?: boolean;
                applicationRoles?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                appType?: string;
                avatarUrls?: {
                    "16x16"?: ...;
                    "24x24"?: ...;
                    "32x32"?: ...;
                    "48x48"?: ...;
                    [key: ...]: ...;
                };
                displayName?: string;
                emailAddress?: string;
                expand?: string;
                groups?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                guest?: boolean;
                locale?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            deletedDate?: Date;
            description?: string;
            email?: string;
            entityId?: string;
            expand?: string;
            favourite?: boolean;
            id?: string;
            insight?: {
                lastIssueUpdateTime?: Date;
                totalIssueCount?: number;
                [key: string]: unknown;
            };
            isPrivate?: boolean;
            issueTypeHierarchy?: { levels?: (...)[]; [key: string]: unknown };
            issueTypes?: {
                avatarId?: (...) | (...);
                description?: (...) | (...);
                entityId?: (...) | (...);
                hierarchyLevel?: (...) | (...);
                iconUrl?: (...) | (...);
                id?: (...) | (...);
                name?: (...) | (...);
                scope?: (...) | (...);
                self?: (...) | (...);
                subtask?: (...) | (...) | (...);
                untranslatedName?: (...) | (...);
                [key: string]: unknown;
            }[];
            key?: string;
            landingPageInfo?: {
                attributes?: Record<(...), (...)>;
                boardId?: number;
                boardName?: string;
                projectKey?: string;
                projectType?: string;
                queueCategory?: string;
                queueId?: number;
                queueName?: string;
                simpleBoard?: boolean;
                simplified?: boolean;
                url?: string;
                [key: string]: unknown;
            };
            lead?: {
                accountId?: string;
                accountType?: | "unknown"
                | (...) & (...)
                | "atlassian"
                | "app"
                | "customer";
                active?: boolean;
                applicationRoles?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                appType?: string;
                avatarUrls?: {
                    "16x16"?: ...;
                    "24x24"?: ...;
                    "32x32"?: ...;
                    "48x48"?: ...;
                    [key: ...]: ...;
                };
                displayName?: string;
                emailAddress?: string;
                expand?: string;
                groups?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                guest?: boolean;
                locale?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            name?: string;
            permissions?: { canEdit?: boolean; [key: string]: unknown };
            projectCategory?: {
                description?: string;
                id?: string;
                name?: string;
                self?: string;
                [key: string]: unknown;
            };
            projectTypeKey?: | string & {}
            | "software"
            | "service_desk"
            | "business"
            | "product_discovery"
            | "customer_service";
            properties?: Record<string, any>;
            retentionTillDate?: Date;
            roles?: Record<string, any>;
            self?: string;
            simplified?: boolean;
            style?: "classic" | string & {} | "next-gen";
            url?: string;
            uuid?: string;
            versions?: {
                approvers?: (...) | (...);
                archived?: (...) | (...) | (...);
                description?: (...) | (...);
                driver?: (...) | (...);
                expand?: (...) | (...);
                id?: (...) | (...);
                issuesStatusForFixVersion?: (...) | (...);
                moveUnfixedIssuesTo?: (...) | (...);
                name?: (...) | (...);
                operations?: (...) | (...);
                overdue?: (...) | (...) | (...);
                projectId?: (...) | (...);
                released?: (...) | (...) | (...);
                releaseDate?: (...) | (...);
                self?: (...) | (...);
                startDate?: (...) | (...);
                userReleaseDate?: (...) | (...);
                userStartDate?: (...) | (...);
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        };
        role?: {
            actors?: {
                actorGroup?: (...)
                | (...);
                actorUser?: (...) | (...);
                avatarUrl?: (...) | (...);
                displayName?: (...) | (...);
                id?: (...) | (...);
                type?: (...) | (...) | (...) | (...);
                [key: string]: unknown;
            }[];
            admin?: boolean;
            currentUserRole?: boolean;
            default?: boolean;
            description?: string;
            id?: number;
            name?: string;
            roleConfigurable?: boolean;
            scope?: {
                project?: {
                    avatarUrls?: ...;
                    id?: ...;
                    key?: ...;
                    name?: ...;
                    projectCategory?: ...;
                    projectTypeKey?: ...;
                    self?: ...;
                    simplified?: ...;
                    [key: ...]: ...;
                };
                type?: (...) & (...)
                | "PROJECT"
                | "TEMPLATE";
                [key: string]: unknown;
            };
            self?: string;
            translatedName?: string;
            [key: string]: unknown;
        };
        type: | "global"
        | "user"
        | "group"
        | string & {}
        | "project"
        | "projectRole"
        | "loggedin"
        | "authenticated"
        | "project-unknown";
        user?: {
            accountId?: string;
            active?: boolean;
            avatarUrls?: {
                "16x16"?: string;
                "24x24"?: string;
                "32x32"?: string;
                "48x48"?: string;
                [key: string]: unknown;
            };
            displayName?: string;
            self?: string;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    }[];
    subscriptions?: {
        "end-index"?: number;
        items?: {
            group?: {
                groupId?: string
                | null;
                name?: string;
                self?: string;
                [key: string]: unknown;
            };
            id?: number;
            user?: {
                accountId?: string;
                accountType?: | "unknown"
                | (...) & (...)
                | "atlassian"
                | "app"
                | "customer";
                active?: boolean;
                applicationRoles?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                appType?: string;
                avatarUrls?: {
                    "16x16"?: ...;
                    "24x24"?: ...;
                    "32x32"?: ...;
                    "48x48"?: ...;
                    [key: ...]: ...;
                };
                displayName?: string;
                emailAddress?: string;
                expand?: string;
                groups?: {
                    callback?: ...;
                    items?: ...;
                    "max-results"?: ...;
                    pagingCallback?: ...;
                    size?: ...;
                    [key: ...]: ...;
                };
                guest?: boolean;
                locale?: string;
                self?: string;
                timeZone?: string;
                [key: string]: unknown;
            };
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        size?: number;
        "start-index"?: number;
        [key: string]: unknown;
    };
    viewUrl?: string;
    [key: string]: unknown;
}

Type Declaration

[key: string]: unknown
OptionalapproximateLastUsed?: Date

[Experimental] Approximate last used time. Returns the date and time when the filter was last used. Returns null if the filter hasn't been used after tracking was enabled. For performance reasons, timestamps aren't updated in real time and therefore may not be exactly accurate.
Optionaldescription?: string

A description of the filter.
OptionaleditPermissions?: {
    group?: {
        groupId?: string | null;
        name?: string;
        self?: string;
        [key: string]: unknown;
    };
    id?: number;
    project?: {
        archived?: boolean;
        archivedBy?: {
            accountId?: string;
            accountType?: | "unknown"
            | (...) & (...)
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: ...;
                "24x24"?: ...;
                "32x32"?: ...;
                "48x48"?: ...;
                [key: ...]: ...;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        archivedDate?: Date;
        assigneeType?: string & {}
        | "PROJECT_LEAD"
        | "UNASSIGNED";
        avatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        };
        components?: {
            ari?: (...)
            | (...);
            assignee?: (...) | (...);
            assigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
            description?: (...) | (...);
            id?: (...) | (...);
            isAssigneeTypeValid?: (...) | (...) | (...);
            lead?: (...) | (...);
            leadAccountId?: (...) | (...);
            metadata?: (...) | (...);
            name?: (...) | (...);
            project?: (...) | (...);
            projectId?: (...) | (...);
            realAssignee?: (...) | (...);
            realAssigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
            self?: (...) | (...);
            [key: string]: unknown;
        }[];
        deleted?: boolean;
        deletedBy?: {
            accountId?: string;
            accountType?: | "unknown"
            | (...) & (...)
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: ...;
                "24x24"?: ...;
                "32x32"?: ...;
                "48x48"?: ...;
                [key: ...]: ...;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        deletedDate?: Date;
        description?: string;
        email?: string;
        entityId?: string;
        expand?: string;
        favourite?: boolean;
        id?: string;
        insight?: {
            lastIssueUpdateTime?: Date;
            totalIssueCount?: number;
            [key: string]: unknown;
        };
        isPrivate?: boolean;
        issueTypeHierarchy?: { levels?: (...)[]; [key: string]: unknown };
        issueTypes?: {
            avatarId?: (...) | (...);
            description?: (...) | (...);
            entityId?: (...) | (...);
            hierarchyLevel?: (...) | (...);
            iconUrl?: (...) | (...);
            id?: (...) | (...);
            name?: (...) | (...);
            scope?: (...) | (...);
            self?: (...) | (...);
            subtask?: (...) | (...) | (...);
            untranslatedName?: (...) | (...);
            [key: string]: unknown;
        }[];
        key?: string;
        landingPageInfo?: {
            attributes?: Record<(...), (...)>;
            boardId?: number;
            boardName?: string;
            projectKey?: string;
            projectType?: string;
            queueCategory?: string;
            queueId?: number;
            queueName?: string;
            simpleBoard?: boolean;
            simplified?: boolean;
            url?: string;
            [key: string]: unknown;
        };
        lead?: {
            accountId?: string;
            accountType?: | "unknown"
            | (...) & (...)
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: ...;
                "24x24"?: ...;
                "32x32"?: ...;
                "48x48"?: ...;
                [key: ...]: ...;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        name?: string;
        permissions?: { canEdit?: boolean; [key: string]: unknown };
        projectCategory?: {
            description?: string;
            id?: string;
            name?: string;
            self?: string;
            [key: string]: unknown;
        };
        projectTypeKey?: | string & {}
        | "software"
        | "service_desk"
        | "business"
        | "product_discovery"
        | "customer_service";
        properties?: Record<string, any>;
        retentionTillDate?: Date;
        roles?: Record<string, any>;
        self?: string;
        simplified?: boolean;
        style?: "classic" | string & {} | "next-gen";
        url?: string;
        uuid?: string;
        versions?: {
            approvers?: (...) | (...);
            archived?: (...) | (...) | (...);
            description?: (...) | (...);
            driver?: (...) | (...);
            expand?: (...) | (...);
            id?: (...) | (...);
            issuesStatusForFixVersion?: (...) | (...);
            moveUnfixedIssuesTo?: (...) | (...);
            name?: (...) | (...);
            operations?: (...) | (...);
            overdue?: (...) | (...) | (...);
            projectId?: (...) | (...);
            released?: (...) | (...) | (...);
            releaseDate?: (...) | (...);
            self?: (...) | (...);
            startDate?: (...) | (...);
            userReleaseDate?: (...) | (...);
            userStartDate?: (...) | (...);
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    };
    role?: {
        actors?: {
            actorGroup?: (...)
            | (...);
            actorUser?: (...) | (...);
            avatarUrl?: (...) | (...);
            displayName?: (...) | (...);
            id?: (...) | (...);
            type?: (...) | (...) | (...) | (...);
            [key: string]: unknown;
        }[];
        admin?: boolean;
        currentUserRole?: boolean;
        default?: boolean;
        description?: string;
        id?: number;
        name?: string;
        roleConfigurable?: boolean;
        scope?: {
            project?: {
                avatarUrls?: ...;
                id?: ...;
                key?: ...;
                name?: ...;
                projectCategory?: ...;
                projectTypeKey?: ...;
                self?: ...;
                simplified?: ...;
                [key: ...]: ...;
            };
            type?: (...) & (...)
            | "PROJECT"
            | "TEMPLATE";
            [key: string]: unknown;
        };
        self?: string;
        translatedName?: string;
        [key: string]: unknown;
    };
    type: | "global"
    | "user"
    | "group"
    | string & {}
    | "project"
    | "projectRole"
    | "loggedin"
    | "authenticated"
    | "project-unknown";
    user?: {
        accountId?: string;
        active?: boolean;
        avatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        };
        displayName?: string;
        self?: string;
        [key: string]: unknown;
    };
    [key: string]: unknown;
}[]

The groups and projects that can edit the filter.
Optionalfavourite?: boolean

Whether the filter is selected as a favorite.
OptionalfavouritedCount?: number

The count of how many users have selected this filter as a favorite, including the filter owner.
Optionalid?: string

The unique identifier for the filter.
OptionalisWritable?: boolean
Optionaljql?: string

The JQL query for the filter. For example, project = SSP AND issuetype = Bug.
name: string

The name of the filter. Must be unique.
Optionalowner?: {
    accountId?: string;
    accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
    active?: boolean;
    applicationRoles?: {
        callback?: { [key: string]: unknown };
        items?: {
            defaultGroups?: (...)[];
            defaultGroupsDetails?: (...)[];
            defined?: boolean;
            groupDetails?: (...)[];
            groups?: (...)[];
            hasUnlimitedSeats?: boolean;
            key?: string;
            name?: string;
            numberOfSeats?: number;
            platform?: boolean;
            remainingSeats?: number;
            selectedByDefault?: boolean;
            userCount?: number;
            userCountDescription?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    };
    appType?: string;
    avatarUrls?: {
        "16x16"?: string;
        "24x24"?: string;
        "32x32"?: string;
        "48x48"?: string;
        [key: string]: unknown;
    };
    displayName?: string;
    emailAddress?: string;
    expand?: string;
    groups?: {
        callback?: { [key: string]: unknown };
        items?: {
            groupId?: string | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        }[];
        "max-results"?: number;
        pagingCallback?: { [key: string]: unknown };
        size?: number;
        [key: string]: unknown;
    };
    guest?: boolean;
    locale?: string;
    self?: string;
    timeZone?: string;
    [key: string]: unknown;
}
- OptionalaccountId?: string
  
  The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests.
- OptionalaccountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"
  The user account type. Can take the following values:
  - atlassian regular Atlassian user account
  - app system account used for Connect applications and OAuth to represent external systems
  - customer Jira Service Desk account representing an external service desk
- Optionalactive?: boolean
  
  Whether the user is active.
- OptionalapplicationRoles?: {
      callback?: { [key: string]: unknown };
      items?: {
          defaultGroups?: (...)[];
          defaultGroupsDetails?: (...)[];
          defined?: boolean;
          groupDetails?: (...)[];
          groups?: (...)[];
          hasUnlimitedSeats?: boolean;
          key?: string;
          name?: string;
          numberOfSeats?: number;
          platform?: boolean;
          remainingSeats?: number;
          selectedByDefault?: boolean;
          userCount?: number;
          userCountDescription?: string;
          [key: string]: unknown;
      }[];
      "max-results"?: number;
      pagingCallback?: { [key: string]: unknown };
      size?: number;
      [key: string]: unknown;
  }
- OptionalappType?: string
  The app type of the user account when accountType is 'app'. Can take the following values:
  - service Service Account
  - agent Rovo Agent Account
  - unknown Unknown app type
- OptionalavatarUrls?: {
      "16x16"?: string;
      "24x24"?: string;
      "32x32"?: string;
      "48x48"?: string;
      [key: string]: unknown;
  }
  - Optional16x16?: string
    
    The URL of the item's 16x16 pixel avatar.
  - Optional24x24?: string
    
    The URL of the item's 24x24 pixel avatar.
  - Optional32x32?: string
    
    The URL of the item's 32x32 pixel avatar.
  - Optional48x48?: string
    
    The URL of the item's 48x48 pixel avatar.
- OptionaldisplayName?: string
  
  The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
- OptionalemailAddress?: string
  
  The email address of the user. Depending on the user’s privacy setting, this may be returned as null.
- Optionalexpand?: string
  
  Expand options that include additional user details in the response.
- Optionalgroups?: {
      callback?: { [key: string]: unknown };
      items?: {
          groupId?: string | null;
          name?: string;
          self?: string;
          [key: string]: unknown;
      }[];
      "max-results"?: number;
      pagingCallback?: { [key: string]: unknown };
      size?: number;
      [key: string]: unknown;
  }
- Optionalguest?: boolean
  
  Whether the user is a guest.
- Optionallocale?: string
  
  The locale of the user. Depending on the user’s privacy setting, this may be returned as null.
- Optionalself?: string
  
  The URL of the user.
- OptionaltimeZone?: string
  
  The time zone specified in the user's profile. If the user's time zone is not visible to the current user (due to user's profile setting), or if a time zone has not been set, the instance's default time zone will be returned.
OptionalsearchUrl?: string

A URL to view the filter results in Jira, using the Search for issues using JQL operation with the filter's JQL string to return the filter results. For example, _https://your-domain.atlassian.net/rest/api/3/search?jql=project+%3D+SSP+AND+issuetype+%3D+Bug_.
Optionalself?: string

The URL of the filter.
OptionalsharedUsers?: {
    "end-index"?: number;
    items?: {
        accountId?: string;
        accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
        active?: boolean;
        applicationRoles?: {
            callback?: { [key: ...]: ... };
            items?: (...)[];
            "max-results"?: number;
            pagingCallback?: { [key: ...]: ... };
            size?: number;
            [key: string]: unknown;
        };
        appType?: string;
        avatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        };
        displayName?: string;
        emailAddress?: string;
        expand?: string;
        groups?: {
            callback?: { [key: ...]: ... };
            items?: (...)[];
            "max-results"?: number;
            pagingCallback?: { [key: ...]: ... };
            size?: number;
            [key: string]: unknown;
        };
        guest?: boolean;
        locale?: string;
        self?: string;
        timeZone?: string;
        [key: string]: unknown;
    }[];
    "max-results"?: number;
    size?: number;
    "start-index"?: number;
    [key: string]: unknown;
}
- Optionalend-index?: number
  
  The index of the last item returned on the page.
- Optionalitems?: {
      accountId?: string;
      accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer";
      active?: boolean;
      applicationRoles?: {
          callback?: { [key: ...]: ... };
          items?: (...)[];
          "max-results"?: number;
          pagingCallback?: { [key: ...]: ... };
          size?: number;
          [key: string]: unknown;
      };
      appType?: string;
      avatarUrls?: {
          "16x16"?: string;
          "24x24"?: string;
          "32x32"?: string;
          "48x48"?: string;
          [key: string]: unknown;
      };
      displayName?: string;
      emailAddress?: string;
      expand?: string;
      groups?: {
          callback?: { [key: ...]: ... };
          items?: (...)[];
          "max-results"?: number;
          pagingCallback?: { [key: ...]: ... };
          size?: number;
          [key: string]: unknown;
      };
      guest?: boolean;
      locale?: string;
      self?: string;
      timeZone?: string;
      [key: string]: unknown;
  }[]
  
  The list of items.
- Optionalmax-results?: number
  
  The maximum number of results that could be on the page.
- Optionalsize?: number
  
  The number of items on the page.
- Optionalstart-index?: number
  
  The index of the first item returned on the page.
OptionalsharePermissions?: {
    group?: {
        groupId?: string | null;
        name?: string;
        self?: string;
        [key: string]: unknown;
    };
    id?: number;
    project?: {
        archived?: boolean;
        archivedBy?: {
            accountId?: string;
            accountType?: | "unknown"
            | (...) & (...)
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: ...;
                "24x24"?: ...;
                "32x32"?: ...;
                "48x48"?: ...;
                [key: ...]: ...;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        archivedDate?: Date;
        assigneeType?: string & {}
        | "PROJECT_LEAD"
        | "UNASSIGNED";
        avatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        };
        components?: {
            ari?: (...)
            | (...);
            assignee?: (...) | (...);
            assigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
            description?: (...) | (...);
            id?: (...) | (...);
            isAssigneeTypeValid?: (...) | (...) | (...);
            lead?: (...) | (...);
            leadAccountId?: (...) | (...);
            metadata?: (...) | (...);
            name?: (...) | (...);
            project?: (...) | (...);
            projectId?: (...) | (...);
            realAssignee?: (...) | (...);
            realAssigneeType?: (...) | (...) | (...) | (...) | (...) | (...);
            self?: (...) | (...);
            [key: string]: unknown;
        }[];
        deleted?: boolean;
        deletedBy?: {
            accountId?: string;
            accountType?: | "unknown"
            | (...) & (...)
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: ...;
                "24x24"?: ...;
                "32x32"?: ...;
                "48x48"?: ...;
                [key: ...]: ...;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        deletedDate?: Date;
        description?: string;
        email?: string;
        entityId?: string;
        expand?: string;
        favourite?: boolean;
        id?: string;
        insight?: {
            lastIssueUpdateTime?: Date;
            totalIssueCount?: number;
            [key: string]: unknown;
        };
        isPrivate?: boolean;
        issueTypeHierarchy?: { levels?: (...)[]; [key: string]: unknown };
        issueTypes?: {
            avatarId?: (...) | (...);
            description?: (...) | (...);
            entityId?: (...) | (...);
            hierarchyLevel?: (...) | (...);
            iconUrl?: (...) | (...);
            id?: (...) | (...);
            name?: (...) | (...);
            scope?: (...) | (...);
            self?: (...) | (...);
            subtask?: (...) | (...) | (...);
            untranslatedName?: (...) | (...);
            [key: string]: unknown;
        }[];
        key?: string;
        landingPageInfo?: {
            attributes?: Record<(...), (...)>;
            boardId?: number;
            boardName?: string;
            projectKey?: string;
            projectType?: string;
            queueCategory?: string;
            queueId?: number;
            queueName?: string;
            simpleBoard?: boolean;
            simplified?: boolean;
            url?: string;
            [key: string]: unknown;
        };
        lead?: {
            accountId?: string;
            accountType?: | "unknown"
            | (...) & (...)
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: ...;
                "24x24"?: ...;
                "32x32"?: ...;
                "48x48"?: ...;
                [key: ...]: ...;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        name?: string;
        permissions?: { canEdit?: boolean; [key: string]: unknown };
        projectCategory?: {
            description?: string;
            id?: string;
            name?: string;
            self?: string;
            [key: string]: unknown;
        };
        projectTypeKey?: | string & {}
        | "software"
        | "service_desk"
        | "business"
        | "product_discovery"
        | "customer_service";
        properties?: Record<string, any>;
        retentionTillDate?: Date;
        roles?: Record<string, any>;
        self?: string;
        simplified?: boolean;
        style?: "classic" | string & {} | "next-gen";
        url?: string;
        uuid?: string;
        versions?: {
            approvers?: (...) | (...);
            archived?: (...) | (...) | (...);
            description?: (...) | (...);
            driver?: (...) | (...);
            expand?: (...) | (...);
            id?: (...) | (...);
            issuesStatusForFixVersion?: (...) | (...);
            moveUnfixedIssuesTo?: (...) | (...);
            name?: (...) | (...);
            operations?: (...) | (...);
            overdue?: (...) | (...) | (...);
            projectId?: (...) | (...);
            released?: (...) | (...) | (...);
            releaseDate?: (...) | (...);
            self?: (...) | (...);
            startDate?: (...) | (...);
            userReleaseDate?: (...) | (...);
            userStartDate?: (...) | (...);
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    };
    role?: {
        actors?: {
            actorGroup?: (...)
            | (...);
            actorUser?: (...) | (...);
            avatarUrl?: (...) | (...);
            displayName?: (...) | (...);
            id?: (...) | (...);
            type?: (...) | (...) | (...) | (...);
            [key: string]: unknown;
        }[];
        admin?: boolean;
        currentUserRole?: boolean;
        default?: boolean;
        description?: string;
        id?: number;
        name?: string;
        roleConfigurable?: boolean;
        scope?: {
            project?: {
                avatarUrls?: ...;
                id?: ...;
                key?: ...;
                name?: ...;
                projectCategory?: ...;
                projectTypeKey?: ...;
                self?: ...;
                simplified?: ...;
                [key: ...]: ...;
            };
            type?: (...) & (...)
            | "PROJECT"
            | "TEMPLATE";
            [key: string]: unknown;
        };
        self?: string;
        translatedName?: string;
        [key: string]: unknown;
    };
    type: | "global"
    | "user"
    | "group"
    | string & {}
    | "project"
    | "projectRole"
    | "loggedin"
    | "authenticated"
    | "project-unknown";
    user?: {
        accountId?: string;
        active?: boolean;
        avatarUrls?: {
            "16x16"?: string;
            "24x24"?: string;
            "32x32"?: string;
            "48x48"?: string;
            [key: string]: unknown;
        };
        displayName?: string;
        self?: string;
        [key: string]: unknown;
    };
    [key: string]: unknown;
}[]

The groups and projects that the filter is shared with.
Optionalsubscriptions?: {
    "end-index"?: number;
    items?: {
        group?: {
            groupId?: string | null;
            name?: string;
            self?: string;
            [key: string]: unknown;
        };
        id?: number;
        user?: {
            accountId?: string;
            accountType?: | "unknown"
            | (...) & (...)
            | "atlassian"
            | "app"
            | "customer";
            active?: boolean;
            applicationRoles?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            appType?: string;
            avatarUrls?: {
                "16x16"?: ...;
                "24x24"?: ...;
                "32x32"?: ...;
                "48x48"?: ...;
                [key: ...]: ...;
            };
            displayName?: string;
            emailAddress?: string;
            expand?: string;
            groups?: {
                callback?: ...;
                items?: ...;
                "max-results"?: ...;
                pagingCallback?: ...;
                size?: ...;
                [key: ...]: ...;
            };
            guest?: boolean;
            locale?: string;
            self?: string;
            timeZone?: string;
            [key: string]: unknown;
        };
        [key: string]: unknown;
    }[];
    "max-results"?: number;
    size?: number;
    "start-index"?: number;
    [key: string]: unknown;
}
- Optionalend-index?: number
  
  The index of the last item returned on the page.
- Optionalitems?: {
      group?: {
          groupId?: string | null;
          name?: string;
          self?: string;
          [key: string]: unknown;
      };
      id?: number;
      user?: {
          accountId?: string;
          accountType?: "unknown"
          | (...) & (...)
          | "atlassian"
          | "app"
          | "customer";
          active?: boolean;
          applicationRoles?: {
              callback?: ...;
              items?: ...;
              "max-results"?: ...;
              pagingCallback?: ...;
              size?: ...;
              [key: ...]: ...;
          };
          appType?: string;
          avatarUrls?: {
              "16x16"?: ...;
              "24x24"?: ...;
              "32x32"?: ...;
              "48x48"?: ...;
              [key: ...]: ...;
          };
          displayName?: string;
          emailAddress?: string;
          expand?: string;
          groups?: {
              callback?: ...;
              items?: ...;
              "max-results"?: ...;
              pagingCallback?: ...;
              size?: ...;
              [key: ...]: ...;
          };
          guest?: boolean;
          locale?: string;
          self?: string;
          timeZone?: string;
          [key: string]: unknown;
      };
      [key: string]: unknown;
  }[]
  
  The list of items.
- Optionalmax-results?: number
  
  The maximum number of results that could be on the page.
- Optionalsize?: number
  
  The number of items on the page.
- Optionalstart-index?: number
  
  The index of the first item returned on the page.
OptionalviewUrl?: string

A URL to view the filter results in Jira, using the ID of the filter. For example, _https://your-domain.atlassian.net/issues/?filter=10100_.

`Optional`matchedWebhookIds

matchedWebhookIds?: number[]

The registrations this delivery answered. Present only on a webhook registered through the REST API, where one event can match several of them at once.

timestamp

timestamp: number

When Jira raised the event, in milliseconds since the epoch.

webhookEvent

webhookEvent: FilterWebhookEvent

The event, and the field to switch on.

Interface FilterWebhookPayload

Hierarchy (View Summary)

Index

Properties

Properties

Optionalfilter

Type Declaration

[key: string]: unknown

OptionalapproximateLastUsed?: Date

Optionaldescription?: string

Optionalfavourite?: boolean

OptionalfavouritedCount?: number

Optionalid?: string

OptionalisWritable?: boolean

Optionaljql?: string

name: string

OptionalaccountId?: string

OptionalaccountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"

Optionalactive?: boolean

OptionalappType?: string

OptionalavatarUrls?: { "16x16"?: string; "24x24"?: string; "32x32"?: string; "48x48"?: string; [key: string]: unknown;}

Optional16x16?: string

Optional24x24?: string

Optional32x32?: string

Optional48x48?: string

OptionaldisplayName?: string

OptionalemailAddress?: string

Optionalexpand?: string

Optionalgroups?: { callback?: { [key: string]: unknown }; items?: { groupId?: string | null; name?: string; self?: string; [key: string]: unknown; }[]; "max-results"?: number; pagingCallback?: { [key: string]: unknown }; size?: number; [key: string]: unknown;}

Optionalguest?: boolean

Optionallocale?: string

Optionalself?: string

OptionaltimeZone?: string

OptionalsearchUrl?: string

Optionalself?: string

Optionalend-index?: number

Optionalmax-results?: number

Optionalsize?: number

Optionalstart-index?: number

Optionalend-index?: number

Optionalmax-results?: number

Optionalsize?: number

Optionalstart-index?: number

OptionalviewUrl?: string

OptionalmatchedWebhookIds

timestamp

webhookEvent

Settings

On This Page

`Optional`filter

`Optional`approximateLastUsed?: Date

`Optional`description?: string

`Optional`favourite?: boolean

`Optional`favouritedCount?: number

`Optional`id?: string

`Optional`isWritable?: boolean

`Optional`jql?: string

`Optional`accountId?: string

`Optional`accountType?: "unknown" | string & {} | "atlassian" | "app" | "customer"

`Optional`active?: boolean

`Optional`appType?: string

`Optional`avatarUrls?: {
"16x16"?: string;
"24x24"?: string;
"32x32"?: string;
"48x48"?: string;
[key: string]: unknown;
}

`Optional`16x16?: string

`Optional`24x24?: string

`Optional`32x32?: string

`Optional`48x48?: string

`Optional`displayName?: string

`Optional`emailAddress?: string

`Optional`expand?: string

`Optional`groups?: {
callback?: { [key: string]: unknown };
items?: {
groupId?: string | null;
name?: string;
self?: string;
[key: string]: unknown;
}[];
"max-results"?: number;
pagingCallback?: { [key: string]: unknown };
size?: number;
[key: string]: unknown;
}

`Optional`guest?: boolean

`Optional`locale?: string

`Optional`self?: string

`Optional`timeZone?: string

`Optional`searchUrl?: string

`Optional`self?: string

`Optional`end-index?: number

`Optional`max-results?: number

`Optional`size?: number

`Optional`start-index?: number

`Optional`end-index?: number

`Optional`max-results?: number

`Optional`size?: number

`Optional`start-index?: number

`Optional`viewUrl?: string

`Optional`matchedWebhookIds