Function: getFiltersPaginated()

function getFiltersPaginated(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  nextPage?: string;
  self?: string;
  startAt: number;
  total: number;
  values: object[];
}>;

Defined in: src/cloud/api/filters.ts:158

Returns a paginated list of filters. Use this operation to get:

• Specific filters, by defining id only.
• Filters that match all of the specified attributes. For example, all filters for a user with a particular word in their name. When multiple attributes are specified only filters matching all attributes are returned.

This operation can be accessed anonymously.

Permissions required: None, however, only the following filters that match the query parameters are returned:

• Filters owned by the user.
• Filters shared with a group that the user is a member of.
• Filters shared with a private project that the user has Browse projects project permission for.
• Filters shared with a public project.
• Filters shared with the public.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ accountId?: string; expand?: | "description" | string & object | "jql" | "viewUrl" | "owner" | "searchUrl" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "approximateLastUsed" | "favouritedCount" | "subscriptions" | ( | "description" | string & object | "jql" | "viewUrl" | "owner" | "searchUrl" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "approximateLastUsed" | "favouritedCount" | "subscriptions")[]; filterName?: string; groupId?: string; groupname?: string; id?: number[]; isSubstringMatch?: boolean; maxResults?: number; orderBy?: | "name" | "id" | "description" | string & object | "owner" | "-description" | "+description" | "-name" | "+name" | "-id" | "+id" | "-owner" | "+owner" | "favourite_count" | "-favourite_count" | "+favourite_count" | "is_favourite" | "-is_favourite" | "+is_favourite" | "is_shared" | "-is_shared" | "+is_shared"; overrideSharePermissions?: boolean; projectId?: number; startAt?: number; }	-
parameters.accountId?	string	User account ID used to return filters with the matching owner.accountId. This parameter cannot be used with owner.
parameters.expand?	| "description" | string & object | "jql" | "viewUrl" | "owner" | "searchUrl" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "approximateLastUsed" | "favouritedCount" | "subscriptions" | ( | "description" | string & object | "jql" | "viewUrl" | "owner" | "searchUrl" | "favourite" | "editPermissions" | "sharePermissions" | "isWritable" | "approximateLastUsed" | "favouritedCount" | "subscriptions")[]	Use expand to include additional information about filter in the response. This parameter accepts a comma-separated list. Expand options include: - description Returns the description of the filter. - favourite Returns an indicator of whether the user has set the filter as a favorite. - favouritedCount Returns a count of how many users have set this filter as a favorite. - jql Returns the JQL query that the filter uses. - owner Returns the owner of the filter. - searchUrl Returns a URL to perform the filter's JQL query. - sharePermissions Returns the share permissions defined for the filter. - editPermissions Returns the edit permissions defined for the filter. - isWritable Returns whether the current user has permission to edit the filter. - approximateLastUsed [Experimental] Returns the approximate date and time when the filter was last evaluated. - subscriptions Returns the users that are subscribed to the filter. - viewUrl Returns a URL to view the filter.
parameters.filterName?	string	String used to perform a case-insensitive partial match with name.
parameters.groupId?	string	Group ID used to returns filters that are shared with a group that matches sharePermissions.group.groupId. This parameter cannot be used with the groupname parameter.
parameters.groupname?	string	As a group's name can change, use of groupId is recommended to identify a group. Group name used to returns filters that are shared with a group that matches sharePermissions.group.groupname. This parameter cannot be used with the groupId parameter.
parameters.id?	number[]	The list of filter IDs. To include multiple IDs, provide an ampersand-separated list. For example, id=10000&id=10001. Do not exceed 200 filter IDs.
parameters.isSubstringMatch?	boolean	When true this will perform a case-insensitive substring match for the provided filterName. When false the filter name will be searched using full text search syntax.
parameters.maxResults?	number	The maximum number of items to return per page.
parameters.orderBy?	| "name" | "id" | "description" | string & object | "owner" | "-description" | "+description" | "-name" | "+name" | "-id" | "+id" | "-owner" | "+owner" | "favourite_count" | "-favourite_count" | "+favourite_count" | "is_favourite" | "-is_favourite" | "+is_favourite" | "is_shared" | "-is_shared" | "+is_shared"	Order the results by a field: - description Sorts by filter description. Note that this sorting works independently of whether the expand to display the description field is in use. - favourite_count Sorts by the count of how many users have this filter as a favorite. - is_favourite Sorts by whether the filter is marked as a favorite. - id Sorts by filter ID. - name Sorts by filter name. - owner Sorts by the ID of the filter owner. - is_shared Sorts by whether the filter is shared.
parameters.overrideSharePermissions?	boolean	EXPERIMENTAL: Whether share permissions are overridden to enable filters with any share permissions to be returned. Available to users with Administer Jira global permission.
parameters.projectId?	number	Project ID used to returns filters that are shared with a project that matches sharePermissions.project.id.
parameters.startAt?	number	The index of the first item to return in a page of results (page offset).
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; nextPage?: string; self?: string; startAt: number; total: number; values: object[]; }>