OptionalapproximateLastUsed?: unknown[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?: stringA description of the filter.
OptionaleditPermissions?: {The groups and projects that can edit the filter.
Optionalexpand?: Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include:
sharedUsers Returns the users that the filter is shared with. This includes users that can browse projects that
the filter is shared with. If you don't specify sharedUsers, then the sharedUsers object is returned but it
doesn't list any users. The list of users returned is limited to 1000, to access additional users append
[start-index:end-index] to the expand request. For example, to access the next 1000 users, use
?expand=sharedUsers[1001:2000].subscriptions Returns the users that are subscribed to the filter. If you don't specify subscriptions, the
subscriptions object is returned but it doesn't list any subscriptions. The list of subscriptions returned is
limited to 1000, to access additional subscriptions append [start-index:end-index] to the expand request. For
example, to access the next 1000 subscriptions, use ?expand=subscriptions[1001:2000].Optionalfavourite?: booleanWhether the filter is selected as a favorite.
OptionalfavouritedCount?: numberThe count of how many users have selected this filter as a favorite, including the filter owner.
Optionalid?: stringThe unique identifier for the filter.
OptionalisWritable?: booleanOptionaljql?: stringThe JQL query for the filter. For example, project = SSP AND issuetype = Bug.
The name of the filter. Must be unique.
OptionaloverrideSharePermissions?: booleanEXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be created. Available to users with Administer Jira global permission.
Optionalowner?: {OptionalaccountId?: stringThe 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 accountapp system account used for Connect applications and OAuth to represent external systemscustomer Jira Service Desk account representing an external service deskOptionalactive?: booleanWhether the user is active.
OptionalapplicationRoles?: {OptionalappType?: stringThe app type of the user account when accountType is 'app'. Can take the following values:
service Service Accountagent Rovo Agent Accountunknown Unknown app typeOptionalavatarUrls?: {Optional16x16?: stringThe URL of the item's 16x16 pixel avatar.
Optional24x24?: stringThe URL of the item's 24x24 pixel avatar.
Optional32x32?: stringThe URL of the item's 32x32 pixel avatar.
Optional48x48?: stringThe URL of the item's 48x48 pixel avatar.
OptionaldisplayName?: stringThe display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
OptionalemailAddress?: stringThe email address of the user. Depending on the user’s privacy setting, this may be returned as null.
Optionalexpand?: stringExpand options that include additional user details in the response.
Optionalgroups?: {Optionalguest?: booleanWhether the user is a guest.
Optionallocale?: stringThe locale of the user. Depending on the user’s privacy setting, this may be returned as null.
Optionalself?: stringThe URL of the user.
OptionaltimeZone?: stringThe 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?: stringA 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?: stringThe URL of the filter.
OptionalsharedUsers?: {Optionalend-index?: numberThe index of the last item returned on the page.
Optionalitems?: {The list of items.
Optionalmax-results?: numberThe maximum number of results that could be on the page.
Optionalsize?: numberThe number of items on the page.
Optionalstart-index?: numberThe index of the first item returned on the page.
OptionalsharePermissions?: {The groups and projects that the filter is shared with.
Optionalsubscriptions?: {Optionalend-index?: numberThe index of the last item returned on the page.
Optionalitems?: {The list of items.
Optionalmax-results?: numberThe maximum number of results that could be on the page.
Optionalsize?: numberThe number of items on the page.
Optionalstart-index?: numberThe index of the first item returned on the page.
OptionalviewUrl?: stringA URL to view the filter results in Jira, using the ID of the filter. For example, _https://your-domain.atlassian.net/issues/?filter=10100_.
Optionaloptions: RequestOptions
Creates a filter. The filter is shared according to the default share scope. The filter is not selected as a favorite.
Permissions required: Permission to access Jira.