Atlassian: Filters schemas

← Filters operations · All schemas

Change filter owner — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	The account ID of the new owner. write Only: true Additional keys: not allowed
accountId	string	Required within parent	The account ID of the new owner.

Create filter — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Details about a filter. Additional keys: not allowed
approximateLastUsed	string	Optional	\[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. Format: date-time Read only: true
description	string	Optional	A description of the filter.
editPermissions	array	Optional	The groups and projects that can edit the filter.
editPermissions[]	Model	Each item	Expand Create filter — request body — body edit Permissions item
favourite	boolean	Optional	Whether the filter is selected as a favorite.
favouritedCount	integer	Optional	The count of how many users have selected this filter as a favorite, including the filter owner. Format: int64 Read only: true
id	string	Optional	The unique identifier for the filter. Read only: true
jql	string	Optional	The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*.
name	string	Required within parent	The name of the filter. Must be unique.
owner	Model	Optional	Expand Assign issue — request body — body The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings. Read only: true
searchUrl	string	Optional	A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) 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*. Format: uri Read only: true
self	string	Optional	The URL of the filter. Format: uri Read only: true
sharePermissions	array	Optional	The groups and projects that the filter is shared with.
sharePermissions[]	Model	Each item	Expand Create filter — request body — body edit Permissions item
sharedUsers	Model	Optional	Expand Create filter — request body — body shared Users A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with. Read only: true
subscriptions	Model	Optional	Expand Create filter — request body — body subscriptions A paginated list of the users that are subscribed to the filter. Read only: true
viewUrl	string	Optional	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*. Format: uri Read only: true

Referenced models: Create filter — request body — body subscriptions, Create filter — request body — body edit Permissions item, Assign issue — request body — body, Create filter — request body — body shared Users

Create filter — request body — body edit Permissions item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a share permission for the filter. Additional keys: not allowed
group	Model	Optional	Expand Send notification for issue — request body — body to groups item The group that the filter is shared with. For a request, specify the `groupId` or `name` property for the group. As a group's name can change, use of `groupId` is recommended.
id	integer	Optional	The unique identifier of the share permission. Format: int64 Read only: true
project	Model	Optional	Expand Create filter — request body — body edit Permissions item project The project that the filter is shared with. This is similar to the project object returned by [Get project](#api-rest-api-3-project-projectIdOrKey-get) but it contains a subset of the properties, which are: `self`, `id`, `key`, `assigneeType`, `name`, `roles`, `avatarUrls`, `projectType`, `simplified`. For a request, specify the `id` for the project.
role	Model	Optional	Expand Create filter — request body — body edit Permissions item role The project role that the filter is shared with. For a request, specify the `id` for the role. You must also specify the `project` object and `id` for the project that the role is in.
type	string	Required within parent	The type of share permission: * `user` Shared with a user. * `group` Shared with a group. If set in a request, then specify `sharePermission.group` as well. * `project` Shared with a project. If set in a request, then specify `sharePermission.project` as well. * `projectRole` Share with a project role in a project. This value is not returned in responses. It is used in requests, where it needs to be specify with `projectId` and `projectRoleId`. * `global` Shared globally. If set in a request, no other `sharePermission` properties need to be specified. * `loggedin` Shared with all logged-in users. Note: This value is set in a request by specifying `authenticated` as the `type`. * `project-unknown` Shared with a project that the user does not have access to. Cannot be set in a request. One of: user, group, project, projectRole, global, loggedin, authenticated, project-unknown
user	Model	Optional	Expand Create filter — request body — body edit Permissions item user The user account ID that the filter is shared with. For a request, specify the `accountId` property for the user.

Referenced models: Send notification for issue — request body — body to groups item, Create filter — request body — body edit Permissions item project, Create filter — request body — body edit Permissions item role, Create filter — request body — body edit Permissions item user

Create filter — request body — body edit Permissions item project

Field	Type	Presence	Description and constraints
$	object	Root	Details about a project. Additional keys: not allowed
archived	boolean	Optional	Whether the project is archived. Read only: true
archivedBy	Model	Optional	Expand Assign issue — request body — body The user who archived the project. Read only: true
archivedDate	string	Optional	The date when the project was archived. Format: date-time Read only: true
assigneeType	string	Optional	The default assignee when creating issues for this project. One of: PROJECT_LEAD, UNASSIGNED Read only: true
avatarUrls	Model	Optional	Expand Assign issue — request body — body avatar Urls The URLs of the project's avatars. Read only: true
components	array	Optional	List of the components contained in the project. Read only: true
components[]	Model	Each item	Expand Create component — request body — body
deleted	boolean	Optional	Whether the project is marked as deleted. Read only: true
deletedBy	Model	Optional	Expand Assign issue — request body — body The user who marked the project as deleted. Read only: true
deletedDate	string	Optional	The date when the project was marked as deleted. Format: date-time Read only: true
description	string	Optional	A brief description of the project. Read only: true
email	string	Optional	An email address associated with the project.
expand	string	Optional	Expand options that include additional project details in the response. Read only: true
favourite	boolean	Optional	Whether the project is selected as a favorite.
id	string	Optional	The ID of the project.
insight	Model	Optional	Expand Create filter — request body — body edit Permissions item project insight Insights about the project. Read only: true
isPrivate	boolean	Optional	Whether the project is private from the user's perspective. This means the user can't see the project or any associated issues. Read only: true
issueTypeHierarchy	Model	Optional	Expand Create filter — request body — body edit Permissions item project issue Type Hierarchy The issue type hierarchy for the project. Read only: true
issueTypes	array	Optional	List of the issue types available in the project. Read only: true
issueTypes[]	Model	Each item	Expand Create workflow scheme — request body — body issue Types value
key	string	Optional	The key of the project. Read only: true
landingPageInfo	Model	Optional	Expand Create filter — request body — body edit Permissions item project landing Page Info The project landing page info. Read only: true
lead	Model	Optional	Expand Assign issue — request body — body The username of the project lead. Read only: true
name	string	Optional	The name of the project. Read only: true
permissions	Model	Optional	Expand Create filter — request body — body edit Permissions item project permissions User permissions on the project Read only: true
projectCategory	Model	Optional	Expand Create project category — request body — body The category the project belongs to. Read only: true
projectTypeKey	string	Optional	The [project type](https://confluence.atlassian.com/x/GwiiLQ#Jiraapplicationsoverview-Productfeaturesandprojecttypes) of the project. One of: software, service_desk, business, product_discovery Read only: true
properties	object	Optional	Map of project properties. Only the properties named in the request's properties query parameter are returned, so this is an empty object when that parameter is omitted. Read only: true Additional keys: see wildcard field
properties.*	JSON	Additional keys	Read only: true
retentionTillDate	string	Optional	The date when the project is deleted permanently. Format: date-time Read only: true
roles	object	Optional	The name and self URL for each role defined in the project. For more information, see [Create project role](#api-rest-api-3-role-post). Read only: true Additional keys: see wildcard field
roles.*	string	Additional keys	Format: uri Read only: true
self	string	Optional	The URL of the project details. Format: uri Read only: true
simplified	boolean	Optional	Whether the project is simplified. Read only: true
style	string	Optional	The type of the project. One of: classic, next-gen Read only: true
url	string	Optional	A link to information about this project, such as project documentation. Read only: true
uuid	string	Optional	Unique ID for next-gen projects. Format: uuid Read only: true
versions	array	Optional	The versions defined in the project. For more information, see [Create version](#api-rest-api-3-version-post). Read only: true
versions[]	Model	Each item	Expand Create version — request body — body

Referenced models: Assign issue — request body — body avatar Urls, Create filter — request body — body edit Permissions item project issue Type Hierarchy, Create workflow scheme — request body — body issue Types value, Create project category — request body — body, Create component — request body — body, Create filter — request body — body edit Permissions item project insight, Create filter — request body — body edit Permissions item project landing Page Info, Create filter — request body — body edit Permissions item project permissions, Assign issue — request body — body, Create version — request body — body

Create filter — request body — body edit Permissions item project insight

Field	Type	Presence	Description and constraints
$	object	Root	Additional details about a project. Additional keys: not allowed
lastIssueUpdateTime	string	Optional	The last issue update time. Format: date-time Read only: true
totalIssueCount	integer	Optional	Total issue count. Format: int64 Read only: true

Create filter — request body — body edit Permissions item project issue Type Hierarchy

Field	Type	Presence	Description and constraints
$	object	Root	The project issue type hierarchy. Additional keys: not allowed
baseLevelId	integer	Optional	The ID of the base level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: int64
levels	array	Optional	Details about the hierarchy level. Read only: true
levels[]	Model	Each item	Expand Create filter — request body — body edit Permissions item project issue Type Hierarchy levels item

Referenced models: Create filter — request body — body edit Permissions item project issue Type Hierarchy levels item

Create filter — request body — body edit Permissions item project issue Type Hierarchy levels item

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
aboveLevelId	integer	Optional	The ID of the level above this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: int64
belowLevelId	integer	Optional	The ID of the level below this one in the hierarchy. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: int64
externalUuid	string	Optional	The external UUID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: uuid
hierarchyLevelNumber	integer	Optional	Format: int32
id	integer	Optional	The ID of the hierarchy level. This property is deprecated, see [Change notice: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: int64
issueTypeIds	array	Optional	The issue types available in this hierarchy level.
issueTypeIds[]	integer	Each item	Format: int64
level	integer	Optional	The level of this item in the hierarchy. Format: int32
name	string	Optional	The name of this hierarchy level.
projectConfigurationId	integer	Optional	The ID of the project configuration. This property is deprecated, see [Change oticen: Removing hierarchy level IDs from next-gen APIs](https://developer.atlassian.com/cloud/jira/platform/change-notice-removing-hierarchy-level-ids-from-next-gen-apis/). Format: int64

Create filter — request body — body edit Permissions item project landing Page Info

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
attributes	object	Optional	Additional keys: see wildcard field
attributes.*	string	Additional keys
boardId	integer	Optional	Format: int64
boardName	string	Optional
projectKey	string	Optional
projectType	string	Optional
queueCategory	string	Optional
queueId	integer	Optional	Format: int64
queueName	string	Optional
simpleBoard	boolean	Optional
simplified	boolean	Optional
url	string	Optional

Create filter — request body — body edit Permissions item project permissions

Field	Type	Presence	Description and constraints
$	object	Root	Permissions which a user has on a project. Additional keys: not allowed
canEdit	boolean	Optional	Whether the logged user can edit the project. Read only: true

Create filter — request body — body edit Permissions item role

Field	Type	Presence	Description and constraints
$	object	Root	Details about the roles in a project. Additional keys: not allowed
actors	array	Optional	The list of users who act in this role. Read only: true
actors[]	Model	Each item	Expand Create filter — request body — body edit Permissions item role actors item
admin	boolean	Optional	Whether this role is the admin role for the project. Read only: true
currentUserRole	boolean	Optional	Whether the calling user is part of this role.
default	boolean	Optional	Whether this role is the default role for the project Read only: true
description	string	Optional	The description of the project role. Read only: true
id	integer	Optional	The ID of the project role. Format: int64 Read only: true
name	string	Optional	The name of the project role.
roleConfigurable	boolean	Optional	Whether the roles are configurable for this project. Read only: true
scope	Model	Optional	Expand Create permission scheme — request body — body scope The scope of the role. Indicated for roles associated with [next-gen projects](https://confluence.atlassian.com/x/loMyO). Read only: true
self	string	Optional	The URL the project role details. Format: uri Read only: true
translatedName	string	Optional	The translated name of the project role.

Referenced models: Create filter — request body — body edit Permissions item role actors item, Create permission scheme — request body — body scope

Create filter — request body — body edit Permissions item role actors item

Field	Type	Presence	Description and constraints
$	object	Root	Details about a user assigned to a project role. Additional keys: not allowed
actorGroup	Model	Optional	Expand Create filter — request body — body edit Permissions item role actors item actor Group Read only: true
actorUser	Model	Optional	Expand Create filter — request body — body edit Permissions item role actors item actor User Read only: true
avatarUrl	string	Optional	The avatar of the role actor. Format: uri Read only: true
displayName	string	Optional	The display name of the role actor. For users, depending on the user’s privacy setting, this may return an alternative value for the user's name. Read only: true
id	integer	Optional	The ID of the role actor. Format: int64 Read only: true
name	string	Optional	This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Read only: true
type	string	Optional	The type of role actor. One of: atlassian-group-role-actor, atlassian-user-role-actor Read only: true

Referenced models: Create filter — request body — body edit Permissions item role actors item actor Group, Create filter — request body — body edit Permissions item role actors item actor User

Create filter — request body — body edit Permissions item role actors item actor Group

Field	Type	Presence	Description and constraints
$	object	Root	Details of the group associated with the role. Additional keys: not allowed
displayName	string	Optional	The display name of the group.
groupId	string	Optional	The ID of the group.
name	string	Optional	The name of the group. As a group's name can change, use of `groupId` is recommended to identify the group.

Create filter — request body — body edit Permissions item role actors item actor User

Field	Type	Presence	Description and constraints
$	object	Root	Details of the user associated with the role. Additional keys: not allowed
accountId	string	Optional	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Returns *unknown* if the record is deleted and corrupted, for example, as the result of a server import. Maximum length: 128 Read only: true

Create filter — request body — body edit Permissions item user

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
accountId	string	Optional	The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*. Maximum length: 128
active	boolean	Optional	Whether the user is active.
avatarUrls	Model	Optional	Expand Create filter — request body — body edit Permissions item user avatar Urls The avatars of the user.
displayName	string	Optional	The display name of the user. Depending on the user’s privacy setting, this may return an alternative value.
key	string	Optional	This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The key of the user.
name	string	Optional	This property is deprecated in favor of `accountId` because of privacy changes. See the [migration guide](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. The username of the user.
self	string	Optional	The URL of the user. Format: uri

Referenced models: Create filter — request body — body edit Permissions item user avatar Urls

Create filter — request body — body edit Permissions item user avatar Urls

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
16x16	string	Optional	The URL of the user's 16x16 pixel avatar. Format: uri
24x24	string	Optional	The URL of the user's 24x24 pixel avatar. Format: uri
32x32	string	Optional	The URL of the user's 32x32 pixel avatar. Format: uri
48x48	string	Optional	The URL of the user's 48x48 pixel avatar. Format: uri

Create filter — request body — body shared Users

Field	Type	Presence	Description and constraints
$	object	Root	A paginated list of users sharing the filter. This includes users that are members of the groups or can browse the projects that the filter is shared with. Additional keys: not allowed
end-index	integer	Optional	The index of the last item returned on the page. Format: int32 Read only: true
items	array	Optional	The list of items. Read only: true
items[]	Model	Each item	Expand Assign issue — request body — body
max-results	integer	Optional	The maximum number of results that could be on the page. Format: int32 Read only: true
size	integer	Optional	The number of items on the page. Format: int32 Read only: true
start-index	integer	Optional	The index of the first item returned on the page. Format: int32 Read only: true

Referenced models: Assign issue — request body — body

Create filter — request body — body subscriptions

Field	Type	Presence	Description and constraints
$	object	Root	A paginated list of subscriptions to a filter. Additional keys: not allowed
end-index	integer	Optional	The index of the last item returned on the page. Format: int32 Read only: true
items	array	Optional	The list of items. Read only: true
items[]	Model	Each item	Expand Create filter — request body — body subscriptions items item
max-results	integer	Optional	The maximum number of results that could be on the page. Format: int32 Read only: true
size	integer	Optional	The number of items on the page. Format: int32 Read only: true
start-index	integer	Optional	The index of the first item returned on the page. Format: int32 Read only: true

Referenced models: Create filter — request body — body subscriptions items item

Create filter — request body — body subscriptions items item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a user or group subscribing to a filter. Additional keys: not allowed
group	Model	Optional	Expand Send notification for issue — request body — body to groups item The group subscribing to filter. Read only: true
id	integer	Optional	The ID of the filter subscription. Format: int64 Read only: true
user	Model	Optional	Expand Assign issue — request body — body The user subscribing to filter. Read only: true

Referenced models: Send notification for issue — request body — body to groups item, Assign issue — request body — body

Get columns — response body — item

Field	Type	Presence	Description and constraints
$	object	Root	Details of an issue navigator column item.
label	JSON	Optional
label (anyOf 1)	string	Alternative	The issue navigator column label.
label (anyOf 2)	null	Alternative
value	JSON	Optional
value (anyOf 1)	string	Alternative	The issue navigator column value.
value (anyOf 2)	null	Alternative

Get filter — response body

Field	Type	Presence	Description and constraints
$	object	Root	Details about a filter.
approximateLastUsed	JSON	Optional
approximateLastUsed (anyOf 1)	JSON	Alternative
approximateLastUsed (anyOf 1) (anyOf 1)	string	Alternative	\[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. Read only: true
approximateLastUsed (anyOf 1) (anyOf 2)	integer	Alternative
approximateLastUsed (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	A description of the filter.
description (anyOf 2)	null	Alternative
editPermissions	JSON	Optional
editPermissions (anyOf 1)	array	Alternative	The groups and projects that can edit the filter.
editPermissions (anyOf 1)[]	Model	Each item	Expand Get share permission — response body
editPermissions (anyOf 2)	null	Alternative
favourite	JSON	Optional
favourite (anyOf 1)	boolean	Alternative	Whether the filter is selected as a favorite.
favourite (anyOf 2)	null	Alternative
favouritedCount	JSON	Optional
favouritedCount (anyOf 1)	JSON	Alternative
favouritedCount (anyOf 1) (anyOf 1)	integer	Alternative	The count of how many users have selected this filter as a favorite, including the filter owner. Format: int64 Read only: true
favouritedCount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
favouritedCount (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The unique identifier for the filter. Read only: true
id (anyOf 2)	null	Alternative
jql	JSON	Optional
jql (anyOf 1)	string	Alternative	The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*.
jql (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the filter. Must be unique.
name (anyOf 2)	null	Alternative
owner	JSON	Optional
owner (anyOf 1)	Model	Alternative	Expand Get user — response body The user who owns the filter. This is defaulted to the creator of the filter, however Jira administrators can change the owner of a shared filter in the admin settings. Read only: true
owner (anyOf 2)	null	Alternative
searchUrl	JSON	Optional
searchUrl (anyOf 1)	string	Alternative	A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) 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*. Format: uri Read only: true
searchUrl (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the filter. Format: uri Read only: true
self (anyOf 2)	null	Alternative
sharePermissions	JSON	Optional
sharePermissions (anyOf 1)	array	Alternative	The groups and projects that the filter is shared with.
sharePermissions (anyOf 1)[]	Model	Each item	Expand Get share permission — response body
sharePermissions (anyOf 2)	null	Alternative
sharedUsers	JSON	Optional
sharedUsers (anyOf 1)	Model	Alternative	Expand Get filter — response body — shared Users end-index, items, max-results, size, start-index A paginated list of the users that the filter is shared with. This includes users that are members of the groups or can browse the projects that the filter is shared with. Read only: true
sharedUsers (anyOf 2)	null	Alternative
subscriptions	JSON	Optional
subscriptions (anyOf 1)	Model	Alternative	Expand Get filter — response body — subscriptions A paginated list of subscriptions to a filter A paginated list of the users that are subscribed to the filter. Read only: true
subscriptions (anyOf 2)	null	Alternative
viewUrl	JSON	Optional
viewUrl (anyOf 1)	string	Alternative	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*. Format: uri Read only: true
viewUrl (anyOf 2)	null	Alternative

Referenced models: Get filter — response body — subscriptions A paginated list of subscriptions to a filter, Get share permission — response body, Get user — response body, Get filter — response body — shared Users end-index, items, max-results, size, start-index

Get filter — response body — shared Users end-index, items, max-results, size, start-index

Field	Type	Presence	Description and constraints
$	object	Root	A paginated list of users sharing the filter. This includes users that are members of the groups or can browse the projects that the filter is shared with.
end-index	JSON	Optional
end-index (anyOf 1)	JSON	Alternative
end-index (anyOf 1) (anyOf 1)	integer	Alternative	The index of the last item returned on the page. Format: int32 Read only: true
end-index (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
end-index (anyOf 2)	null	Alternative
items	JSON	Optional
items (anyOf 1)	array	Alternative	The list of items. Read only: true
items (anyOf 1)[]	Model	Each item	Expand Get user — response body
items (anyOf 2)	null	Alternative
max-results	JSON	Optional
max-results (anyOf 1)	JSON	Alternative
max-results (anyOf 1) (anyOf 1)	integer	Alternative	The maximum number of results that could be on the page. Format: int32 Read only: true
max-results (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max-results (anyOf 2)	null	Alternative
size	JSON	Optional
size (anyOf 1)	JSON	Alternative
size (anyOf 1) (anyOf 1)	integer	Alternative	The number of items on the page. Format: int32 Read only: true
size (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
size (anyOf 2)	null	Alternative
start-index	JSON	Optional
start-index (anyOf 1)	JSON	Alternative
start-index (anyOf 1) (anyOf 1)	integer	Alternative	The index of the first item returned on the page. Format: int32 Read only: true
start-index (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start-index (anyOf 2)	null	Alternative

Referenced models: Get user — response body

Get filter — response body — subscriptions A paginated list of subscriptions to a filter

Field	Type	Presence	Description and constraints
$	object	Root	A paginated list of subscriptions to a filter.
end-index	JSON	Optional
end-index (anyOf 1)	JSON	Alternative
end-index (anyOf 1) (anyOf 1)	integer	Alternative	The index of the last item returned on the page. Format: int32 Read only: true
end-index (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
end-index (anyOf 2)	null	Alternative
items	JSON	Optional
items (anyOf 1)	array	Alternative	The list of items. Read only: true
items (anyOf 1)[]	Model	Each item	Expand Get filter — response body — subscriptions A paginated list of subscriptions to a filter items The list of items item
items (anyOf 2)	null	Alternative
max-results	JSON	Optional
max-results (anyOf 1)	JSON	Alternative
max-results (anyOf 1) (anyOf 1)	integer	Alternative	The maximum number of results that could be on the page. Format: int32 Read only: true
max-results (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
max-results (anyOf 2)	null	Alternative
size	JSON	Optional
size (anyOf 1)	JSON	Alternative
size (anyOf 1) (anyOf 1)	integer	Alternative	The number of items on the page. Format: int32 Read only: true
size (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
size (anyOf 2)	null	Alternative
start-index	JSON	Optional
start-index (anyOf 1)	JSON	Alternative
start-index (anyOf 1) (anyOf 1)	integer	Alternative	The index of the first item returned on the page. Format: int32 Read only: true
start-index (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
start-index (anyOf 2)	null	Alternative

Referenced models: Get filter — response body — subscriptions A paginated list of subscriptions to a filter items The list of items item

Get filter — response body — subscriptions A paginated list of subscriptions to a filter items The list of items item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a user or group subscribing to a filter.
group	JSON	Optional
group (anyOf 1)	Model	Alternative	Expand Get user groups — response body — item The group subscribing to filter. Read only: true
group (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	JSON	Alternative
id (anyOf 1) (anyOf 1)	integer	Alternative	The ID of the filter subscription. Format: int64 Read only: true
id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id (anyOf 2)	null	Alternative
user	JSON	Optional
user (anyOf 1)	Model	Alternative	Expand Get user — response body The user subscribing to filter. Read only: true
user (anyOf 2)	null	Alternative

Referenced models: Get user groups — response body — item, Get user — response body

Search for filters — response body

Field	Type	Presence	Description and constraints
$	object	Root	A page of items.
isLast	JSON	Optional
isLast (anyOf 1)	boolean	Alternative	Whether this is the last page. Read only: true
isLast (anyOf 2)	null	Alternative
maxResults	JSON	Optional
maxResults (anyOf 1)	JSON	Alternative
maxResults (anyOf 1) (anyOf 1)	integer	Alternative	The maximum number of items that could be returned. Format: int32 Read only: true
maxResults (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
maxResults (anyOf 2)	null	Alternative
nextPage	JSON	Optional
nextPage (anyOf 1)	string	Alternative	If there is another page of results, the URL of the next page. Format: uri Read only: true
nextPage (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the page. Format: uri Read only: true
self (anyOf 2)	null	Alternative
startAt	JSON	Optional
startAt (anyOf 1)	JSON	Alternative
startAt (anyOf 1) (anyOf 1)	integer	Alternative	The index of the first item returned. Format: int64 Read only: true
startAt (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
startAt (anyOf 2)	null	Alternative
total	JSON	Optional
total (anyOf 1)	JSON	Alternative
total (anyOf 1) (anyOf 1)	integer	Alternative	The number of items returned. Format: int64 Read only: true
total (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total (anyOf 2)	null	Alternative
values	JSON	Optional
values (anyOf 1)	array	Alternative	The list of items. Read only: true
values (anyOf 1)[]	Model	Each item	Expand Search for filters — response body — values The list of items item
values (anyOf 2)	null	Alternative

Referenced models: Search for filters — response body — values The list of items item

Search for filters — response body — values The list of items item

Field	Type	Presence	Description and constraints
$	object	Root	Details of a filter.
approximateLastUsed	JSON	Optional
approximateLastUsed (anyOf 1)	JSON	Alternative
approximateLastUsed (anyOf 1) (anyOf 1)	string	Alternative	\[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. Read only: true
approximateLastUsed (anyOf 1) (anyOf 2)	integer	Alternative
approximateLastUsed (anyOf 2)	null	Alternative
description	JSON	Optional
description (anyOf 1)	string	Alternative	The description of the filter.
description (anyOf 2)	null	Alternative
editPermissions	JSON	Optional
editPermissions (anyOf 1)	array	Alternative	The groups and projects that can edit the filter. This can be specified when updating a filter, but not when creating a filter.
editPermissions (anyOf 1)[]	Model	Each item	Expand Get share permission — response body
editPermissions (anyOf 2)	null	Alternative
expand	JSON	Optional
expand (anyOf 1)	string	Alternative	Expand options that include additional filter details in the response. Read only: true
expand (anyOf 2)	null	Alternative
favourite	JSON	Optional
favourite (anyOf 1)	boolean	Alternative	Whether the filter is selected as a favorite by any users, not including the filter owner. Read only: true
favourite (anyOf 2)	null	Alternative
favouritedCount	JSON	Optional
favouritedCount (anyOf 1)	JSON	Alternative
favouritedCount (anyOf 1) (anyOf 1)	integer	Alternative	The count of how many users have selected this filter as a favorite, including the filter owner. Format: int64 Read only: true
favouritedCount (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
favouritedCount (anyOf 2)	null	Alternative
id	JSON	Optional
id (anyOf 1)	string	Alternative	The unique identifier for the filter. Read only: true
id (anyOf 2)	null	Alternative
jql	JSON	Optional
jql (anyOf 1)	string	Alternative	The JQL query for the filter. For example, *project = SSP AND issuetype = Bug*. Read only: true
jql (anyOf 2)	null	Alternative
name	JSON	Optional
name (anyOf 1)	string	Alternative	The name of the filter.
name (anyOf 2)	null	Alternative
owner	JSON	Optional
owner (anyOf 1)	Model	Alternative	Expand Get user — response body The user who owns the filter. Defaults to the creator of the filter, however, Jira administrators can change the owner of a shared filter in the admin settings. Read only: true
owner (anyOf 2)	null	Alternative
searchUrl	JSON	Optional
searchUrl (anyOf 1)	string	Alternative	A URL to view the filter results in Jira, using the [Search for issues using JQL](#api-rest-api-3-filter-search-get) 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*. Format: uri Read only: true
searchUrl (anyOf 2)	null	Alternative
self	JSON	Optional
self (anyOf 1)	string	Alternative	The URL of the filter. Format: uri Read only: true
self (anyOf 2)	null	Alternative
sharePermissions	JSON	Optional
sharePermissions (anyOf 1)	array	Alternative	The groups and projects that the filter is shared with. This can be specified when updating a filter, but not when creating a filter.
sharePermissions (anyOf 1)[]	Model	Each item	Expand Get share permission — response body
sharePermissions (anyOf 2)	null	Alternative
subscriptions	JSON	Optional
subscriptions (anyOf 1)	array	Alternative	The users that are subscribed to the filter. Read only: true
subscriptions (anyOf 1)[]	Model	Each item	Expand Get filter — response body — subscriptions A paginated list of subscriptions to a filter items The list of items item
subscriptions (anyOf 2)	null	Alternative
viewUrl	JSON	Optional
viewUrl (anyOf 1)	string	Alternative	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*. Format: uri Read only: true
viewUrl (anyOf 2)	null	Alternative

Referenced models: Get filter — response body — subscriptions A paginated list of subscriptions to a filter items The list of items item, Get share permission — response body, Get user — response body

Set columns — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
columns	array	Optional
columns[]	string	Each item